Login
In this article you can learn the various ways of customizing the Umbraco backoffice login screen and form.
Last updated
In this article you can learn the various ways of customizing the Umbraco backoffice login screen and form.
Last updated
To access the backoffice, you will need to login. You can do this by adding /umbraco
at the end of your website URL, for example http://mywebsite.com/umbraco.
You will be presented with a login form similar to this:
The login screen contains a Greeting, Email, Password field and optionally a Forgotten password link
Below, you will find instructions on how to customize the login screen.
The login screen features a greeting which you can personalize by overriding the existing language translation keys. To do this, create a 'user' translation file for the default language of your Umbraco site, (usually en-US) to override the greetings. For en-US, you'd create a file called: en_us.user.xml
in the directory ~/config/lang/
. Then take the relevant keys (listed below) and add them to your ~/config/lang/en_us.user.xml
file, and update the greetings as necessary.
Note: the config
directory needs to be in the root of your project (not the wwwroot
).
Before the changes takes place you will need to restart the site.
You can customize other text on the login screen as well. First, grab the default values and keys from the en_us.xml in the Umbraco CMS GitHub repository. Thereafter copy the ones you want to translate into ~/config/lang/en_us.user.xml
file.
The Forgotten password? link allows your backoffice users to reset their password. To use this feature, you will need to add the following key to the Umbraco.Cms.Security
section in the appsettings.json
file:
Set it to true
to enable the password reset feature, and false
to disable the feature.
You will also need to configure a Simple Mail Transfer Protocol (SMTP) server in your appsettings.json
file. When you get a successful result on the SMTP configuration when running a health check in the backoffice, you are good to go!
An example:
It is possible to customize the background image and the logo for the backoffice login screen by adding the "Content"
section in the appsettings.json
file:
The LoginBackgroundImage
, LoginLogoImage
, and LoginLogoImageAlternative
are referenced from the /wwwroot/umbraco/
folder.
The LoginLogoImage
is displayed on top of the LoginBackgroundImage
and the LoginLogoImageAlternative
is displayed when the LoginLogoImage
is not available, for example on small resolutions.
You can also customize the login screen by adding a custom CSS file. To do this, you will need to add a new file inside the ~/App_Plugins
folder, for example ~/App_Plugins/MyCustomLoginScreen/my-custom-login-screen.css
.
You can then add your custom CSS to the file:
This will change the color of the SVG graphics (curves) shown on the login screen. You can also hide the curves by adding the following CSS:
To tell Umbraco about your custom CSS file, you will need to add a package.manifest
file. The package.manifest
file should look like this:
The following CSS properties are available for customization:
CSS Property | Description | Default Value |
---|---|---|
| The background of the layout |
|
| The color of the headline |
|
| The color of the text |
|
| The font-size of the headline |
|
| The font-size of the headline on large screens |
|
| The font-size of the secondary headline |
|
| The background of the image wrapper | The value of the LoginBackgroundImage setting |
| The display of the image wrapper |
|
| The border-radius of the image wrapper |
|
| The background of the content wrapper |
|
| The display of the content wrapper |
|
| The width of the content wrapper |
|
| The height of the content wrapper |
|
| The border-radius of the content wrapper |
|
| The align-items of the main wrapper |
|
| The border-radius of the buttons |
|
| The color of the curves |
|
| The display of the curves |
|
The CSS custom properties may change in future versions of Umbraco. You can always find the latest values in the login layout element in the Umbraco CMS GitHub repository.