Introduction

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

This documentation is written for a technical audience. If you are looking for a user manual, or documentation for running Xibo, please use the links provided.

These documents are ordered such that more common activities are discussed first, however which parts you need will depend on what you want to achieve; refer to the below overview.

Section	Description	Example
Widgets	Learn how to create Embedded or Package HTML Widgets using the Layout Editor, or dive into creating your own Module.	Creating a new visualisation for use on a Layout. This may involve pulling data from a 3rd party.
Player Control	Discover what can be done player side including what information from the Player is available to a Widget, displaying real time data, how to control duration and how to send/receive webhooks.	Interactivity on a player, for example triggering content via a light sensor.
Integrate	Connect a 3rd party system by calling the Xibo API. Learn how to authenticate via oAuth and what API calls are available.	A 3rd party will push content into Xibo. The Xibo Canva app is a good example of this.

Deprecation notice - Theme and custom code changes in v4.5

4.5 CMS has a new React/Tailwind CSS front end which means we need to retire the old "PHP templating" available from inside the web/theme/ folder. Themes purchased from Xibo will be automatically updated for the new approach and available to download in My Account. Instructions for applying them can be found in our knowledge base: Applying a White label to a CMS in a docker environment.

Future versions of the CMS will include a branding feature from inside the CMS itself, making these changes easier to manage.

Custom code (deployed in the custom/ folder will continue to function, except where it relies on PHP templating (twig). The following things are no longer supported:

• Custom connectors
• Custom reports (pending refactor)
• Custom twig views
• Custom display profiles

Deprecation notice - extending the PHP code will no longer be available after 4.5

Xibo has for a long time let advanced users extend the CMS by dropping custom PHP into the codebase. A stop-gap between running a standard release and maintaining your own fork. We're removing it.

In practice, that mechanism is a fork in disguise. Code dropped into the codebase runs with full application privileges, sits outside the release's review and integrity checks, and gets overwritten on upgrade. It should carry the maintenance burden and security exposure of maintaining your own fork, but oftentimes doesn't, and it comes without an upgrade path.

We don't think this capability belongs in the product, and is one we can't support or diagnose against a standard release.

Everything it was used for now has a first-class, supported home. Xibo ships a fully-covered API, a Widget and Data ingest toolset for custom content and data sources, and comprehensive Display-side tooling. There is enough to build what you need without touching core code, and without inheriting the upgrade and security costs that came with the old approach.

If you need something we don't have, we welcome the feedback (hit the button in the CMS), and of course you are always welcome to fork the code on GitHub.