sabnzbd #3
Description
Installs sabnzbd with relations for registering downloaders and notifications
- Tags:
- misc ›
Overview
This charm provides Sabnzbd. Sabnzbd is a program to download binary
files from Usenet servers.
Usage
To deploy:
juju deploy cs:~chris.sanders/sabnzbd
This charm implements
* interface:reverseproxy intended for use with the
HAProxy Charm. This should be used if remote access is required
to enable TLS encryption.
* interface:usenetdownloader intended for use
with the Couchpotato Charm, and Sonarr Charm.
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.
- Unit/Functional testing is not yet implemented
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. Advanced users can use this to migrate from non-charmed sabnzbd. The .sabnzbd folder need to be provided in a tar file and attached as the resource sabconfig.
- backup-*: The backup options will create a tar file compatible with the above restore.
- 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
- Code: https://github.com/chris-sanders/layer-sabnzbd
- Bug tracking: https://github.com/chris-sanders/layer-sabnzbd/issues
- Contact information: sanders.chris@gmail.com
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
- hostname-dhcp
- (boolean) Trigger DHCP renew after hostname change
- True
- port
- (int) Port for binding sab daemon
- 8080
- proxy-domain
- (string) Subdomain to request from reverse proxy
- sabnzbd
- proxy-group
- (string) The name of the backend this charm will use, this should be unique for deployment/reverseproxy. Sabnzbd is not designed to be run in HA with multiple units grouped
- sabnzbd
- proxy-port
- (int) Port to request for reverse proxy access
- 443
- proxy-url
- (string) Urlbase for revrse proxy, must start with a "/"
- /sabnzbd
- 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