diff --git a/docker-compose.yaml b/docker-compose.yaml index e1ad5af..2a64548 100755 --- a/docker-compose.yaml +++ b/docker-compose.yaml @@ -1,17 +1,20 @@ name: spotizerr services: spotizerr: - image: cooldockerizer93/spotizerr:beta + image: cooldockerizer93/spotizerr + user: "1000:1000" # Spotizerr user:group ids volumes: - - ./data:/app/data - - ./downloads:/app/downloads - - ./logs:/app/logs + # Ensure these dirs exist and are writable by the container user + - ./data:/app/data # data directory, contains config, creds, watch, history + - ./downloads:/app/downloads # downloads directory, contains downloaded files + - ./logs:/app/logs # logs directory, contains logs ports: + # Port to expose the app on - 7171:7171 container_name: spotizerr-app - user: "1000:1000" # spotizerr user:group ids restart: unless-stopped env_file: + # Ensure you have a .env file in the root of the project, with the correct values - .env depends_on: - redis diff --git a/docs/user/environment.md b/docs/user/environment.md index 7f5476c..7d0df4c 100644 --- a/docs/user/environment.md +++ b/docs/user/environment.md @@ -13,8 +13,6 @@ Location: project `.env`. Minimal reference for server admins. - REDIS_PASSWORD: Password ### File ownership & permissions -- PUID: Container user ID owning downloads (default `1000`) -- PGID: Container group ID owning downloads (default `1000`) - UMASK: Default permissions for new files (default `0022`) - SKIP_SET_PERMISSIONS: Skip permission fix on startup (`true|false`, default `false`) diff --git a/docs/user/getting-started.md b/docs/user/getting-started.md index f0f028f..91ff422 100644 --- a/docs/user/getting-started.md +++ b/docs/user/getting-started.md @@ -9,16 +9,11 @@ Quick start (Docker Compose): ```bash -# 1) Create a project directory mkdir spotizerr && cd spotizerr +mkdir -p data logs downloads +wget https://github.com/spotizerr-dev/spotizerr/blob/main/docker-compose.yaml -# 2) Add .env -# Download .env.example from the repo and create .env with your values - -# 3) Add docker-compose.yaml -# Download docker-compose.yaml from the repo to this folder - -# 4) Start +# Before running this last command, check your docker compose file first, it is well-documented. docker compose up -d ```