Lidarr

Music Management.

Ansible Role: lidarr

You can copy your existing configuration to lidarr_config directory adjusting for paths.

• The UID/GID should be set to a user/group that has access to your media. All media clients should run under the same user to run correctly.

• Your downloader will report the download path mapped in the downloader service. You need to map this exact path in Radarr for it to be able to post-process downloads properly.

• See Basic Configuration for example configuration.

README.md

# Lidarr
Lidarr installation from public release tarball.

## Requirements
No additional requirements.

## Role Variables
Settings have been throughly documented for usage.

[defaults/main.yml](https://github.com/r-pufky/ansible_lidarr/blob/main/defaults/main/main.yml).

### Ports
All ports and protocols have been defined for the role.

Hosts should only define firewall rules for ports they need.

[defaults/ports.yml](https://github.com/r-pufky/ansible_lidarr/blob/main/defaults/main/ports.yml).

## Dependencies
N/A

## Example Playbook
host_vars/lidarr.example.com/vars/lidarr.yml
``` yaml
lidarr_api_key:              '{{ vault_lidarr_api_key }}'
lidarr_update_automatically: true
lidarr_port:                 '8989'
```

site.yml
``` yaml
- name:   'lidarr server'
  hosts:  'lidarr.example.com'
  become: true
  roles:
     - 'r_pufky.lidarr'
```

## Issues
Create a bug and provide as much information as possible.

Associate pull requests with a submitted bug.

## License
[AGPL-3.0 License](https://github.com/r-pufky/ansible_lidarr/blob/main/LICENSE)

## Author Information
https://keybase.io/rpufky

None

Role Details: Updated: 2022-10-15 galaxy source service docs

Ports

---
###############################################################################
# Ports Configuration
###############################################################################
# Ports should be managed externally via an OS role.
#
# Reference:
# * https://docs.ansible.com/ansible/latest/collections/community/general/ufw_module.html

ports:
  - {proto: 'tcp', from_ip: 'any',       to_port: 8686, direction: 'in', comment: 'lidarr http'}
  - {proto: 'tcp', from_ip: '127.0.0.1', to_port: 8686, direction: 'in', comment: 'lidarr http api'}
  - {proto: 'tcp', from_ip: 'any',       to_port: 6868, direction: 'in', comment: 'lidarr https'}
  - {proto: 'tcp', from_ip: '127.0.0.1', to_port: 6868, direction: 'in', comment: 'lidarr https api'}

Defaults

---
###############################################################################
# Lidarr Role Configuration
###############################################################################
# User that lidarr will run under. Assumes externally managed.
lidarr_user:  'media'
lidarr_group: 'media'

# Create 'media' user if not detected? See: vars/main.yml.
lidarr_create_user: false

# Generic architecture for platform: x64, arm, arm64
lidarr_arch_generic: 'x64'

# C architecture for platform: linux, linuxmusl. Defualt: linux.
lidarr_arch_c: 'linux'

# Installation directory
lidarr_dir: '/var/lib/lidarr'

# Configuration directory
lidarr_config: '/var/lib/lidarr-config'

# Staging directory for backups
lidarr_staging: '/var/lib/lidarr-staging'

# Target location of backup file on ansible host.
lidarr_local_backup: 'host_vars/data/lidarr-config.tar.gz'

###############################################################################
# Lidarr config.xml Configuration
###############################################################################

lidarr_port:                  '8686' # http port
lidarr_bind_address:          '*'
# Lidarr requires ssl port to be defined even if unused
lidarr_ssl_port:              '6868' # https port
lidarr_enable_ssl:            false
lidarr_api_key:               ''
lidarr_authentication_method: 'None'
lidarr_log_level:             'info'
lidarr_launch_browser:        false # Default: undefined
lidarr_branch:                'master'
lidarr_ssl_cert_hash:         ''
lidarr_update_mechanism:      'BuiltIn'
lidarr_analytics_enabled:     false # Default: undefined
lidarr_update_automatically:  false # Default: undefined
lidarr_url_base:              ''