Updated docs
CI / check (push) Successful in 1m10s
CI / docker (push) Successful in 1m35s

This commit is contained in:
Connor Johnstone
2026-03-23 16:52:01 -04:00
parent 53b3a644a1
commit 6821427471
8 changed files with 65 additions and 103 deletions
+5 -8
View File
@@ -23,23 +23,20 @@ This is the recommended way to run Shanty.
```yaml
services:
shanty:
image: git.squid-inc.dev/connor/shanty:latest
image: git.rcjohnstone.com/connor/shanty:latest
ports:
- "8085:8085"
- "6080:6080"
# - "6080:6080" # Optional: expose if YouTube login iframe doesn't load
volumes:
- ./config:/config
- shanty-data:/data
- ./data:/data
- /path/to/your/music:/music
environment:
- SHANTY_WEB_BIND=0.0.0.0
restart: unless-stopped
volumes:
shanty-data:
```
**2.** Replace `/path/to/your/music` with the directory where you want your music library stored.
**2.** Replace `/path/to/your/music` with the directory where you want your music library stored. The `./data` directory will be created automatically and stores the database, downloads, and any imported MusicBrainz data. If you plan to use the [local MusicBrainz database](docs/features/musicbrainz-db.md), put this on an SSD.
**3.** Start the container:
@@ -57,7 +54,7 @@ For developers who want to build and run locally:
```sh
# Prerequisites: Rust (edition 2024), yt-dlp, ffmpeg, Python 3, ytmusicapi, Trunk
git clone https://git.squid-inc.dev/connor/shanty.git
git clone https://git.rcjohnstone.com/connor/shanty.git
cd shanty
# Build frontend