diff --git a/.gitignore b/.gitignore index b2fbf14..35e6497 100644 --- a/.gitignore +++ b/.gitignore @@ -2,6 +2,7 @@ .env .env.* !.env.example +docker-compose.yml # Runtime data data/* diff --git a/README.md b/README.md index 1ff57c9..d1aa8bd 100644 --- a/README.md +++ b/README.md @@ -74,6 +74,14 @@ The repository includes `.env.example` as a template. Never commit `.env`, the S ## Running with Docker +The repository contains `docker-compose.example.yml` as a portable default configuration. Copy it to `docker-compose.yml` before starting the service: + +```bash +cp docker-compose.example.yml docker-compose.yml +``` + +The copied `docker-compose.yml` is ignored by Git, so it can be customized locally without affecting the public repository. The example exposes port `8000` directly, which is convenient for a local installation. + Build and start the service: ```bash @@ -153,7 +161,7 @@ When possible, the response is saved under `data/diagnostics/` for investigation ├── static/ # static assets, including the favicon ├── templates/ # Jinja2 dashboard templates ├── Dockerfile -├── docker-compose.yml +├── docker-compose.example.yml ├── main.py ├── requirements.txt └── .env.example diff --git a/docker-compose.example.yml b/docker-compose.example.yml new file mode 100644 index 0000000..ca46806 --- /dev/null +++ b/docker-compose.example.yml @@ -0,0 +1,13 @@ +services: + radiosync: + build: . + container_name: radiosync_hub + restart: unless-stopped + ports: + - "8000:8000" + volumes: + - ./data:/app/data + environment: + - TZ=Europe/Warsaw + - RADIOSYNC_SECRET_KEY=${RADIOSYNC_SECRET_KEY:?Set RADIOSYNC_SECRET_KEY in .env} + - RADIOSYNC_CONFIG_KEY=${RADIOSYNC_CONFIG_KEY:-}