Self-host Xibo CMS

MYSQL_ROOT_PASSWORD, MYSQL_DATABASE, XMR_DEBUG, IPV6PUBSUPPORT, CMS_DEV_MODE

version: "3"

services: db: image: mysql:8.4 ports: - "3315:3306" volumes: - ./containers/db:/var/lib/mysql environment: MYSQL_ROOT_PASSWORD: "root" MYSQL_DATABASE: "cms"

xmr: image: ghcr.io/xibosignage/xibo-xmr:develop ports: - "9505:9505" environment: XMR_DEBUG: "true" IPV6PUBSUPPORT: "false"

web: build: context: . dockerfile: Dockerfile.dev volumes: - ./:/var/www/cms ports: - "80:80" environment: CMS_DEV_MODE: "true" MYSQL_DATABASE: "cms"

memcached: image: memcached:alpine command: memcached -m 15

swagger: image: swaggerapi/swagger-ui:latest ports: - "8080:8080" environment: - API_URL=http://localhost/swagger.json

quickchart: image: ianw/quickchart

docker-compose up --build -d

Database credentials in web/settings.php, SECRET_KEY, SERVER_KEY, LIBRARY_LOCATION, defaultTimezone, $whitelistHosts, $trustedProxyIps, $allowLocalNetworkRequests

Prerequisites

PHP 8.1+ with the following extensions enabled:

Extension	Notes
pdo + pdo_mysql	Database access
json	Required
soap	Required
gd	Image processing
fileinfo	Media type detection
pcre	Pattern matching
gettext	Translations
dom	XML handling
simplexml	XML handling
curl	HTTP client
openssl	Encryption
zip	Archive handling

Other requirements:

• MySQL 8.0+
• Composer 2.x
• Node.js 12+ and npm (for building frontend assets)
• Apache with mod_rewrite (.htaccess is provided), or Nginx

1. Get the code

git clone https://github.com/xibosignage/xibo-cms.git xibo-cms
cd xibo-cms

composer install --no-dev
npm install && npm run publish

2. Create writable directories

Choose a library path outside the web root. The web root is the web/ subdirectory.

# Media library (outside web root)
mkdir -p /var/lib/xibo/library/fonts
chmod 755 /var/lib/xibo/library

# Application cache (inside repo, outside web root)
mkdir cache
chmod 755 cache

3. Create the MySQL database

CREATE DATABASE xibo CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci;
CREATE USER 'xibouser'@'localhost' IDENTIFIED BY 'strongpassword';
GRANT ALL PRIVILEGES ON xibo.* TO 'xibouser'@'localhost';
FLUSH PRIVILEGES;

4. Create web/settings.php

Create the file web/settings.php with your database credentials:

<?php
defined('XIBO') or die('Direct access not permitted');

$dbhost = 'localhost';
$dbuser = 'xibouser';
$dbpass = 'strongpassword';
$dbname = 'xibo';
$dbport = '3306';

define('SECRET_KEY', 'REPLACE_WITH_RANDOM_12_CHARS');

if (file_exists(dirname(__FILE__) . '/settings-custom.php')) {
    include_once dirname(__FILE__) . '/settings-custom.php';
}

5. Run database migrations

vendor/bin/phinx migrate -c phinx.php

6. Set admin credentials

Connect to your MySQL database and run:

UPDATE `user`
   SET UserName    = 'xibo_admin',
       UserPassword = MD5('yourpassword'),
       UserEmail   = 'admin@example.com'
 WHERE UserID = 1 LIMIT 1;

UPDATE `group` SET `group` = 'xibo_admin' WHERE groupId = 3 LIMIT 1;

7. Configure CMS settings

-- Path to the media library directory (trailing slash required)
UPDATE `setting` SET `value` = '/var/lib/xibo/library/'
 WHERE `setting` = 'LIBRARY_LOCATION';

-- Server key shared with media players during registration
UPDATE `setting` SET `value` = 'your_server_key'
 WHERE `setting` = 'SERVER_KEY';

-- Timezone for the CMS (PHP timezone identifier)
UPDATE `setting` SET `value` = 'Europe/London'
 WHERE `setting` = 'defaultTimezone';

8. Configure the web server (Apache or Nginx)

Point the document root at the web/ subdirectory.