diff --git a/docs/docker.md b/docs/docker.md index fa61af5..51d33d0 100644 --- a/docs/docker.md +++ b/docs/docker.md @@ -1,3 +1,27 @@ # Docker -TODO \ No newline at end of file +Recommended and the easiest way how to start to use of Spooty is using docker. +Just run docker command or use docker compose configuration. + +### Docker command +```shell +docker run -d -p 3000:3000 -v /path/to/downloads:/spooty/backend/downloads raiper34/spooty:latest +``` + +### Docker compose +```yaml +services: + spooty: + image: raiper34/spooty:latest + container_name: spooty + restart: unless-stopped + ports: + - "3000:3000" + volumes: + - /path/to/downloads:/spooty/backend/downloads +``` + +### Environment variables +Name | Description | +--- |------------------------------------------------------------------------------------------------------------------------------------------------------------------| +FORMAT | Format of downloaded files (currently fully supported only `mp3` but you can try whatever you want from [ffmpeg](https://ffmpeg.org/ffmpeg-formats.html#Muxers)) | \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index a432d0f..2aff499 100644 --- a/docs/index.html +++ b/docs/index.html @@ -25,5 +25,7 @@ + + \ No newline at end of file