Deploy with Docker

​

Docker Deployment Guide

​

Prerequisites

• Docker and Docker Compose installed
• Basic understanding of Docker concepts
• Access to a server or local machine where you want to deploy Usertour

​

Installation Steps

1. Install Docker and Docker Compose
2. Configure Environment Variables Create a .env file or add environment variables to your docker-compose.yml. You can use this example file as a reference. For detailed environment variable documentation, see Environment Variables.
3. Create Docker Compose Configuration Choose one of the following deployment options:

   ​

   Option 1: Local Development Setup

   This configuration includes all dependencies (PostgreSQL and Redis) in Docker containers:
   Copy

   services:
     app:
       build:
         context: .
         dockerfile: Dockerfile
       ports:
         - "8011:80"
       env_file:
         - .env
       depends_on:
         postgres:
           condition: service_healthy
         redis:
           condition: service_healthy
       restart: always
   
     postgres:
       image: postgres:15-alpine
       environment:
         - POSTGRES_USER=postgres
         - POSTGRES_PASSWORD=postgres
         - POSTGRES_DB=usertour
       volumes:
         - postgres_data:/var/lib/postgresql/data
       healthcheck:
         test: ['CMD-SHELL', 'pg_isready -U postgres']
         interval: 10s
         timeout: 5s
         retries: 3
         start_period: 10s
       restart: always
   
     redis:
       image: redis:alpine
       volumes:
         - redis_data:/data
       healthcheck:
         test: ['CMD', 'redis-cli', 'ping']
         interval: 10s
         timeout: 5s
         retries: 3
         start_period: 10s
       restart: always
   
   volumes:
     postgres_data:
     redis_data:
   
   For local development, make sure to set these environment variables in your .env file:
   Copy

   # Redis Configuration
   REDIS_HOST=redis
   REDIS_PORT=6379
   REDIS_PASS=
   
   # PostgreSQL Configuration
   DATABASE_URL=postgresql://postgres:postgres@postgres:5432/usertour?schema=usertour&sslmode=prefer
   

   ​

   Option 2: Production Setup

   For production environments, you’ll need to:
   1. Deploy Redis and PostgreSQL using cloud services (AWS, Google Cloud, etc.) or build your own infrastructure with high availability
   2. Update the .env file with your Redis and PostgreSQL configuration
   3. Use this simplified configuration:
   Copy

   services:
     app:
       image: usertour/usertour:latest
       ports:
         - "8011:80"
       env_file:
         - .env
       restart: always
   
4. Start Usertour Run the following command in the directory containing your docker-compose.yml:
   Copy

   docker-compose -f docker-compose.yml up -d
   
   If you’re using the latest version of Docker, use:
   Copy

   docker compose -f docker-compose.yml up -d
   
   This command will:
   • Initialize the database
   • Run database migrations
   • Start the Usertour application on port 8011

​

Accessing Usertour

1. Initial Access
   • Navigate to http://<your-server-ip>:8011 or your configured domain and port
   • Note: Usertour runs on HTTP by default. For HTTPS, you’ll need to set up a reverse proxy
2. Set up the first admin account
   • Open the site in your browser
   • On a fresh self-hosted deployment, Usertour will guide you to create the first System Admin account
   • After setup, sign in with that account and open System Admin from the account menu
3. Upgrading older deployments
   • If you are upgrading from an older self-hosted version and do not yet have a System Admin, assign one manually before signing in
   • A PostgreSQL example is available in the System Admin guide
   • If you are running version 0.5.0 or earlier, the seeded bootstrap admin is still lisa@simpson.com with password secret42

​

Next Steps