Skip to content

Customizing the Login and About Pages

DavidB edited this page Jul 12, 2021 · 4 revisions

Introduction

You can customize and/or extend the Login and About pages in order to provide the users with information that is specific to your SORMAS instance. Doing so requires write access to the server that SORMAS is running on.

Login Page

The login page of SORMAS is largely customizable. The only element that is required and cannot be directly changed is the login area that asks users to put in their username and password. The custom directory on the server (by default /opt/sormas/custom/) contains the following files:

loginmain.html

This file allows you to freely customize the general layout and elements of the login page. You can add as much HTML here as you want, and you have the whole page at your disposal. The only requirement is that the following code snippet needs to be included because it determines where the login area is located:

<div location="login"></div>

If this code snippet is not part of the file, its contents will be ignored and the default login page will be displayed instead.

logindetails.html

Text or code added here will appear in the login area underneath the "Log in" button. You can e.g. use it to display a small disclaimer or contact details.

loginsidebar.html

This file allows you to add more content to the bottom part of the sidebar. If you have enabled the sidebar in the server properties, some logos are automatically included and cannot be removed. Those are the logos of the original creators and main supporters of the project. You can add more text, HTML, or additional logos here.

loginsidebar-header.html

This file allows you to fully customize the upper part of the sidebar.

About Page

The about page can be largely customized to display additional information relevant to all users.

Custom Documents

The About page can be extended with links to additional documents, e.g. user guides, terms of usage that are specific to your country, etc. If you want to add more documents, you have to create a sub-folder called aboutfiles in the custom directory on the server (by default /opt/sormas/custom/) and upload your documents there.

Custom Copyright Notices (1.62+)

To add custom copyright notices, add a plain HTML file called "copyrightnotices.html" to the custom directory on the server. An example file is already provided in sormas-cargoserver/src/main/resources/layout/sormasfolders/custom

Custom Help and Info Section (1.62+)

To add additional information, add a plain HTML file called "additionalinfo.html" to the custom directory on the server. An example file is already provided in sormas-cargoserver/src/main/resources/layout/sormasfolders/custom