lidarr #0

  • By ec0
  • stable
Supports: bionic xenial
Add to new model

Description

Installs lidarr with relations for registering downloaders and notifications


Overview

This charm provides Lidarr. Lidarr is an automatic NZB downloader for music.

Usage

To deploy:

juju deploy cs:~pirate-charmers/lidarr

This charm implements
* [interface:reverseproxy][interface-reverseproxy] intended for use with the
[HAProxy Charm][charm-haproxy]. This should be used if remote access is required
to enable TLS encryption.
* [interface:usenetdownloader][interface-usenetdownloader] intended for use
with the [Sabnzbd Charm][charm-sabnzbd].

Known Limitations and Issues

This charm is under development, several other use cases/features are still under
consideration. Merge requests are certainly appreciated, some examples of
current limitations include.

  • Scale out usage is not intended, I'm not even sure what use it would be
  • The GitHub API is used to find the latest release, and if the install hook runs too many time, you could find
    yourself hitting an API limit will cause the hook to fail

Configuration

You will most likely want to use a bundle to set options during deployment.

See the full list of configuration options below. This will detail some of the
options that are worth highlighting.

  • restore-config: Combined with a resource allows restoring a previous
    configuration. This can also be used to migrate from non-charmed
    Lidarr. The Lidarr backup zip needs to be attached as the resource Lidarrconfig.
  • backup-count: This configuration is not currently used.
  • backup-location: A folder to sync the Lidarr backups to daily, number and
    frequency of backups are controlled by Lidarr . This charm simply syncs
    (including deletions) the Backup folder to another location of your choosing.
  • proxy-*: The proxy settings allow configuration of the reverseproxy interface
    that will be registered during relation.
  • hostname will allow you to customize the hostname, be aware that
    doing this can cause multiple hosts to have the same hostname if you scale
    out the number of units. Setting hostname to "$UNIT" will set the hostname to
    the juju unit id. Note scaling out is not supported, tested, or useful.

Contact Information

Upstream Project Information

Related links

Lidarr
charm-haproxy
charm-sabnzbd
interface-reverseproxy
interface-usenetdownloader


Configuration

backup-count
(int) Number of backups to keep
backup-cron
(string) Interval to create backup, takes a cron compatible string
@daily
backup-location
(string) Location to store backups
hostname
(string) The host name to set
lidarr-user
(string) The user and groups to install Lidarr under. These will be created automatically
lidarr
port
(int) Port for Lidarr
8686
proxy-domain
(string) Subdomain to request from reverse proxy
lidarr
proxy-group
(string) The name of the backend this charm will use, this should be unique for deployment/reverseproxy. Lidarr is not designed to be run in HA with multiple units grouped
lidarr
proxy-port
(int) Port to request for reverse proxy access
443
proxy-url
(string) Urlbase for reverse proxy, must start with a "/"
/lidarr
restore-config
(boolean) Restore a previous configuration from resource
system-additional-groups
(string) Comma separated list of groups to create. User accounts will not be created
system-additional-users
(string) Comma separated list of users to create. Groups with the same name will be created.
system-gidmap
(string) Ensure the provided groups, comma separated, have the GID specified after '='. e.g. ubuntu=1000,storage=1001
system-group-membership
(string) Ensure the users provided, comma separated, are members of the provided groups, colon separated, following '='. e.g. ubuntu=sudo:wheel,storage=storage,sudo
system-uidmap
(string) Ensure the provided users, comma separated, have the UID specified after '='. e.g. ubuntu=1000,storage=1001