Difference between revisions of "Log in Theme"

From Studentnet Wiki
Jump to navigation Jump to search
 
(33 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
== Log in Theme ==
+
This page is located: In the Cloudwork dashboard, click the menu bar>'''settings'''>'''Login Theme'''
  
−
This page contains customisable settings for the login page, password reset page and welcome page.
+
[[File:Menu.png|300px]]
  
−
=== Display Options ===
+
This page contains customisation settings for the login page, password reset page and welcome page.
  
−
The display options show a variety of settings that can be changed for the login screen. An example of the form can be found below.
+
There are five different groups of customisation options for different parts of the dashboard
  
−
[[File:login1.png|900px]]
+
== General Settings ==
−
[[File:login2.png|900px]]
+
Edit general settings that affect the overall look and feel of your login page and password recovery and username recovery workflows. All the colours should be a valid HTML colour string, eg #5598fe
 +
[[File:generallogin.png|500px]]
  
−
*Organisation Name - The name of the organisation, this is displayed on the login page and most other pages.
+
* '''Organisation Name''' This is the heading on most pages
 +
* '''Text Colour''' Colour for help text and instructions in login pages
 +
* '''Login Background Colour''' This is the background colour of the login box
 +
* '''Forgot Password / Forgot Username Colour''' Colour of the Forgotten Username/Password text
 +
* '''Button Colour''' Customise the colour of the log in button.
 +
* '''Background Colour''' Customise the background colour.
 +
* '''Favicon''' Upload a file to replace the favicon shown in the identity provider
 +
* '''Logo''' Upload a file to replace the logo shown in the identity provider
 +
* ''' Logo Location''' Where will the logo appear on the login page
 +
* '''Background Image''' Upload a file to replace the background shown in the identity provider
 +
* '''Custom Styles''' Enter your own CSS rules here
  
−
*Login Heading - The heading displayed beneath the organisation name on the login page and gives a general description on what to do.
+
== Login Page Settings ==
  
−
*Login Form Help Text - Help text shown beneath the log in form, to aid the user in what to do if they are unable to log in. HTML can be entered here.
+
These are the settings that control the log in page
 +
[[File:Loginpage.png|500px]]
  
−
*Text colour - Colour for the help text and instructions on the login page
+
* '''Login Heading''' The subheading displayed beneath the organisation name on the login page
 +
* '''Login Form Help Text''' Help text shown underneath the log in form. You can enter HTML here.
 +
* '''Forgot Password Link''' The text displayed on the forgot password link
 +
* '''Forgot Username Link''' The text displayed on the forgot username link
  
−
*Login Background Colour - The colour of the background on the login box.
+
== Password Recovery Settings ==
  
−
*Forgot Password Link - The text displayed on the forgot password link.
+
These are the settings for the password recovery screen
  
−
*Forgot Password Colour - The colour of the text above.
+
[[File:Forgotpassword.png|500px]] [[File:Passwordexpire.png|300px]]
  
−
*Button Colour - Customise the color of the log in button. This must be a valid HTML color string, e.g. #5598fe
+
* '''Password Reset Heading''' The subheading displayed beneath the organisation name on password reset
 +
* '''Username Form Help Text''' Help text shown at the start of password reset. You can enter HTML here.
 +
* '''Reset Code Form Help Text''' Help text shown on the second step of password reset. You can enter HTML here.
 +
* '''New Password Form Help Text''' Help text shown on the last step of password reset. You can enter HTML here.
 +
* '''Change Expired Password Heading''' The subheading displayed when a user must change an expired password
 +
* '''Change Expired Password Text''' A help message to be displayed to users when changing an expired password
 +
* '''Reset Finished Text''' Message shown when password reset is complete. You can enter HTML here.
 +
* '''Submit Button''' Text displayed on the button in the first step of Password Reset
 +
* '''Change Password Button''' Text displayed on the last step in Password Reset, and in Change Expired Password
  
−
*Background Colour - Customise the background color. This must be a valid HTML color string, e.g. #5598fe
+
== Username Recovery Settings ==
  
−
*Favicon - Upload a file to replace the favicon shown in the identity provider.
+
These are the theme settings for the username recovery screen
  
−
*Logo - Upload a file to replace the logo shown in the identity provider.
+
[[File:forgotusername.png|500px]]
  
−
*Logo Location - Where will the logo appear on the login page.
+
* '''Forgot Username Heading''' Heading of the page
 +
* '''Forgot Username Help Text''' The text to guide the user through username recovery
 +
* '''Username Sent Text''' Message shown in browser after username has been successfully sent
 +
* '''Submit Button''' Text displayed on the button in Recover My Username
 +
* '''Error Text''' Text displayed when an error occurs when trying to send Username recovery message to user
  
−
*Background Image - Upload a file to replace the background shown in the identity provider.
+
== Other Settings ==
  
−
*Custom Styles - You can enter your own CSS rules here to create a custom style.
+
Other theme settings are found here
  
−
=== Password Reset Options ===
+
[[File:otherthemes.png]]
  
−
These are the settings for password reset or expiry messages that may be presented to the user when they are logging in. An example of the form can be found below.
+
* '''Welcome Page''' Customise the text shown when users go to the root domain for your IDP
 +
* '''Frame Ancestors''' Space-separated list of domains allowed embed your login page in an iFrame
 +
* '''Remember Me Text''' The label shown on the Remember Me checkbox if Remember Me is enabled
  
−
[[File:password1.png|900px]]
+
== Notes ==
−
[[File:password2.png|900px]]
+
You can recreate the ADFS login page following these [https://wiki.studentnet.net/?title=Replicating_ADFS_Login_Page  instructions]
  
−
*Password Reset Heading - The subheading displayed beneath the organisation name on password reset.
+
[[Category:Cloudwork Dashboard]]
−
 
 
−
*Username Form Help Text - Help text shown at the start of password reset where the user enters their username to access a password reset code. You can enter HTML here.
 
−
 
 
−
*Reset Code Form Help Text - Help text shown on the second step of password reset. You can enter HTML here.
 
−
 
 
−
*New Password Form Help Text - Help text shown on the last step of password reset where the user enters their new password. You can enter HTML here.
 
−
 
 
−
*Change Expired Password Heading - The subheading displayed when a user must change an expired password.
 
−
 
 
−
*Change Expired Password Text - A help message to be displayed to users when changing an expired password.
 
−
 
 
−
=== Other Options ===
 
−
 
 
−
These options currently only change the Welcome text and the Frame Ancestors. This form can be seen below.
 
−
 
 
−
[[File:other.png|900px]]
 
−
 
 
−
*Welcome Text - Customise the text shown when users go to the root domain for your IDP.
 
−
 
 
−
*Frame Ancestors - If you wish to embed the login page inside a web page of your own list the URL of the page you want to embed it into here.
 
−
 
 
−
[[Category:Features]]
 

Latest revision as of 05:34, 27 January 2022

This page is located: In the Cloudwork dashboard, click the menu bar>settings>Login Theme

Menu.png

This page contains customisation settings for the login page, password reset page and welcome page.

There are five different groups of customisation options for different parts of the dashboard

General Settings

Edit general settings that affect the overall look and feel of your login page and password recovery and username recovery workflows. All the colours should be a valid HTML colour string, eg #5598fe Generallogin.png

  • Organisation Name This is the heading on most pages
  • Text Colour Colour for help text and instructions in login pages
  • Login Background Colour This is the background colour of the login box
  • Forgot Password / Forgot Username Colour Colour of the Forgotten Username/Password text
  • Button Colour Customise the colour of the log in button.
  • Background Colour Customise the background colour.
  • Favicon Upload a file to replace the favicon shown in the identity provider
  • Logo Upload a file to replace the logo shown in the identity provider
  • Logo Location Where will the logo appear on the login page
  • Background Image Upload a file to replace the background shown in the identity provider
  • Custom Styles Enter your own CSS rules here

Login Page Settings

These are the settings that control the log in page Loginpage.png

  • Login Heading The subheading displayed beneath the organisation name on the login page
  • Login Form Help Text Help text shown underneath the log in form. You can enter HTML here.
  • Forgot Password Link The text displayed on the forgot password link
  • Forgot Username Link The text displayed on the forgot username link

Password Recovery Settings

These are the settings for the password recovery screen

Forgotpassword.png Passwordexpire.png

  • Password Reset Heading The subheading displayed beneath the organisation name on password reset
  • Username Form Help Text Help text shown at the start of password reset. You can enter HTML here.
  • Reset Code Form Help Text Help text shown on the second step of password reset. You can enter HTML here.
  • New Password Form Help Text Help text shown on the last step of password reset. You can enter HTML here.
  • Change Expired Password Heading The subheading displayed when a user must change an expired password
  • Change Expired Password Text A help message to be displayed to users when changing an expired password
  • Reset Finished Text Message shown when password reset is complete. You can enter HTML here.
  • Submit Button Text displayed on the button in the first step of Password Reset
  • Change Password Button Text displayed on the last step in Password Reset, and in Change Expired Password

Username Recovery Settings

These are the theme settings for the username recovery screen

Forgotusername.png

  • Forgot Username Heading Heading of the page
  • Forgot Username Help Text The text to guide the user through username recovery
  • Username Sent Text Message shown in browser after username has been successfully sent
  • Submit Button Text displayed on the button in Recover My Username
  • Error Text Text displayed when an error occurs when trying to send Username recovery message to user

Other Settings

Other theme settings are found here

Otherthemes.png

  • Welcome Page Customise the text shown when users go to the root domain for your IDP
  • Frame Ancestors Space-separated list of domains allowed embed your login page in an iFrame
  • Remember Me Text The label shown on the Remember Me checkbox if Remember Me is enabled

Notes

You can recreate the ADFS login page following these instructions

Retrieved from "https://wiki.studentnet.net/index.php?title=Log_in_Theme&oldid=1813"