vicwomg/pikaraoke repository overview

docker run vicwomg/pikaraoke:latest 

version: '3.8'

services:
  pikaraoke:
    # --- BUILD OPTION ---
    # To build locally, uncomment the build section:
    # build:
    #   context: .
    #   dockerfile: build_scripts/docker/Dockerfile

    # --- IMAGE OPTION ---
    # Default: Pulls the pre-built image from Docker Hub
    image: vicwomg/pikaraoke:latest

    container_name: PiKaraoke

    # --- COMMAND CONFIGURATION ---
    # -u: Required for the QR code to work on other devices.
    #     Replace <YOUR_LAN_IP> with your computer's actual IP (e.g., 192.168.1.50)
    # --config-file-path: Ensures settings are saved to the mounted volume
    command: >
      -u http://<YOUR_LAN_IP>:5555

    # --- TIMEZONE ---
    # Set this to your own zone, from the "TZ identifier" column of
    # https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
    environment:
      - TZ=Europe/London

    # --- VOLUMES ---
    # The <local_directory>:<container_directory> format is used.
    # You should only need to change <local_directory>
    # You can change the <local_directory> to an absolute path (e.g., C:/Music or /home/pi/Music)
    # Relative current directory paths (./) are used here for simplicity.
    volumes:
      - ./songs:/app/pikaraoke-songs      # Songs will be saved here
      - ./data:/home/pikaraoke/.pikaraoke # Data, including your config, will be saved here

    # --- PORTS ---
    # Map host port 5555 to container port 5555
    ports:
      - "5555:5555"

    restart: unless-stopped

    # Bridge mode is required for cross-platform compatibility (Win/Mac/Linux)
    network_mode: bridge

    # Logging limits to prevent disk filling
    logging:
      driver: "json-file"
      options:
        max-size: "10m"
        max-file: "3"