User interface customization¶

WARNING: When you customize your MailCleaner interfaces or reports, it's your responsibility to maintain your template. When you have differences between our default template (in which we deploy bug fix, new features etc.) and your new one, you have to merge that manually. For that, you can simply use the diff command available on Debian and seeing the differences.

The web user interface is based on template and thus can be fully customizable.
Please make sure that the MailCleaner © Copyrights mention is still visible in order to meet the license requirements.

Templates for the web user interface are located in the folder:

/usr/mailcleaner/www/user/htdocs/templates

Current Enterprise template is located in the mailcleaner.net subfolder.

In order to create your own template, copy the default folder and give it a comprehensive name (such as yourcompanyname, no space and no special characters).

cp -r /usr/mailcleaner/www/user/htdocs/templates/default /usr/mailcleaner/www/user/htdocs/templates/yourcompanyname

Then edit the different files in this directory in order to reflect your customizations.

To activate the change, just modify the "Web user GUI:" field in "Configuration->Domains->(select domain)->Templates" which should now have your new template available. The user login page will use the template of the "Configuration->General settings->Defaults->Default domain".

For the most basic customizations to branding, you will want to replace the files in the 'images' subfolder. Specifically, you will be interested in the following.

Filename            Res       Purpose
login_header.png    530w 75h  Login Prompt image
logo_name.png       75h       Header logo (left)
banner_letters.png  75h       Header image (right)
header_bg.png       75h       Header background, repeated width

Text and element colors are defined in the 'css' subdirectory.