Whitelabeling

From Roaring Penguin
Jump to: navigation, search

Custom Notifications

The content included in the Pending Message notifications sent to end-users is customizable on a per-realm level using Setup->Templates.

The "Header From" full name and email address, as well as the notification subject can be customized.

The default notification type as defined (per stream) in Preferences->Notification is "HTML with Links". This uses the "Webform-style" content. There are individual boxes to define the header content (primarily CSS), the beginning of the notification, each line of the pending list, and the end of the notification. Similar options exist for other notification types.

Here is an example of a mildly customized notification. It has had the Header From address changed, a logo and additional links added, as well as some CSS changes.

Generic URL

For Hosted CanIT we provide a generic domain:

   emailfilteringservice.net

which can be used for MX records, as described by going to My Domains->My Domains and selecting the "Show Me the Generic MX Records" beneath our default MX records.

You can also use this URL for the BaseURLs in Setup->Templates so that it will be used when creating the links that are added to emails (eg. notifications, training links, etc.). There is further discussion of custom BaseURLs in the Login Page section below.

Customizing the interface

To customize your theme go to Setup->Theme Customization. This has easy click tools for adding a logo and changing the colour scheme. The custom CSS field will also allow you to customize the CSS of any element in the page. This is only recommended for those who are familiar with HTML and CSS but there are a few common tips below. If you wish to dig into this further it is recommended that you use the page inspection tools available from the context menus of browsers such as Firefox and Google Chrome to test your edits before writing them to the Custom CSS box.

Change Product Name (on-site only)

Various persistent changes can be made to CanIt appliances via the /var/www/canit/site/config.php file. Specifically, you can globally change the "Product Name" that appears in various parts of the WebUI. This will replace "CanIt-PRO" or "CanIt-Domain-PRO" with a string of your choice. eg:

   $Config['DisplayProductName'] = "Secure Mail Gateway";

To turn off the footer banner:

All base themes include a reference to Roaring Penguin and CanIt, including the version number and a link to our website. If you would like to remove our labeling completely, you can hide this element with the following CSS:

   #footer_powered { display: none; }

To disable users ability to change themes:

Your theme customization settings only apply to the base theme that you are viewing when the customization is created. You can change between base themes using the drop-down box at the bottom of each page. The default base theme on Hosted is RP-Web. This can be customized for onsite implementations by editing the config.php file.

Having that box visible means that a normal user can easily change to a new base theme which will not have you branding. If you would like to remove their ability to do so, you can hide that box with the following CSS:

   form.theme-selection { display: none; }

If you decide to make your customizations for a base theme that is not the default, you will have to manually make changes to the database so that all users of that realm will use the non-default base theme, otherwise they will never see your customization unless the manually changed to it with the same drop-down box. Also note that if you are going to use a non-default base theme but would like to bring your theme to the login page (as below), you will have to write a second customization using the default base theme because the login page will only ever use that theme.

After having added the above CSS even administrators will lose access to the theme changer. You can ignore all of your theme customization by appending 'disable_theme_customization=1' to any URL. The page inspection tools in Firefox and Chrome will also let you override CSS, so you could also disable hiding of the element that way.

To display your logo on login page:

When CanIt adds links to messages, be it for notifications, training links, URL proxy or Secure Messaging, it will include '?rlm=yourrealm-com' in the URL. This will cause it to automatically pull in any customizations that you have set for that realm. If nothing is set for that realm, it will inherit the branding or it's parent realm. This means that it should already have the appropriate branding at login right out of the box. However, this can cause problems if the customization that you have written was not written for the default base theme.

For Hosted CanIt the base theme is always RP-Web. For on-site appliances the base theme is set according to the config.php file.

Here is an example of custom branding at the login page (if you are a Hosted CanIt user, you will have to be logged out before clicking the link). It includes a custom logo and other CSS changes.

Per-Realm Customizations

CanIt-PRO installations only have one place to customize themes and will thus have the same theme on the login page for all users.

For users of Hosted CanIt or for an individual realm in CanIt-Domain-PRO, login page branding can be set up for a specific realm as well. This requires that you change to the given stream and set up the customization from there. This will disable any customizations set in the parent realm meaning that you don't need to override any changes made there.

If you have the customizations for a specific realm set for a different base theme, they will be ignored because the base theme that is shown is tied to the user login session which has yet to be established. CanIt-Domain-PRO users, while having the ability to set a different base theme to use globally, still do not have this control the base theme of the login page on a per-realm basis. You can define a second set of customizations for the default base theme to ensure that you have the necessary branding changes at login time.