Difference between revisions of "Whitelabeling"

From Roaring Penguin
Jump to: navigation, search
Line 3: Line 3:
  
 
===To turn off the footer banner:===
 
===To turn off the footer banner:===
     #footer_powered { display: none}
+
 
 +
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:===
 
===To disable users ability to change themes:===
     form.theme-selection { display: none}
+
 
 +
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. Modern versions of both Firefox and Chrome also have an Inspect Element tool from the context menu that will let you override CSS, so you could also disable hiding of the element that way.
 +
 
 
===To display your logo on login page:===
 
===To display your logo on login page:===
     https://emailfilteringservice.net/canit/showtrap.php?&rlm=domain-com
+
 
Where domain-com is your realm name.
+
For Hosted CanIT we provide a generic domain:
 +
 
 +
    https://emailfilteringservice.net
 +
 
 +
You can pull in your branding to the login page using this domain or our regular domain by setting up a special URL. This can be done by going to Setup->Templates and setting the base URL to use '/c_example-org' where 'example-org' is the name of the realm where the customization has been defined. Sub-realms will inherit the settings from parents so you could define a specific URL for each sub-realm, but you can also just set it to use your companies realm and that will automatically propagate the Base URL to all sub-realms as well. The full Base URL should look like:
 +
 
 +
    https://emailfilteringservice.net/c_example-org or
 +
    https://antispam.roaringpenguin.com/c_example-org
 +
 
 +
You can also append 'rlm=domain-com' to the regular URL to force it to your stream even before you are logged in so that you can test what this will look like before applying the change. That would look like:
 +
 
 +
     https://emailfilteringservice.net/canit/index.php?rlm=domain-com
 +
 
 +
Note that the 'c_' prefix and an enabled entry in Setup->Theme Customization in mandatory for this behaviour and that it may take up to an hour for the link to become active.
  
 
<div style="float:right; clear:both; margin-right:0.5em">[[Support Wiki | [Home]]]</div>
 
<div style="float:right; clear:both; margin-right:0.5em">[[Support Wiki | [Home]]]</div>
 
[[category:All]][[category:Configuration]][[category:Theming]]
 
[[category:All]][[category:Configuration]][[category:Theming]]

Revision as of 12:01, 10 November 2016

To customize your theme go to Setup->Theme Customization. In the Custom CSS properties: box at the bottom of the page, place the following text after clearing the box:

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. Modern versions of both Firefox and Chrome also have an Inspect Element tool from the context menu that will let you override CSS, so you could also disable hiding of the element that way.

To display your logo on login page:

For Hosted CanIT we provide a generic domain:

   https://emailfilteringservice.net

You can pull in your branding to the login page using this domain or our regular domain by setting up a special URL. This can be done by going to Setup->Templates and setting the base URL to use '/c_example-org' where 'example-org' is the name of the realm where the customization has been defined. Sub-realms will inherit the settings from parents so you could define a specific URL for each sub-realm, but you can also just set it to use your companies realm and that will automatically propagate the Base URL to all sub-realms as well. The full Base URL should look like:

   https://emailfilteringservice.net/c_example-org or
   https://antispam.roaringpenguin.com/c_example-org

You can also append 'rlm=domain-com' to the regular URL to force it to your stream even before you are logged in so that you can test what this will look like before applying the change. That would look like:

   https://emailfilteringservice.net/canit/index.php?rlm=domain-com

Note that the 'c_' prefix and an enabled entry in Setup->Theme Customization in mandatory for this behaviour and that it may take up to an hour for the link to become active.