Connect a Display
This guide walks you through connecting a new display to your Xibo CMS, from installation to seeing content on screen.
1. Prerequisites
Before you start, you'll need:
- Xibo CMS URL — the address of your CMS (e.g.,
https://cms.example.com) - CMS Secret Key — found in your CMS under Settings → Display Settings → CMS Secret Key
- A player device — a Linux PC, Raspberry Pi, or any machine with a browser
2. Install the player
Choose the player that fits your hardware:
| Player | Best for | Install |
|---|---|---|
| Electron | Dedicated PCs with GPU | dnf install xiboplayer-electron |
| Chromium | Lightweight PCs, ARM boards | dnf install xiboplayer-chromium |
| Kiosk image | Flash-and-boot appliances | Download ISO from Downloads |
| PWA | Any browser, quick testing | Open https://your-cms/player/ |
For RPM-based systems, first add the xiboplayer repository:
sudo dnf install https://dl.xiboplayer.org/rpm/fedora/43/noarch/xiboplayer-release-43-7.fc43.noarch.rpm
sudo dnf install xiboplayer-electron
3. First launch
When the player starts for the first time, you'll see the setup page:
- CMS URL — enter your full CMS address including
https:// - CMS Key — the secret key from step 1
- Display Name — a friendly name (e.g., "Lobby Screen", "Meeting Room 3")
Click Connect. The player will register with the CMS.
4. Authorize in CMS
The player is now waiting for authorization:
- Log into your Xibo CMS web interface
- Navigate to Displays in the left menu
- You'll see your new display with a status of Waiting for approval
- Click the row menu (three dots) → Authorise
- Optionally, assign the display to a Display Group for easier scheduling
5. Verify content
After authorization:
- The player receives the default layout from the CMS
- Content should appear within 30-60 seconds (the next collection cycle)
- If you've scheduled specific campaigns, they'll appear according to the schedule
To force an immediate update, go to Displays in the CMS, click the row menu → Send Command → Collect Now.
6. Auto-start on boot
Electron / Chromium (systemd)
# Enable auto-start for the current user
systemctl --user enable xiboplayer-electron.service
# or
systemctl --user enable xiboplayer-chromium.service
Kiosk image
Auto-start is already configured. The display boots directly into the player.
Troubleshooting
| Problem | Solution |
|---|---|
| "Connection refused" | Check the CMS URL includes https:// and the port if non-standard |
| "Invalid server key" | Verify the CMS Key matches Settings → Display Settings → CMS Secret Key |
| Display stays pending | Check the CMS firewall allows connections from the player's IP |
| Content doesn't update | Wait for the collection interval (default: 5 minutes) or send Collect Now |
See the full Troubleshooting guide for more solutions.