https://github.com/xibosignage/xibo-linux
Xibo for Linux - Digital Signage Player
https://github.com/xibosignage/xibo-linux
digital-signage ubuntu xibo
Last synced: 9 days ago
JSON representation
Xibo for Linux - Digital Signage Player
- Host: GitHub
- URL: https://github.com/xibosignage/xibo-linux
- Owner: xibosignage
- License: agpl-3.0
- Created: 2017-09-06T09:35:14.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-05-16T07:53:06.000Z (over 1 year ago)
- Last Synced: 2025-12-03T03:40:11.870Z (2 months ago)
- Topics: digital-signage, ubuntu, xibo
- Language: C++
- Homepage: https://xibo.org.uk/xibo-for-linux
- Size: 2.54 MB
- Stars: 91
- Watchers: 22
- Forks: 66
- Open Issues: 42
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Xibo for Linux
[](https://snapcraft.io/xibo-player)
Xibo for Linux is a Digital Signage Player for [Xibo](https://xibo.org.uk).
It is in its early stages of development and supports a subset of Xibo's overall features. It can be used in production, but should be thoroughly tested with the intended content. It is not recommended to assume that any of Xibo's features will function. Please test yourself to confirm.
To discuss this Player with us, please [join our community](https://community.xibo.org.uk/c/support/linux-player).
# Installation
Installation and upgrade instructions can be found [here](https://xibo.org.uk/docs/setup/xibo-for-linux-installation).
# Contributing
We use GitHub Issues to track development and the next milestone is full of issues for which we would happily accept contributions. In addition, if a Xibo feature you want is not mile-stoned, or mile-stoned against a later version, please get in touch if you'd like to work on it. We maintain a [Kanban Board](https://github.com/xibosignage/xibo-linux/projects/1) to ensure we're not doing overlapping work.
Please check that you're happy for your work to be available under the project licence - the AGPLv3 or later.
Let us know you'd like to contribute by [joining our community](https://community.xibo.org.uk/c/support/linux-player).
# Build
If you would like to work on the Player you can build it locally using the instructions below.
## Building from sources
We recommend you use snapcraft to build Xibo.
### Building with Snapcraft
- Install snapcraft, making sure you have version 4 or later (`snap install snapcraft --classic`)
- Clone this repository
- Run `snapcraft` in the root of the repository
- A `.snap` file will be created which you can use to install from
# Debugging
We provide a VSCode dev container that has everything needed to build/debug the application using VSCode. This devcontainer uses a base image which is built from the `Dockerfile` in the root folder.
To debug this application using VSCode.
1. Copy the settings folder from a working player install into the `/build/bin` folder, making sure you have `cmsSettings.xml` and `playerSettings.xml`.
2. Open `cmsSettings.xml` and adjust the `localLibrary` setting to be `/workspaces/vscode/build/bin/library`.
3. Open the application directory using the remote containers plugin.
4. Go to the aplication debug extesion at left panel and click on the green play button.
Tutorial video: https://user-images.githubusercontent.com/6628028/162645464-5eadcb2b-a53a-450e-805f-9589fba6f8f0.mp4
[Issue 260](https://github.com/xibosignage/xibo-linux/issues/260) will improve steps 1 and 2 so that the options app can be used.