ansible/roles/navidrome/README.md

# Ansible Role Navidrome

Ansible role to manage a [Navidrome](https://github.com/navidrome/navidrome) instance.

## Table of Content

<!-- ANSIBLE DOCSMITH TOC START -->
* [Role variables](#variables)
  * [`navidrome_version`](#variable-navidrome_version)
  * [`navidrome_arch`](#variable-navidrome_arch)
  * [`navidrome_user`](#variable-navidrome_user)
  * [`navidrome_group`](#variable-navidrome_group)
  * [`navidrome_music_folder`](#variable-navidrome_music_folder)
  * [`navidrome_data_folder`](#variable-navidrome_data_folder)
  * [`navidrome_cache_folder`](#variable-navidrome_cache_folder)
  * [`navidrome_manage_iptables`](#variable-navidrome_manage_iptables)
  * [`navidrome_allowed_sources`](#variable-navidrome_allowed_sources)
  * [`navidrome_address`](#variable-navidrome_address)
  * [`navidrome_port`](#variable-navidrome_port)
  * [`navidrome_enable_insights_collector`](#variable-navidrome_enable_insights_collector)
  * [`navidrome_base_url`](#variable-navidrome_base_url)
<!-- ANSIBLE DOCSMITH TOC END -->
<!-- ANSIBLE DOCSMITH MAIN START -->

## Role variables<a id="variables"></a>

The following variables can be configured for this role:

| Variable | Type | Required | Default | Description (abstract) |
|----------|------|----------|---------|------------------------|
| `navidrome_version` | `str` | No | `"0.54.5"` | Version of the debian package. |
| `navidrome_arch` | `str` | No | `"amd64"` | Architecture of the debian package. |
| `navidrome_user` | `str` | No | `"navidrome"` | Operating system user to run the service. |
| `navidrome_group` | `str` | No | `"navidrome"` | Operating system group to run the service. |
| `navidrome_music_folder` | `path` | No | `"/opt/navidrome/music"` | Path to the music folder. |
| `navidrome_data_folder` | `path` | No | `"/var/lib/navidrome"` | Path to the data directory. |
| `navidrome_cache_folder` | `path` | No | `"{{ navidrome_data_folder }}/cache"` | Path to the cache folder. |
| `navidrome_manage_iptables` | `bool` | No | `false` | Configure iptables rules |
| `navidrome_allowed_sources` | `list` | No | N/A | List of IP ranges to allow when `navidrome_manage_iptables` is enabled |
| `navidrome_address` | `str` | No | `"localhost"` | Address to listen. |
| `navidrome_port` | `int` | No | `4533` | Port to listen |
| `navidrome_enable_insights_collector` | `bool` | No | `false` | Enable the insights collector. |
| `navidrome_base_url` | `str` | No | N/A | Base URL of the web interface. |

### `navidrome_version`<a id="variable-navidrome_version"></a>

[*⇑ Back to ToC ⇑*](#toc)

Version of the debian package.

- **Type**: `str`
- **Required**: No
- **Default**: `"0.54.5"`



### `navidrome_arch`<a id="variable-navidrome_arch"></a>

[*⇑ Back to ToC ⇑*](#toc)

Architecture of the debian package.

- **Type**: `str`
- **Required**: No
- **Default**: `"amd64"`



### `navidrome_user`<a id="variable-navidrome_user"></a>

[*⇑ Back to ToC ⇑*](#toc)

Operating system user to run the service.

- **Type**: `str`
- **Required**: No
- **Default**: `"navidrome"`



### `navidrome_group`<a id="variable-navidrome_group"></a>

[*⇑ Back to ToC ⇑*](#toc)

Operating system group to run the service.

- **Type**: `str`
- **Required**: No
- **Default**: `"navidrome"`



### `navidrome_music_folder`<a id="variable-navidrome_music_folder"></a>

[*⇑ Back to ToC ⇑*](#toc)

Path to the music folder.

- **Type**: `path`
- **Required**: No
- **Default**: `"/opt/navidrome/music"`



### `navidrome_data_folder`<a id="variable-navidrome_data_folder"></a>

[*⇑ Back to ToC ⇑*](#toc)

Path to the data directory.

- **Type**: `path`
- **Required**: No
- **Default**: `"/var/lib/navidrome"`



### `navidrome_cache_folder`<a id="variable-navidrome_cache_folder"></a>

[*⇑ Back to ToC ⇑*](#toc)

Path to the cache folder.

- **Type**: `path`
- **Required**: No
- **Default**: `"{{ navidrome_data_folder }}/cache"`



### `navidrome_manage_iptables`<a id="variable-navidrome_manage_iptables"></a>

[*⇑ Back to ToC ⇑*](#toc)

Configure iptables rules

- **Type**: `bool`
- **Required**: No
- **Default**: `false`



### `navidrome_allowed_sources`<a id="variable-navidrome_allowed_sources"></a>

[*⇑ Back to ToC ⇑*](#toc)

List of IP ranges to allow when `navidrome_manage_iptables` is enabled

- **Type**: `list`
- **Required**: No



### `navidrome_address`<a id="variable-navidrome_address"></a>

[*⇑ Back to ToC ⇑*](#toc)

Address to listen.

- **Type**: `str`
- **Required**: No
- **Default**: `"localhost"`



### `navidrome_port`<a id="variable-navidrome_port"></a>

[*⇑ Back to ToC ⇑*](#toc)

Port to listen

- **Type**: `int`
- **Required**: No
- **Default**: `4533`



### `navidrome_enable_insights_collector`<a id="variable-navidrome_enable_insights_collector"></a>

[*⇑ Back to ToC ⇑*](#toc)

Enable the insights collector.

- **Type**: `bool`
- **Required**: No
- **Default**: `false`



### `navidrome_base_url`<a id="variable-navidrome_base_url"></a>

[*⇑ Back to ToC ⇑*](#toc)

Base URL of the web interface.

- **Type**: `str`
- **Required**: No




<!-- ANSIBLE DOCSMITH MAIN END -->

## Donate

As we all love FOSS, you should consider sponsoring the
[Navidrome](https://github.com/navidrome/navidrome) project.