Skip to content

Commit

Permalink
docs: table for env var and volumes
Browse files Browse the repository at this point in the history
  • Loading branch information
add-n2x committed Jan 1, 2025
1 parent e8f7fcc commit 71fd095
Showing 1 changed file with 18 additions and 9 deletions.
27 changes: 18 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,24 @@ docker run --rm -it \
--entrypoint bash nd-toolbox
```

Bind-mounts:
- `MUSIC_DIR` (read-only): Point to the directory where your music files are located.
- `ND_DIR` (writeable): Point to the directory where your Navidrome database is located.
- `DATA_DIR` (writable): Point to a directory where temporary processing data and logs can be stored.
If not set a default volume is used.

Environment vars:
- `TZ`: Set your timezone. If not set it defaults to `Europe/Vienna`.
- `ND_BASE_PATH`: Base path of the music library within your Navidrome container. Defaults to `/music/library`.
### Volumes

Bind-mount the following local directories into the container:

| Parameter | Description |
|------------|---------------------------------------------------------------------------------|
| `MUSIC_DIR` | Run the container in background. If not set, the container runs in foreground. |
| `DATA_DIR` | A directory where temporary processing data and logs can be stored. |
| `ND_DIR` | The directory where your Navidrome database is located. |

### Environment Variables

Optionally set these environment variables:

| Parameter | Description |
|-----------------|-----------------------------------------------------------------------------------------------|
| `TZ` | Set your timezone. If not set it defaults to `Europe/Vienna`. |
| `ND_BASE_PATH` | Base path of the music library within your Navidrome container. Defaults to `/music/library`. |

## Usage

Expand Down

0 comments on commit 71fd095

Please sign in to comment.