Applying a White label to a CMS in a docker environment

Applying a white label to your Xibo CMS allows for replacing the Xibo branding with your own corporate branding to include logos, splash screens and about text.

A white label for the Xibo CMS does not change the license. You must retain the appropriate copyright notices and satisfy the terms of the AGPLv3 license: GNU Affero General Public License version 3 | Open Source Initiative

Remove Source and About links

A white label can be generated for the CMS which removes the Source and About links from the login page and also alters the text that appears within the About page throughout the CMS.

Removal of these items does not release a customer or end users from the terms of the AGPLv3 license and therefore the license must be satisfied by the customer via alternative means.

Open a Ticket with our helpdesk via My Account to request a document template for the Alternative Provision of License to complete which will explain how the licence terms will be met with the absence of those items.

There are 3 main points to consider, this is not an exhaustive list and the AGPLv3 should be read and understood in full before submitting a request for these items to be removed:

• The source code or offer of source code must be distributed to your users by another means.
• The source code copyright and licence notifications must not be modified from their original appearance in the source code.
• The licence must be distributed to your users by another means.

These options can only be enabled once we agree that the requirements are fully satisfied.

Purchase and Configure

• Once purchased, click the White Label button from My Account
• Click the Configure button to open the forms to provide branding information and upload resources

If you have an accepted Alternative Provision of License, you have an additional License tab to remove the source and about links and provide 'About' text.

• Click the build button to queue

Build and Download

The build process can take up to 10 minutes in some circumstances.

If you see an Error status, check all fields have been completed with no missing information. Ensure that any uploaded images are in the specified formats.

Once the build is complete and ready for download, an email notification will be sent as per the 'Notify when built' field

The Application Name cannot be changed after the first build.

Applying White Label Themes

In a docker environment, the library/brand folder in the archive should be copied to /shared/cms/library/brand/. This folder already exists and must be emptied of all files before copying in the new content from the archive.

The manual folder from the archive, should be copied to shared/cms/web/userscripts/, meaning the full path will be shared/cms/web/userscripts/manual

Once files are in place:

• Log in to the CMS and navigate to the Settings page under the Administration section of the main CMS menu
• Go to the General tab, enter the following as the ‘Location of the Manual’ userscripts/manual/en/

Please ensure you clear your browser cache (shift+F5 ) to see your custom theme applied to your CMS Instance.

Running a CMS prior to 4.5?

On older CMS instances, the theme name folder should be copied to /shared/cms/web/theme/custom/ (custom folder might need to be created manually)

For example, if your theme name is ‘Xibo’, then in the downloaded archive you will find web/theme/custom/Xibo folder, you will want to copy the ‘Xibo’ folder to the path specified above, the end path to your white label theme should be: /shared/cms/web/theme/custom/Xibo

Where ‘Xibo’ is an obvious example, it will be your own theme name in the downloaded archive with White Label CMS theme.