> For the complete documentation index, see [llms.txt](https://docs.xibosignage.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.xibosignage.com/open-source-player-apps/xibo-for-linux-installation.md). # Xibo for Linux **NOTE:** The Linux Player is currently under development to bring a new generation Open Source player, free for both personal and commercial use. More info on our website here: [Xibo for Linux](https://xibosignage.com/xibo-for-linux) ## Legacy Community Player Installation The Xibo for Linux Player is released as a snap package, distributed via snapcraft. This offers a clean, dependency free installation, as well as the potential for automatic upgrades in the future. There are 4 steps to follow: 1. Preparation of the CMS 2. Installation of the Player 3. Connection of your Player to the CMS 4. Authorisation of your Display with the CMS ## Prepare your CMS If you have a 1.8.12 or later CMS, you can connect the Player directly. You may need to create a [Display Settings Profile](https://xibo.org.uk/manual/en/displays_settings.html) for the Linux Player ahead of connecting your first Linux Player. Not all of the settings in the Display Settings Profile will work at present, but have been included in readiness for them being fully implemented into the Player. ## Installation To install the Player, simply run: ``` snap install xibo-player --channel=stable ``` The Player will be installed without affecting any other software you might have installed on your machine. You may also visit: or use the button below. [![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-white.svg)](https://snapcraft.io/xibo-player) ### Upgrading from an older release You can check to see what version of the Player you have installed by running: ``` snap list ``` You should see an entry in the output like this: ``` Name Version Rev Tracking Publisher Notes xibo-player 1.8-beta1 16 beta xibosignage - ``` * #### Upgrading from 1.8-alpha6 or later To upgrade from the 1.8-alpha6 or later release, run: ``` snap refresh xibo-player --channel=beta ``` You may find that snapcraft has automatically upgraded your `xibo-player` snap. * #### Upgrading from earlier than 1.8-alpha6 You cannot upgrade to 1.8-alpha6 from older alphas, so if you previously installed 0.3.3a, 0.4a or 0.5a and haven't removed it, then run: ``` snap remove xibo-player-test ``` After removing the older release, continue to install the Xibo Player. ## Connect to the CMS Newly installed Players must be configured and registered with the Xibo CMS before they can be used using the **Player Options**. ### Player Options Most of the Player options are set on the CMS and delivered over the network to the Player. This keeps the Player configuration to a minimum on each new installation. * To run the Player select Xibo Linux Player from the desktop/app drawer or open a terminal and run: xibo-player If running for the first time, an options form will open asking for your CMS details. Before any options can be sent from the CMS it is necessary to register the Display with the CMS instance. This can be done by completing the necessary fields using the **Connect** tab as pictured below: ![Connect to CMS](https://2149703612-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOD5P6BGYveuzkbhjZRsq%2Fuploads%2Fgit-blob-f4958ae5c8aaeabaf92fbfe1423330a5122c6b7b%2Flinux_installation_connect_cms.png?alt=media) * **CMS Address**: This is the fully qualified address of your CMS installation. For example `https://cms.example.org or http://example.org/cms` * **Key**: The secret CMS Key that will authenticate the Display with the CMS. {tip} The secret CMS Key can be viewed from the CMS under the **Administration** menu by clicking on **Settings** and the **Configuration** tab. {/tip} * **Local Library**: Please choose an appropriate local library for the Player to store its files. * On the **Advanced** tab a unique Display ID has been generated for you. * Once all the above fields have been completed, click to **Save**. {tip} At this point, the message window will update with the status "Saving with CMS... Please Wait..." {/tip} The Player will register with the CMS: * Press **Exit** to quit * Launch the Player again. {tip} To get back to Player Options form in the future run `xibo-player.options`. {/tip} ## Display Authorisation Before the Player can receive Scheduled Events and display Layouts/Campaigns you will need to **Authorise** the Display to connect to the CMS. * Click on **Display Admin** from the Player Options window or log in to the CMS and select **Displays** from the main CMS menu to see your newly registered Player in the list. * Use the row menu for this Player and select **Authorise** from the drop down menu. * Click **Yes** to confirm the authorisation of this Display. {tip} At this point, you may want to select a **Default Layout** for your new Player to run! {/tip} ### Display Setting Profiles Once registered, the Player will be given a default **Display Setting Profile**. For further information see the [Display Settings](https://xibo.org.uk/manual/en/displays_settings.html) section. ## Launch Xibo Player You can now launch the Player from the **Player Options**. You should see the Xibo Splash Screen while the Default Layout and its media contents (and anything else you have scheduled) are downloaded. The Player will then begin playing Layout content. ## Uninstalling You can safely delete the files the Player created in your temporary directory, and if you want to remove the Player from your system, simply run: ``` snap remove xibo-player ``` --- # 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 that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.xibosignage.com/open-source-player-apps/xibo-for-linux-installation.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.