Deploy Playnite Web with Docker Compose

This guide explains how to run Playnite Web using a (sample) docker-compose file. This setup includes the main web application, database, MQTT broker, and sync library processor.

1. Create your .env file, within the same directory as the compose-file, see https://public.home.playniteweb.com/wiki/spaces/PW/pages/27525131 for what to configure.

2. Set up MQTT configuration (see https://public.home.playniteweb.com/wiki/spaces/PW/pages/27525162/Deploy+Playnite+Web+with+Docker+Compose#MQTT-Configuration below)

3. Start the services, see https://public.home.playniteweb.com/wiki/spaces/PW/pages/27525162/Deploy+Playnite+Web+with+Docker+Compose#What-Gets-Started for more details.

   docker-compose -f playnite-web.docker-compose.yaml up -d

4. Check that all services are running:

   docker-compose -f playnite-web.docker-compose.yaml ps

The MQTT broker requires configuration files to work properly. You must create these files before starting the services. There is a sample mqtt configuration file that can be used to get started.

1. Create the MQTT config volume first:

   docker volume create playnite-web_mqtt_config

2. Create basic MQTT configuration:

   # Create a temporary container to add config files docker run --rm -v playnite-web_mqtt_config:/config eclipse-mosquitto:2.0.18 sh -c " echo 'listener 1883' > /config/mosquitto.conf echo 'allow_anonymous true' >> /config/mosquitto.conf echo 'listener 9001' >> /config/mosquitto.conf echo 'protocol websockets' >> /config/mosquitto.conf "

3. For better security (optional, but recommended), set up MQTT authentication:

This docker-compose setup runs four services:

1. PostgreSQL Database (db) - Stores your game library data

2. MQTT Broker (mqtt) - Handles real-time communication between services

3. Playnite Web App (playnite-web) - The main web interface (accessible at http://localhost:3000)

4. Sync Library Processor (playnite-web-game-asssets-processor) - Processes game cover art, assets, and updates database when syncing library

• Make sure you've created the MQTT configuration files (see https://public.home.playniteweb.com/wiki/spaces/PW/pages/27525162/Deploy+Playnite+Web+with+Docker+Compose#MQTT-Configuration section)

• If using MQTT authentication, ensure MQTT_USERNAME and MQTT_PASSWORD environment variables match your mosquitto password file

• Check that all required environment variables are set: DB_PASSWORD and APP_SECRET

• Verify your .env file is in the same directory as the docker-compose file

• Check logs: docker-compose -f playnite-web.docker-compose.yaml logs

• Verify the service is running: docker-compose -f playnite-web.docker-compose.yaml ps

• Check the APP_PORT environment variable (default is 3000)

• Try accessing http://localhost:3000 (or your custom port)

• Never commit your .env file to version control

• Use strong, randomly generated passwords for DB_PASSWORD

• Generate a secure random string for APP_SECRET (at least 32 characters)

• Set up MQTT authentication for production deployments

• Consider using a secrets management tool for production deployments

• The database port (5432) and MQTT ports (1883, 9001) are exposed - consider restricting access in production