Documentation for Confluence 5.4.
Documentation for Confluence OnDemand and earlier versions of Confluence is available too.

Skip to end of metadata
Go to start of metadata

This page gets you started on customising the Confluence login page, to add your own logo or custom text. This will not customise the login process, just what users sees when they log in.

Notes:

  • Customisations to the Confluence login page will need to be reapplied when you upgrade Confluence. Consider this before making drastic changes to the layout, and be sure to keep a list of what you have changed for your upgrade process later.
  • Please test your changes on a test Confluence site first.

Only administrators with access to the server where Confluence is running can modify the Confluence login page.


To change the login page:

  1. Shut down your Confluence server.
  2. In the Confluence installation directory, find the file confluence/login.vm.
  3. Make a copy of this file as a backup.
  4. Edit the file with a text editor to make the required changes. The content contains a mixture of HTML and Velocity. See Velocity Template Overview (in our developer documentation).
  5. Start Confluence and test your changes.

The same process can be applied to modify most of the templates in the Confluence web application. Be careful to test your changes before applying them to a live site. The templates contain code that is vital for Confluence to function, and it is easy to accidentally make a change that prevents use of your site.

19 Comments

  1. Anonymous

    My changes to login.vm are not showing... I have no clue why.  I can actually delete login.vm and I still get the login page.  Can anyone tell me why my changes to login.vm aren't working? Thanks!

    Eddie

    1. Hi Eddie,

      The .vm file may have been cached. Have you given a try to restart the instance?

      Cheers,
      Azwandi

      1. Anonymous

        Thanks for the reply, yes I have restarted confluence several times after making changes.  I have edited the "Global Main Layout" to contain an image for navigation (image map) right below the global logo. By adding this picture to the global main layout, it has also been added it to the login and logout pages.  I don't want it to be added to the login or logout pages, so I need to find where the picture is being called in the vm file.  Unfortunately, since I changed the global layout, I doubt I'll be able to find the picture in the login.vm file since the changes I have made are in the global main layout file instead... 

        1. Anonymous

          I have the same problem. Can anyone help?

          1. I too am experiencing this. Symptoms:

            • Changes to login.vm are ignored
            • Even when changes to other velocity files are picked up
            • Even after a tomcat reboot
            • And with the velocity cache turned off

            Possible Relevant Environment Details:

            • Using LDAP
            • Using a seperate Apache tomcat instead of standalone. I don't experience this with my dev standalone.
            • Confluence 2.8.2

            This is somewhat infuriating, but luckily, in the long run moot. (Reason why we want to change the login page is to have a nice big Goto The Upgraded Confluence Instead of Logging In Here link.)

            1. Using Confluence 3.4.x, I found the instructions on this page worked as written. 

              The changes only show after I restart Confluence.

              It is also important to note that you may need to update multiple locations within the login.vm file due to the IF statement which deals with the CAPTCHA option.

  2. So... there's no way to customize the login page using a theme? I'd rather do that to keep my customizations grouped together neatly.

    1. Hi Zack,

      As far as I know the feature requested is not available yet. Feel free to launch a feature request in JIRA:

      Please add your comments to the discussion, vote on it and add yourself as a watcher for future updates. Also, please bear in mind the following document on how we schedule features for inclusion in our products: Implementation of New Features and Improvements.

      Hope that helps.
      Best rgds,
      Zed

  3. I like to change the word Confluence on the login page but in login.vm I can not even find it. Am I missing something?

  4. Anonymous

    This document seems to be outdated.

    1. Hi there,

      Looking into Confluence 3.5.x installation directory, under confluence directory, I am still able to see login.vm file still exists inside there.

      Since you have pointed that this document seems to be outdated, would you mind giving a more specific part?

      Cheers~
      Joa

      1. login.vm exists and it can be updated BUT it is not as simple as it is implied to be.

        1. It says in the document that "The content is mostly HTML, but has some Velocity template variables". This is NOT correct. Login.vm is all Velocity script with very little html.

        2. It is not mentioned that certain things are just not doable. For example I am adding a background image via style tag and login.vm gets its background color and image from the template in Confluence. Several hours of work would not have been wasted if I knew that from start.

        3. I have asked Atlassian support for some examples of customizations but no such luck on a request that simple.

  5. Hi Joachim,

    we really need this information.

    how we can do ?

  6. Anonymous

    Here is my observation:

    We are implementing Shibboleth on 3.5.9 with plans to upgrade to 3.5.13 before moving production from 3.1.2.  I have been successful in getting Shib attributes to create accounts upon successful logins. This was done on 3.5.5.  On that test system, I am able to make changes to login.vm and not have to restart Confluence to see the changes.

    However, on 3.5.9, I cannot do this.  I have even gone so far as to change the name of login.vm to login.vm.bkp and restart Confluence and not have any problems logging in.

    That tells me that the file:login.vm does absolutely nothing and that the login page is built in a binary jar file somewhere.

     

    So, can we find out what jar file it is so we don't have to go through ALL of them just to hope we find the right one?

  7. Hi there, currently we are running Confluence in Version 4.1.4, we have to implement a User Guidline Terms Acceptance upon the Logon Process. We have to ideads in mind, on the one hand we need an additional Check Box on the LogIn Page with a Link to a PDF File , which contains the Guideline Terms, without checking it the user must not be able to log in, and there has to be something like a mark in the user directory set to each user who already accepted the guidlines; furthermore if the designated Administrator would update the PDF File, every user must accept the updated terms before being able to log in.

    The other idea was , having a Wiki Page containing the Guidline to which every User is redirected after Logging in, to accept the Guidline in case of not accepting there must be a fall back to the log in screen.

    Anyway , is it possible to hook up something like this?

     

    1. Anonymous

      Hi where you able to find a solution to this? I am also looking for the same thing.

  8. What happened to the signup.vm file in confluence 4.2.4? It no longer exists under \confluence\signup.vm and I cannot find it in any other directory either.

  9. Hi,

    we now developed a special PlugIn and added a custom authenticator class which is handling the User Acceptance of Terms of Service upon the LogIn Process very well.

    cheers

  10. Confluence 4.2: It seems to me that yes, the Velocity template for the login page is in login.vm, however most of the HTML that draws the page is in the Main Layout global decorator. This decorator is also used for most of the non-space-specific pages such as label list pages and SERPs.