Introduction

Administrator Documentation

Welcome to the Xibo set-up documentation which will guide administrators through the Installation and main set-up of the Xibo system.

To get started with Xibo you need a CMS and at least one signage Player.

Take advantage of our free CMS trial hosted on our cloud, without obligation, to see what Xibo has to offer!
Screenshot/Image

If you are ready to install Xibo on your own infrastructure, select from the available Installation Guides appropriate to your environment.

If you already have a CMS installation up and running then take a look at the User Manual to quickly get started using the features and funtionality of the Xibo CMS.

Open source

The heart of the software is open source and has been for many years! We’re committed to keeping it that way and everything you need to run your digital signage network with Xibo is open source and will always be open source.

The open source software is free software and cannot be sold, however you may provide the software to customers free of charge and charge for value added services such as installation, support, design services etc. This is covered under the AGPLv3 licence and you do not need a reseller agreement with Xibo Signage to do this.

Your customer must be informed of the open source nature of the software and must be provided with a copy of the source code on request. Xibo for Android, Xibo for weOS and Xibo for Tizen can be branded and sold as closed source via the Xibo for Android / Xibo for webOS / Xibo for Tizen White Label.

Xibo Licence Information

Xibo has leveraged the power of several open source platforms and libraries.

Xibo - Digital Signage - http://www.xibo.org.uk.

Copyright © 2018 Xibo Signage LTD and the Xibo Developers.

Xibo is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.

Xibo is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with Xibo. If not, see http://www.gnu.org/licenses.

Documentation

This manual is licensed under the Creative Commons Attribution ShareAlike UK v2 License.

Commercial Sponsor

Xibo is supported and maintained by Xibo Signage.

Third Party Licenses

Xibo uses some third-party libraries and tools - these are provided to you along with Xibo under a variety of compatible open source licenses.

A full list of backend software can be found in the vendor folder and a full list of frontend software in the theme/default/libraries folder.

Fonts

Xibo includes fonts licensed under the OFL and CC-0.

Content Licensing

Please be aware that Xibo takes no measures to regulate the content put on your displays beyond what is described in this documentation. Please make sure that any content is used in the manner described in its licence.

Translating Xibo

The Xibo CMS is fully translatable so that all items and error messages can be localised. By default the CMS will auto detect a user’s browser language and use that translation if it is available.

The CMS can also be configured to use a specific language from the Settings page under the Administration section of the main CMS menu and using the Regional tab.
Screenshot/Image

Launchpad is used to manage translations, which can be viewed here: https://translations.launchpad.net/xibo. Any modifications to existing translations or new translations must be done in Launchpad to be included in the project.

Translations must be product agnostic, it is not permissible to change the translations in Launchpad to suite your own usage of Xibo, or your own Theme.

Launchpad has a help guide describing how the system works.

Technical Detail

Xibo uses a system called GNU GetText to manage its translations. This system takes English “keys” from the source code and passes them through a set of predefined translations for each language. These predefined translations are stored in “compiled” format in a MO file, and can be found in the /locale folder of the source code.

The keys are defined in the code using the __() syntax and in Twig views using the trans helper.

The project adds new translatable strings and retires old ones during its normal development cycle. The contents of Launchpad represents the contents of the current development release.

Translation outside of Launchpad

Launchpad is the “source of truth” when it comes to translations, however it is possible to translate outside of Launchpad, using a tool like POEdit, if this is more convenient.

To do this you should click “Download Translation”, select the languages you want and choose PO format. The resulting PO files can be edited with POEdit and then imported back into Launchpad.

POEdit can produce MO files compatible with the CMS /locale folder, however if your translations are not uploaded back to Launchpad the MO file will be overwritten on next release with one that doesn’t contain your translation.

Applying my translation

New translations are included with each new release of the software. If you would like to apply them ahead of a release you can request a download of the MO files from Launchpad and copy them manually into the /locale folder of your CMS installation.

Player Translations

The Windows Player is only available in English.

Xibo for Android is available in Spanish, French, Korean, Dutch, Brazilian Portuguese and Turkish. If you’d like your language included, please contact us.