mountaincnc/read repository overview

version: '3.8'

services:
  # The Read application service
  app:
    image: mountaincnc/read:2.18.1
    restart: unless-stopped
    ports:
      - "127.0.0.1:18888:8080"
    # Set the environment variables needed by the entrypoint script
    environment:
      # --- Set up timezone ---
      - TZ=Asia/Shanghai
      # --- Database Configuration ---
      - DB_TYPE=mysql
      - DB_HOST=db
      - DB_PORT=3306
      - DB_DATABASE=read_db
      - DB_USERNAME=read_user
      - DB_PASSWORD=read_password
      # --- Cache Configuration ---
      - CACHE_DRIVERTYPE=redis
      - CACHE_SERVER=redis:6379
      # --- Admin User Configuration ---
      - ADMIN_USERNAME=admin
      - ADMIN_PASSWORD=chang_admin_password
      - ADMIN_CODE=invite_code
    # IMPORTANT: The mounted external configure file take precedence over environment variables!!!
    #volumes:
    #  - ./config.yaml:/app/conf.yml
    # This ensures that the database and cache are started before the app starts
    depends_on:
      db:
        condition: service_healthy
      redis:
        condition: service_started
    # Connect this service to our custom network
    networks:
      - read-network

  # The MySQL database service
  db:
    # Use an official MySQL image
    image: mysql:8.0
    restart: unless-stopped
    # Environment variables to initialize the MySQL database
    environment:
      # --- Set up timezone ---
      - TZ=Asia/Shanghai
      # This sets the root password for the MySQL server
      - MYSQL_ROOT_PASSWORD=very_strong_root_password
      # This creates the database for the application
      - MYSQL_DATABASE=read_db
      # This creates a dedicated user for the application
      - MYSQL_USER=read_user
      # This sets the password for the dedicated user
      - MYSQL_PASSWORD=read_password
    # Use a named volume to persist the database data
    volumes:
      - mysql-data:/var/lib/mysql
    # Healthcheck to ensure the database is ready for connections before dependent services start
    healthcheck:
      test: ["CMD", "mysqladmin", "ping", "-h", "localhost", "-u", "root", "-pvery_strong_root_password"]
      interval: 10s
      timeout: 5s
      retries: 5
    networks:
      - read-network

  # The Redis cache service
  redis:
    # Use a lightweight official Redis image
    image: redis:7-alpine
    restart: unless-stopped
    environment:
      # --- Set up timezone ---
      - TZ=Asia/Shanghai
    # Use a named volume to persist Redis data (optional but good practice)
    volumes:
      - redis-data:/data
    networks:
      - read-network

# Top-level declaration for named volumes
volumes:
  mysql-data:
  redis-data:

# Top-level declaration for the custom network
networks:
  read-network:
    driver: bridge

version: '3.8'

services:
  # The Read application service
  app:
    image: mountaincnc/read:2.18.1
    restart: unless-stopped
    ports:
      - "127.0.0.1:18888:8080"
    # Set the environment variables needed by the entrypoint script
    environment:
      # --- Set up timezone ---
      - TZ=Asia/Shanghai
      # --- Admin User Configuration ---
      - ADMIN_USERNAME=admin
      - ADMIN_PASSWORD=chang_admin_password
    volumes:
      - sqlite-data:/app/data
    # Connect this service to our custom network
    networks:
      - read-network

volumes:
  sqlite-data:

# Top-level declaration for the custom network
networks:
  read-network:
    driver: bridge

YOUR_DOMAIN {
        reverse_proxy 127.0.0.1:18888
}

server {
    listen [::]:80;
    server_name your.example.com example.com;

    location / {
        # Replace with the port your application is running on
        proxy_pass http://127.0.0.1:18888;

        # Standard proxy headers
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;

        # WebSocket specific headers
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
    }
}