# Xibo Docs ## Setup Docs - [Setup Documentation](https://docs.xibosignage.com/introduction/readme.md): View Xibo CMS recommended setup and configuration for cloud hosted and self hosted digital signage deployments. - [Make the most out of your Xibo Trial!](https://docs.xibosignage.com/introduction/testing-with-xibo.md): Take a free 14 day trial of the CMS and Player App so that features and functionality can be fully tested from uploading media and creating content to scheduling to show content on your test Displays. - [Xibo Cloud Hosted CMS](https://docs.xibosignage.com/cms-installation/cloud-hosted-cms.md): Xibo Cloud Hosting gives you a professionally managed service direct from the Xibo project creators. Simply sign up for a plan and complete the required form fields to create your own private Xibo CMS - [Xibo Cloud CMS Defaults and Restrictions](https://docs.xibosignage.com/cms-installation/cloud-hosted-cms/xibo-cloud-cms-defaults-and-restrictions.md): Certain settings are pre-configured with Xibo Cloud hosting, some can be optionally changed whilst others are locked to prevent editing. - [Self hosted CMS](https://docs.xibosignage.com/cms-installation/self-hosted-cms.md): Docker is an application to package and run any application in a pre-configured container. This makes it much easier to deploy a Xibo CMS following the recommended configuration. - [CMS Post Installation Set up](https://docs.xibosignage.com/cms-installation/cms-post-installation-set-up.md): Additional setup required to enable all functionality and to keep things running smoothly. - [Maintenance for the CMS](https://docs.xibosignage.com/cms-installation/cms-maintenance.md): Maintenance is an important part of any system and should always be configured to keep the database and files in trim condition, give alerts when there are errors and run in the background. - [Player App Installation and Version Upgrades](https://docs.xibosignage.com/player-app-installation-and-upgrades/player-app-installation-and-version-upgrades.md): Once you have chosen your Media Player hardware, install the Xibo Player app in just a few steps. - [Amazon Signage Stick Install Guide](https://docs.xibosignage.com/player-app-installation-and-upgrades/player-app-installation-and-version-upgrades/amazon-signage-stick-install-guide.md) - [Amino Install Guide](https://docs.xibosignage.com/player-app-installation-and-upgrades/player-app-installation-and-version-upgrades/amino-install-guide.md) - [DSDevices 9X/95 Install Guide](https://docs.xibosignage.com/player-app-installation-and-upgrades/player-app-installation-and-version-upgrades/dsdevices-9x-95-install-guide.md) - [GoogleChromeOS Install Guide](https://docs.xibosignage.com/player-app-installation-and-upgrades/player-app-installation-and-version-upgrades/googlechromeos-install-guide.md) - [Hisense Install Guide](https://docs.xibosignage.com/player-app-installation-and-upgrades/player-app-installation-and-version-upgrades/hisense-install-guide.md) - [LG webOS Install Guide](https://docs.xibosignage.com/player-app-installation-and-upgrades/player-app-installation-and-version-upgrades/lg-webos-install-guide.md) - [Philips Install Guide](https://docs.xibosignage.com/player-app-installation-and-upgrades/player-app-installation-and-version-upgrades/philips-install-guide.md) - [Sony Bravia Install Guide](https://docs.xibosignage.com/player-app-installation-and-upgrades/player-app-installation-and-version-upgrades/sony-bravia-install-guide.md) - [Samsung Tizen Install Guide](https://docs.xibosignage.com/player-app-installation-and-upgrades/player-app-installation-and-version-upgrades/samsung-tizen-install-guide.md) - [Upgrading your Xibo Cloud Hosted CMS](https://docs.xibosignage.com/upgrading-the-cms/upgrading-the-cloud-cms.md): The CMS can be upgraded to later versions to take full advantage of all new features and the latest bug fixes. - [Upgrading Docker Self hosted Install](https://docs.xibosignage.com/upgrading-the-cms/upgrade-self-hosted-docker-install.md): Before starting the upgrade, it’s strongly recommended to take a full backup of your Xibo system. - [Upgrade and switch to Docker Install](https://docs.xibosignage.com/upgrading-the-cms/upgrade-and-switch-to-docker-install.md): Installations prior to 1.8 will be “Manual/Custom Installations" and should be migrated to Docker during the upgrade - [CAS as an Authentication Provider](https://docs.xibosignage.com/cms-configuration-and-integration/cas-as-an-authentication-provider.md): The CMS can be configured to use CAS as its authentication provider - [SAML as an Authentication Provider](https://docs.xibosignage.com/cms-configuration-and-integration/saml-as-an-authentication-provider.md): The CMS can be configured to use SAML as its authentication provider - [SAML Single Sign on with Active Directory - ADFS](https://docs.xibosignage.com/cms-configuration-and-integration/saml-as-an-authentication-provider/saml-single-signon-with-active-directory-adfs.md): Xibo can be setup to authenticate against any SAML 2.0 IdP. Microsoft Active Directory Federation Services can be configured to act as such an IdP - [Configure Wake on LAN](https://docs.xibosignage.com/cms-configuration-and-integration/configure-wake-on-lan.md): Wake on LAN is supported if the media player hardware supports it and if the signage Player is addressable by the CMS - [Using MongoDB to store Proof of Play and other time series data.](https://docs.xibosignage.com/cms-configuration-and-integration/using-mongodb-to-store-proof-of-play-and-other-time-series-data.md): From v2.1 the CMS can be configured to use MongoDB to store Proof of Play statistics and other time series data. - [Canva Integration](https://docs.xibosignage.com/cms-configuration-and-integration/canva-integration.md): Designs created in Canva can be published directly into a Xibo Layout without having to leave the Canva dashboard - [Xibo Dashboard Service](https://docs.xibosignage.com/cms-configuration-and-integration/xibo-dashboard-service.md) - [Xibo SSP Connector](https://docs.xibosignage.com/cms-configuration-and-integration/xibo-ssp-connector.md): An add-on service from Xibo Signage which enables integration to a variety of supported DooH (Digital out of Home) Supply Side Platforms (SSP's) to monetise an established Xibo network. - [My Account](https://docs.xibosignage.com/using-my-account/my-account.md) - [Purchasing for your Customers](https://docs.xibosignage.com/using-my-account/my-account/purchasing-for-your-customers.md) - [CMS Error logs](https://docs.xibosignage.com/troubleshooting/cms-error-logs.md): The CMS has a central “error log” which collects messages from all components in the platform which is a valuable resource when investigating issues. - [Display Error/Audit logs](https://docs.xibosignage.com/troubleshooting/display-error-audit-logs.md): Xibo Displays can collect logs during routine operations so Display alerts can be monitored, error conditions can be identified and troubleshooting can occur - [Request Player Status](https://docs.xibosignage.com/troubleshooting/request-player-status.md): Player status information is likely to be requested by our support team when investigating issues. - [Audit Trail](https://docs.xibosignage.com/troubleshooting/audit-trail.md): The CMS provides audit logs which records all User and System Task activity within certain parts of the CMS. - [Log](https://docs.xibosignage.com/troubleshooting/log.md): The CMS has a central repository for all log information, including the Players which send back information with each collection from the CMS. ## Developer - [Introduction](https://docs.xibosignage.com/developer/introduction.md): The Xibo Platform offers various opportunities for a developer or designer to be involved in the Digital Signage creative process, and often adding a technical element to your network really makes it - [Contributing to Xibo](https://docs.xibosignage.com/developer/contributing-to-xibo.md): How can a user of the open source software contribute back to the community? - [Integrating with Xibo](https://docs.xibosignage.com/developer/integrate/integrating-with-xibo.md) - [Authentication](https://docs.xibosignage.com/developer/integrate/authentication.md): The Xibo CMS API is protected by OAuth 2.0. - [OpenAPI](https://docs.xibosignage.com/developer/integrate/openapi.md) - [Misc](https://docs.xibosignage.com/developer/integrate/openapi/misc.md) - [Schedule](https://docs.xibosignage.com/developer/integrate/openapi/schedule.md) - [Notification](https://docs.xibosignage.com/developer/integrate/openapi/notification.md) - [Layout](https://docs.xibosignage.com/developer/integrate/openapi/layout.md) - [Playlist](https://docs.xibosignage.com/developer/integrate/openapi/playlist.md) - [Widget](https://docs.xibosignage.com/developer/integrate/openapi/widget.md) - [Campaign](https://docs.xibosignage.com/developer/integrate/openapi/campaign.md) - [Template](https://docs.xibosignage.com/developer/integrate/openapi/template.md) - [Resolution](https://docs.xibosignage.com/developer/integrate/openapi/resolution.md) - [Library](https://docs.xibosignage.com/developer/integrate/openapi/library.md) - [Display](https://docs.xibosignage.com/developer/integrate/openapi/display.md) - [Display Group](https://docs.xibosignage.com/developer/integrate/openapi/display-group.md) - [Displayprofile](https://docs.xibosignage.com/developer/integrate/openapi/displayprofile.md) - [Dataset](https://docs.xibosignage.com/developer/integrate/openapi/dataset.md) - [Folder](https://docs.xibosignage.com/developer/integrate/openapi/folder.md) - [Statistics](https://docs.xibosignage.com/developer/integrate/openapi/statistics.md) - [User](https://docs.xibosignage.com/developer/integrate/openapi/user.md) - [Usergroup](https://docs.xibosignage.com/developer/integrate/openapi/usergroup.md) - [Module](https://docs.xibosignage.com/developer/integrate/openapi/module.md) - [Command](https://docs.xibosignage.com/developer/integrate/openapi/command.md) - [Day Part](https://docs.xibosignage.com/developer/integrate/openapi/day-part.md) - [Player Software](https://docs.xibosignage.com/developer/integrate/openapi/player-software.md) - [Tags](https://docs.xibosignage.com/developer/integrate/openapi/tags.md) - [Menu Board](https://docs.xibosignage.com/developer/integrate/openapi/menu-board.md) - [Action](https://docs.xibosignage.com/developer/integrate/openapi/action.md) - [Data Set](https://docs.xibosignage.com/developer/integrate/openapi/data-set.md) - [Display Venue](https://docs.xibosignage.com/developer/integrate/openapi/display-venue.md) - [Font](https://docs.xibosignage.com/developer/integrate/openapi/font.md) - [Session](https://docs.xibosignage.com/developer/integrate/openapi/session.md) - [Sync Group](https://docs.xibosignage.com/developer/integrate/openapi/sync-group.md) - [Models](https://docs.xibosignage.com/developer/integrate/openapi/models.md) - [Getting Started with Postman](https://docs.xibosignage.com/developer/integrate/getting-started-with-postman.md) - [Adding Widgets](https://docs.xibosignage.com/developer/integrate/adding-widgets.md) - [Player Control](https://docs.xibosignage.com/developer/player-control/player-control.md) - [Player Info](https://docs.xibosignage.com/developer/player-control/player-info.md) - [Controlling Widget Duration](https://docs.xibosignage.com/developer/player-control/controlling-widget-duration.md) - [Webhooks](https://docs.xibosignage.com/developer/player-control/webhooks.md) - [Schedule Criteria](https://docs.xibosignage.com/developer/player-control/schedule-criteria.md) - [Data Connectors](https://docs.xibosignage.com/developer/player-control/data-connectors.md) - [Hello World](https://docs.xibosignage.com/developer/player-control/data-connectors/hello-world.md) - [Providing Data Connector JS via Connector](https://docs.xibosignage.com/developer/player-control/data-connectors/providing-data-connector-js-via-connector.md) - [Sending Commands via the CMS API](https://docs.xibosignage.com/developer/player-control/sending-commands-via-the-cms-api.md): The CMS API can be used to send commands to displays which are online via push messaging (XMR), so that predefined actions can be taken on the display. - [Widgets](https://docs.xibosignage.com/developer/widgets/widgets.md) - [Embedded](https://docs.xibosignage.com/developer/widgets/embedded.md) - [HTML Package](https://docs.xibosignage.com/developer/widgets/html-package.md) - [Creating a Module](https://docs.xibosignage.com/developer/widgets/creating-a-module.md) - [Data Provider](https://docs.xibosignage.com/developer/widgets/creating-a-module/data-provider.md) - [Hello World](https://docs.xibosignage.com/developer/widgets/creating-a-module/hello-world.md) - [XML definitions](https://docs.xibosignage.com/developer/widgets/creating-a-module/xml-definitions.md) - [Module Templates](https://docs.xibosignage.com/developer/widgets/module-templates.md) - [Connectors](https://docs.xibosignage.com/developer/widgets/connectors.md) - [Upgrading](https://docs.xibosignage.com/developer/widgets/upgrading.md) - [Upgrading to v3](https://docs.xibosignage.com/developer/widgets/upgrading/upgrading-to-v3.md) - [Upgrading to v2](https://docs.xibosignage.com/developer/widgets/upgrading/upgrading-to-v2.md) ## Knowledge Base - [Knowledge Base](https://docs.xibosignage.com/kb/readme.md) - [Xibo Licence Information](https://docs.xibosignage.com/kb/readme/xibo-licence-information.md): Xibo has leveraged the power of several open source platforms and libraries. - [Translating Xibo](https://docs.xibosignage.com/kb/readme/translating-xibo.md): 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. - [Included Fonts](https://docs.xibosignage.com/kb/readme/fonts.md): Xibo comes with a set of standard fonts - [Self hosted CMS Upgrades](https://docs.xibosignage.com/kb/cms-installation-and-upgrades/self-hosted-cms-upgrades.md) - [Using different ports with Docker](https://docs.xibosignage.com/kb/cms-installation-and-upgrades/using-different-ports-with-docker.md): By default, Xibo will start a web server listening on port 80. - [Running a remote MySQL instance database with Docker](https://docs.xibosignage.com/kb/cms-installation-and-upgrades/running-a-remote-mysql-instance-database-with-docker.md): The default docker-compose.yml file includes a container for MySQL, however, it is possible to run with an external/remote MySQL instance as the database for Xibo. - [Managing Player storage](https://docs.xibosignage.com/kb/player-app/managing-player-storage.md): Media files, Layouts and other metadata are downloaded from the CMS onto the Player to allow for local playback in the most efficient way and to allow for offline use. - [Player not updating from the CMS?](https://docs.xibosignage.com/kb/player-app/player-not-updating-from-the-cms.md): When the logged in status in the CMS is showing as a X, there are a number of potential reasons to be considered. - [Error shown when I try to licence my Player?](https://docs.xibosignage.com/kb/player-app/error-shown-when-i-try-to-licence-my-player.md): There are a couple of reasons to explore as to why you are seeing this type of error message. - [Xibo Player Version Override](https://docs.xibosignage.com/kb/player-app/xibo-player-version-override.md): It may be necessary to run a different Player Version on selected Displays, this can be achieved by using the Player Version Override from the CMS - [How do I connect my Android Player App to the CMS manually?](https://docs.xibosignage.com/kb/player-app/how-do-i-connect-my-android-player-app-to-the-cms-manually.md): Follow the steps below if you cannot connect your device to the CMS with the recommended 'Use Code' option. - [How can I install the Xibo Player App on unsupported Android Media Players?](https://docs.xibosignage.com/kb/player-app/how-can-i-install-the-xibo-player-app-on-unsupported-android-media-players.md): In order to install the Xibo Player App on unsupported Android Media Players, you first need to configure some settings on the Android device. - [4k Panel Resolution with Android](https://docs.xibosignage.com/kb/player-app/4k-panel-resolution-with-android.md) - [How do I get access to troubleshoot the Player App for Android?](https://docs.xibosignage.com/kb/player-app/how-do-i-get-access-to-troubleshoot-the-player-app-for-android.md) - [Gapless Playback Support webOS](https://docs.xibosignage.com/kb/player-app/webos-gapless-playback.md): Gapless Playback is supported in webOS from v4 R407 - [How do I connect the Player App for LG webOS SoC hardware to the CMS manually?](https://docs.xibosignage.com/kb/player-app/how-do-i-connect-the-player-app-for-lg-webos-soc-hardware-to-the-cms-manually.md): Follow the steps below if you cannot connect your device to the CMS with the recommended 'Use Code' option. - [Automate CMS credentials for LG webOS SoC](https://docs.xibosignage.com/kb/player-app/how-do-i-connect-the-player-app-for-lg-webos-soc-hardware-to-the-cms-manually/automate-cms-credentials-for-lg-webos-soc.md): Once configured, connect a USB to your LG webOS Soc for an easier way to provide CMS credentials. Follow the steps to automate credentials on Player start up. - [Downgrading your LG webOS Player via the CMS](https://docs.xibosignage.com/kb/player-app/downgrading-your-lg-webos-player-via-the-cms.md): Whilst we recommend running the latest version of the webOS Player, you may find yourself in a situation where you need to revert to a previous release. - [How do I connect the Player App for Tizen SoC hardware to the CMS manually?](https://docs.xibosignage.com/kb/player-app/downgrading-your-lg-webos-player-via-the-cms/how-do-i-connect-the-player-app-for-tizen-soc-hardware-to-the-cms-manually.md): Follow the steps below if you cannot connect your device to the CMS with the recommended 'Use Code' option. - [Installing / Upgrading / Downgrading the Xibo Player on a Samsung Tizen SoC via USB](https://docs.xibosignage.com/kb/player-app/installing-upgrading-downgrading-the-xibo-player-on-a-samsung-tizen-soc-via-usb.md): If you cannot install via our recommended method via the CMS, the Xibo Player can be installed and upgraded locally using a USB device. The same process applies for upgrades/downgrades. - [Downgrading your Samsung Tizen Player via the CMS](https://docs.xibosignage.com/kb/player-app/installing-upgrading-downgrading-the-xibo-player-on-a-samsung-tizen-soc-via-usb/downgrading-your-samsung-tizen-player-via-the-cms.md): Whilst we recommend running the latest version of the Tizen Player, you may find yourself in a situation where you need to revert to a previous release. - [Automate CMS credentials for Samsung Tizen SoC](https://docs.xibosignage.com/kb/player-app/automate-cms-credentials-for-samsung-tizen-soc.md): Once configured, connect a USB to your Samsung Soc for an easier way to provide CMS credentials. Follow the steps to automate credentials on Player start up. - [Media Players without an internet connection](https://docs.xibosignage.com/kb/media-players/media-players-without-an-internet-connection.md): Media Players are fully capable of offline playback of content - [Amino Installation via USB](https://docs.xibosignage.com/kb/media-players/amino-installation-via-usb.md): We recommend using a 32GB or smaller USB, formatted to FAT32 - [Removing a pre-installed Player App version from your DSDevice](https://docs.xibosignage.com/kb/media-players/removing-a-pre-installed-player-app-version-from-your-dsdevice.md): In order to apply a white label or install a different version of the Android Player App, you will need to remove the pre-installed version on a DSCS9X, DSCS95 and DSCS9. - [Hisense Commercial Displays SoC Command Support](https://docs.xibosignage.com/kb/media-players/hisense-commercial-displays-soc-command-support.md): The DM series supports several commands from the CMS - [LG webOS Firmware Guide](https://docs.xibosignage.com/kb/media-players/lg-webos-firmware-guide.md): It is important to make sure your LG devices are running the latest firmware to ensure that all security and performance improvements are up to date. - [Control LG webOS SoC monitor settings from the CMS](https://docs.xibosignage.com/kb/media-players/control-lg-webos-soc-monitor-settings-from-the-cms.md): Use Display Profile Settings to control a variety of settings for your LG webOS SoC monitor - [Gapless Video Playback Philips SoC running Android 7 or earlier](https://docs.xibosignage.com/kb/media-players/gapless-video-playback-philips-soc-running-android-7-or-earlier.md): In order to play one video after another without a black frame between them it is necessary for the device to be able to decode more than one video at the same time. - [Backlight Support/ LED control and mute Audio Commands for Philips SoC](https://docs.xibosignage.com/kb/media-players/backlight-support-led-control-and-mute-audio-commands-for-philips-soc.md): Remotely switch the Philips SoC display backlights, control LED's and mute Audio using Commands - [How do I set the Xibo Player to show on boot with a Philips SoC display?](https://docs.xibosignage.com/kb/media-players/how-do-i-set-the-xibo-player-to-show-on-boot-with-a-philips-soc-display.md): Philips SoC displays support the ability to set the Xibo Player App on the Custom source channel. This ensures the player automatically boots when the custom source is set for the display. - [Samsung Tizen Firmware Guide](https://docs.xibosignage.com/kb/media-players/samsung-tizen-firmware-guide.md): It is important to make sure your Samsung devices are running the latest firmware to ensure that all security and performance improvements are up to date. - [Control Samsung Tizen SoC monitor settings from the CMS](https://docs.xibosignage.com/kb/media-players/control-samsung-tizen-soc-monitor-settings-from-the-cms.md): Use Display Profile Settings to control a variety of settings for your Samsung Tizen SoC monitor - [What display TV modes should I use with a Sony Bravia display?](https://docs.xibosignage.com/kb/media-players/what-display-tv-modes-should-i-use-with-a-sony-bravia-display.md): Sony Bravia professional displays have 3 TV modes; Normal, Pro and Pro Settings - [Sony Bravia SoC Power On/OFF/Restart options](https://docs.xibosignage.com/kb/media-players/what-display-tv-modes-should-i-use-with-a-sony-bravia-display/sony-bravia-soc-power-on-off-restart-options.md): Xibo supports Power ON/OFF and Restart via a combination of options which can be enabled in Pro Settings. - [RDM for your Sony Bravia device](https://docs.xibosignage.com/kb/media-players/rdm-for-your-sony-bravia-device.md): Once provisioned, manage your Sony Bravia device from your Xibo My Account. Your device status will show as Activated in the Remote Management table. - [Installing Sony Bravia models which are not compatible with RDM](https://docs.xibosignage.com/kb/media-players/rdm-for-your-sony-bravia-device/installing-sony-bravia-models-which-are-not-compatible-with-rdm.md): Sony Bravia professional displays which run Android but are not compatible with RDM, are still capable of running Xibo in a Landscape orientation. - [Portrait Orientation using Sony Bravia SoC displays](https://docs.xibosignage.com/kb/media-players/portrait-orientation-using-sony-bravia-soc-displays.md): Portrait orientation is only available on devices under RDM and must be selected using 'My Account' - [Applying a White label to the CMS](https://docs.xibosignage.com/kb/white-label-application/applying-a-white-label-to-the-cms.md): 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. - [Applying a White label to a CMS in a docker environment](https://docs.xibosignage.com/kb/white-label-application/applying-a-white-label-to-a-cms-in-a-docker-environment.md): 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. - [Applying a White label for Media Players](https://docs.xibosignage.com/kb/white-label-application/applying-a-white-label-for-media-players.md): Applying a white label to your Xibo players allows for replacing the Xibo application logos, names and splash screens with your own branding. - [How do I reset 2FA with SQL?](https://docs.xibosignage.com/kb/features/how-do-i-reset-2fa-with-sql.md): Use this method when you cannot access the CMS to reset Two-Factor-Authentication. - [Can I set an upgrade window for my Displays?](https://docs.xibosignage.com/kb/features/can-i-set-an-upgrade-window-for-my-displays.md): Set a download window for Player events and required files - [My Scheduled Layouts are not working?](https://docs.xibosignage.com/kb/resolving-common-issues/my-scheduled-layouts-are-not-working.md): When Layouts are not being shown as per their schedule ## Changelog - [Changelog](https://docs.xibosignage.com/changelog/readme.md): The latest updates and changes. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on a page URL with the `ask` query parameter: ``` GET https://docs.xibosignage.com/introduction/readme.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.