Xibo CMS White Label Theme Administration


#1

Xibo CMS White Label Theme Administration

You can see an example of a white label theme here:

Purchased CMS white label themes are available for configuration and build in the My Products -> CMS White Label section of our customer portal.

Click on the card to show all white label CMS themes you’ve purchased, which will redirect you to your white label CMS page, where you will see cards for each white label theme you own.

Click on the card to show action buttons for Configure, Build and Download like shown below:

Configuring

After you click on the Configure button, new form will open and you’ll be ask to fill following information:

General tab:

  • Application Name
  • Theme Title
  • Theme URL
  • Manual URL
  • Email alert email address
  • Notify email address

Resources tab:

  • Logo, PNG
  • Application Icon, ICO
  • Optional exported layouts

License tab:

  • Licence provision(*)
  • About text(*)

(*)To unlock licence provision and about text we need you to sign a special agreement, please refer to this article for more details - Open Source Xibo.

Building

When your theme is configured you want to click on the ‘Build’ Button and wait for you theme to be built.

Downloading

After you receive an email confirmation that your theme is built you can download in by clicking on the ‘Download’ button.

Applying a Theme

To a Cloud CMS Instance
Themes can be automatically applied to new CMS instances during checkout. Once a theme is build a selector for “Theme” will be available when adding a CMS Instance to your basket/cart.

To apply a theme to an existing CMS instance, please open a service ticket.

To an on-premise 1.7 series CMS Instance
Themes can be downloaded and applied to an on-premise CMS instance or a CMS instance hosted with a 3rd party provider. Themes are downloaded from the Resell -> CMS White Label section of the customer portal, by selecting the required theme record and pressing the “download” button.

The downloaded files are in tar.gz format and can contain the following files:

The archive is ready to be extracted over the top of an existing CMS installation.

To an on-premise docker 1.8 series CMS Instance

In docker environment 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 theme/Xibo folder, you will want to copy the ‘Xibo’ folder to the path specified above, in 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.

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, navigate to Settings page.

On Configuration tab, you should be able to select your theme in the CMS Theme dropdown.
On General tab, you should enter the following as the ‘Location of the Manual’
userscripts/manual/en/

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

To an on-premise custom/manual 1.8 series CMS Instance

Theme name sub-folder should be copied to the following path /web/theme/custom/.

For example, if your theme name is ‘Xibo’, then in the downloaded archive you will find theme/Xibo folder, you will want to copy the ‘Xibo’ folder to the path specified above, in the end path to your white label theme should be
/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.

Manual folder can be placed anywhere in the /web folder in the CMS Installation, for the purpose of this guide we will put it in the same place as in the docker installation, in this case in/web/userscripts/manual (userscripts folder will need to be created manually).

Once files are in place, log in to the CMS, navigate to Settings page.

On Configuration tab, you should be able to select your theme in the CMS Theme dropdown.
On General tab, you should enter the following as the ‘Location of the Manual’
userscripts/manual/en/

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

SQL Files
The SQL files in the archive should not be copied - they are provided as examples of the changes we recommend for a 1.6, 1.7 and 1.8 CMS installation. If the CMS is already configured in a suitable manner then do not run these files.

If the files are not run then CMS setting for GLOBAL_THEME_NAME should be updated to suit the new theme - the following SQL can be used:

UPDATE `setting` SET `value` = 'THEME_NAME', userSee = 0 WHERE `setting` = 'GLOBAL_THEME_NAME' ;

If you want to run the above (or other) sql on your docker installation please see the following topic to learn how to do that - How can I run a SQL command when using a Docker Install?

Always take a full database and file backup before making changes to your CMS.


Own manual in CMS
Change logo xibo
White label administration
Introduction / Table of Contents
How to Edit the Manual and Preview