mirror of
https://github.com/alexbelgium/hassio-addons.git
synced 2026-01-10 09:51:02 +01:00
119 lines
6.4 KiB
Markdown
119 lines
6.4 KiB
Markdown
# Home assistant add-on: Navidrome
|
|
|
|
## 💖 Support development
|
|
|
|
I maintain this and other Home Assistant add-ons in my free time: keeping up with upstream changes, HA changes, and testing on real hardware takes a lot of time (and some money). I use around 5-10 of my >110 addons so regularly I install test machines (and purchase some test services such as vpn) that I don't use myself to troubleshoot and improve the addons
|
|
|
|
If this add-on saves you time or makes your setup easier, I would be very grateful for your support!
|
|
|
|
[![Buy me a coffee][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
|
|
[![Donate via PayPal][paypal-badge]](https://www.paypal.com/donate/?hosted_button_id=DZFULJZTP3UQA)
|
|
|
|
## Addon informations
|
|
|
|
|
|
|
|
|
|
|
|
[](https://www.codacy.com/gh/alexbelgium/hassio-addons/dashboard?utm_source=github.com&utm_medium=referral&utm_content=alexbelgium/hassio-addons&utm_campaign=Badge_Grade)
|
|
[](https://github.com/alexbelgium/hassio-addons/actions/workflows/weekly-supelinter.yaml)
|
|
[](https://github.com/alexbelgium/hassio-addons/actions/workflows/onpush_builder.yaml)
|
|
|
|
[donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white
|
|
[paypal-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee%20Paypal-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white
|
|
|
|
_Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!_
|
|
|
|
[](https://github.com/alexbelgium/hassio-addons/stargazers)
|
|
|
|
|
|
|
|
## About
|
|
|
|
Various tweaks and configuration options addition.
|
|
This addon is based on the [docker image](https://hub.docker.com/r/deluan/navidrome).
|
|
|
|
## Configuration
|
|
|
|
Webui can be found at <http://homeassistant:PORT> or through the sidebar using Ingress.
|
|
Configurations can be done through the app webUI, except for the following options.
|
|
|
|
See https://www.navidrome.org/docs/usage/configuration-options/ for additional configuration details.
|
|
|
|
### Options
|
|
|
|
| Option | Type | Default | Description |
|
|
|--------|------|---------|-------------|
|
|
| `base_url` | str | `/` | Base URL to configure Navidrome behind a proxy |
|
|
| `music_folder` | str | `/data/music` | Folder where your music library is stored |
|
|
| `data_folder` | str | `/data` | Folder to store application data (DB) |
|
|
| `log_level` | str | `info` | Log level (error, warn, info, debug, trace) |
|
|
| `ssl` | bool | `false` | Enable HTTPS for the web interface |
|
|
| `certfile` | str | | Path for the TLS certificate |
|
|
| `keyfile` | str | | Path for the TLS key file |
|
|
| `default_language` | str | | Default language for the interface |
|
|
| `image_cache_size` | str | | Size of the image cache |
|
|
| `transcoding_cache_size` | str | | Size of the transcoding cache |
|
|
| `scan_schedule` | str | | Cron expression for automatic library scanning |
|
|
| `password_encryption_key` | str | | Key for password encryption |
|
|
| `welcome_message` | str | | Custom welcome message |
|
|
| `lastfm_api_key` | str | | Last.fm API key for scrobbling |
|
|
| `lastfm_secret` | str | | Last.fm secret for scrobbling |
|
|
| `spotify_id` | str | | Spotify client ID for metadata |
|
|
| `spotify_secret` | str | | Spotify client secret for metadata |
|
|
| `localdisks` | str | | Local drives to mount (e.g., `sda1,sdb1,MYNAS`) |
|
|
| `networkdisks` | str | | SMB shares to mount (e.g., `//SERVER/SHARE`) |
|
|
| `cifsusername` | str | | SMB username for network shares |
|
|
| `cifspassword` | str | | SMB password for network shares |
|
|
| `cifsdomain` | str | | SMB domain for network shares |
|
|
|
|
### Example Configuration
|
|
|
|
```yaml
|
|
base_url: "/"
|
|
music_folder: "/data/music"
|
|
data_folder: "/data"
|
|
log_level: "info"
|
|
ssl: false
|
|
certfile: "fullchain.pem"
|
|
keyfile: "privkey.pem"
|
|
scan_schedule: "0 2 * * *"
|
|
lastfm_api_key: "your-lastfm-key"
|
|
localdisks: "sda1,sdb1"
|
|
networkdisks: "//192.168.1.100/music"
|
|
cifsusername: "musicuser"
|
|
cifspassword: "password123"
|
|
cifsdomain: "workgroup"
|
|
```
|
|
|
|
### Mounting Drives
|
|
|
|
This addon supports mounting both local drives and remote SMB shares:
|
|
|
|
- **Local drives**: See [Mounting Local Drives in Addons](https://github.com/alexbelgium/hassio-addons/wiki/Mounting-Local-Drives-in-Addons)
|
|
- **Remote shares**: See [Mounting Remote Shares in Addons](https://github.com/alexbelgium/hassio-addons/wiki/Mounting-remote-shares-in-Addons)
|
|
|
|
### Custom Scripts and Environment Variables
|
|
|
|
This addon supports custom scripts and environment variables:
|
|
|
|
- **Custom scripts**: See [Running Custom Scripts in Addons](https://github.com/alexbelgium/hassio-addons/wiki/Running-custom-scripts-in-Addons)
|
|
- **env_vars option**: Use the add-on `env_vars` option to pass extra environment variables (uppercase or lowercase names). See https://github.com/alexbelgium/hassio-addons/wiki/Add-Environment-variables-to-your-Addon-2 for details.
|
|
|
|
## Installation
|
|
|
|
The installation of this add-on is pretty straightforward and not different in
|
|
comparison to installing any other Hass.io add-on.
|
|
|
|
1. [Add my Hass.io add-ons repository][repository] to your Hass.io instance.
|
|
1. Install this add-on.
|
|
1. Click the `Save` button to store your configuration.
|
|
1. Start the add-on.
|
|
1. Check the logs of the add-on to see if everything went well.
|
|
1. Go to the webui, where you will initialize the app
|
|
1. Restart the addon, to apply any option that should be applied
|
|
|
|
[repository]: https://github.com/alexbelgium/hassio-addons
|
|
|
|
|