Added docker/compose stuff and hopefully fixed CI
Some checks failed
CI / check (push) Failing after 12s
Some checks failed
CI / check (push) Failing after 12s
This commit is contained in:
41
readme.md
41
readme.md
@@ -121,6 +121,47 @@ download:
|
||||
# cookies_path: ~/.config/shanty/cookies.txt # for higher YT rate limits
|
||||
```
|
||||
|
||||
## Docker
|
||||
|
||||
### Quick start
|
||||
|
||||
```sh
|
||||
# Edit compose.yml to set your music library path, then:
|
||||
docker compose up -d
|
||||
# Open http://localhost:8085
|
||||
```
|
||||
|
||||
### Build from source
|
||||
|
||||
```sh
|
||||
docker build -t shanty .
|
||||
docker run -d \
|
||||
-p 8085:8085 \
|
||||
-v ./config:/config \
|
||||
-v shanty-data:/data \
|
||||
-v /path/to/music:/music \
|
||||
shanty
|
||||
```
|
||||
|
||||
### Volumes
|
||||
|
||||
| Mount | Purpose |
|
||||
|-------|---------|
|
||||
| `/config` | Config file (`config.yaml`) |
|
||||
| `/data` | Database (`shanty.db`) and downloads |
|
||||
| `/music` | Your music library |
|
||||
|
||||
### Environment variables
|
||||
|
||||
| Variable | Default | Description |
|
||||
|----------|---------|-------------|
|
||||
| `SHANTY_CONFIG` | `/config/config.yaml` | Config file path |
|
||||
| `SHANTY_DATABASE_URL` | `sqlite:///data/shanty.db?mode=rwc` | Database URL |
|
||||
| `SHANTY_LIBRARY_PATH` | `/music` | Music library path |
|
||||
| `SHANTY_DOWNLOAD_PATH` | `/data/downloads` | Download directory |
|
||||
| `SHANTY_WEB_PORT` | `8085` | HTTP port |
|
||||
| `SHANTY_WEB_BIND` | `0.0.0.0` | Bind address |
|
||||
|
||||
## Testing
|
||||
|
||||
```sh
|
||||
|
||||
Reference in New Issue
Block a user