Updated docs
This commit is contained in:
@@ -24,20 +24,17 @@ Create `docker-compose.yml` with these contents:
|
||||
```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:
|
||||
```
|
||||
|
||||
Replace `/path/to/your/music` with the actual path to where you want your music stored. For example, `/home/yourname/Music` on Linux or `/Users/yourname/Music` on Mac.
|
||||
@@ -47,7 +44,7 @@ Replace `/path/to/your/music` with the actual path to where you want your music
|
||||
| Mount point | Purpose |
|
||||
|-------------|---------|
|
||||
| `./config` | Stores your configuration file (`config.yaml`). Lives next to your docker-compose.yml. |
|
||||
| `shanty-data` | Stores the database and downloaded files before they are organized. Managed by Docker. |
|
||||
| `./data` | Stores the database, downloaded files, and MusicBrainz data. Put this on an SSD if possible. |
|
||||
| `/music` | Your music library. This is where organized, tagged music ends up. |
|
||||
|
||||
## Step 2: Start the container
|
||||
@@ -87,6 +84,8 @@ On first launch, you will see a setup screen. Choose a username and password (at
|
||||
|
||||
You will see the artist appear on the **Library** page with track counts showing how many tracks are wanted versus owned.
|
||||
|
||||
**Note:** Browsing artist discographies may be slow on the first visit (30-60 seconds per artist) because Shanty queries MusicBrainz one request at a time. This gets much faster after the first visit (results are cached). For instant lookups, you can [import the MusicBrainz database locally](features/musicbrainz-db.md) -- but this is optional and can be done later.
|
||||
|
||||
## Step 5: Download your music
|
||||
|
||||
Click the **Set Sail** button on the Dashboard. This runs the full pipeline:
|
||||
|
||||
Reference in New Issue
Block a user