-
Notifications
You must be signed in to change notification settings - Fork 132
arrX
Read through this entire page, even if you are only installing one of the apps. The instructions at the bottom of the page assume you have read the material at the top of the page.
There are several roles in the community repo which can be used to create an arbitrary number of instances of a given application. As of this writing, they are:
Role | Branch | Description |
---|---|---|
bazarrx | Master | Subtitle downloading |
lidarrx | Develop | Music management |
ombix | Master | Request management |
radarrx | Master | Movie management |
requestrrx | Develop | Discord request bot |
sonarrx | Master | TV management |
transmissionx | Develop | Torrent client |
They're all named somethingX because they allow creation of X number of something.
This started as a generalized replacement for the radarr4k
and sonarr4k
roles which were removed from cloudbox.
They are all configured in the same way.
In general terms, you'll enter the instances you want into settings.yml
:
appnamex:
roles: ["", bing, bang, boing]
That will create:
- appname
- appnamebing
- appnamebang
- appnameboing
as docker containers, subdomain, and data directories in /opt
when you run the relevant tag.
For example, with this configuration:
sonarrx:
roles: ["", bing, bang, boing]
Running the community sonarrx
tag would produce:
entry | Container | Config dir | Subdomain | Note |
---|---|---|---|---|
"" | sonarr | /opt/sonarr |
sonarr.YOURDOMAIN.TLD | Replaces the stock container |
bing | sonarrbing | /opt/sonarrbing |
sonarrbing.YOURDOMAIN.TLD | |
bang | sonarrbang | /opt/sonarrbang |
sonarrbang.YOURDOMAIN.TLD | |
boing | sonarrboing | /opt/sonarrboing |
sonarrboing.YOURDOMAIN.TLD |
NOTE: the names have to be compliant with both domain names and docker names, so no funny business. Do not use anything but a-z and 0-9, no spaces, no commas, no colons, no dash, no exclamation marks, no nothing!
The names, within the constraints above, are completely arbitrary. There is nothing magic about the example configs [1080webdl, 1080remux] given below. They represent some common use cases, but you can use whatever names you wish, as in the "bing, bang, boing" examples above.
You will need to configure these new containers just as you did the stock containers. One change; be sure each one gets a unique download category, so that each instance imports only those downloads meant for it.
Also, you probably want to put some thought into the directory and library structure you want to use. See "Customizing Plex Libraries".
The example above shows a ""
config entry. For those apps which are also found in the stock cloudbox install, this will overwrite the existing container. Then, when you rerun the cloudbox tag, this container will get overwritten by the stock one again. You probably don't want that.
For one thing, these "arrX" roles may be based on different images than the stock images. For example, for a while the radarrx
role installed Radarr v3 while the stock role installed v2. You should pick one: use this role to replace the stock one, or not.
You probably want to overwrite your existing role with this one; that will ensure that all your instances of Sonarr are based on the same image and get updated in the same way. It's up to you, though, how you want to manage them.
- Include a
""
entry in the config:sonarrx: roles: ["", bing, bang, boing]
- Run the role as described below.
cd ~/community sudo ansible-playbook community.yml --tags sonarrx
- Add the tag to the
[skip]
section in~/cloudbox/ansible.cfg
:[tags] skip = sonarr,whatever,whatever
That will ensure that the stock sonarr
tag doesn't overwrite the container you are creating here.
When you want to update Sonarr, you'll run the Community sonarrx
tag instead.
The same thing holds for every arrX
variant discussed here.
- Make sure there IS NOT a
""
entry in the config:sonarrx: roles: [bing, bang, boing]
That's all. Your existing sonarr
container will not be touched.
Again, the same thing holds for every arrX
variant discussed here.
You'll note that there are only three variants specifically discussed below, and more than 3 variants in the table above.
The variants from above which are on the develop
branch are not discussed in this article. However, the keen eye will discern that the three sets of instructions below are identical in every way but role name, so one should be able to extrapolate how those develop
roles may work. If not, perhaps skip installing those things for now.
-
Edit
settings.yml
and change the sonarrx roles to what you want:I want to add a 4K version and leave my existing container untouched.
sonarrx: roles: [ 4k ]
I want to add webdl and remux versions and leave my existing container untouched.
sonarrx: roles: [ 1080webdl, 1080remux ]
I want to replace my existing version and add reality and kids versions.
sonarrx: roles: [ "", reality, kids ]
Refer to the notes above about overwriting the default container.
-
Run the sonarrx role as a normal community role.
cd ~/community sudo ansible-playbook community.yml --tags sonarrx
Remember that all those names are arbitrary and purely cosmetic for your own use. There is nothing that ties sonarrkids.YOURDOMAIN.TLD
to kids' movies aside from the configuration that you are going to give it.
-
Edit
settings.yml
and change the radarrx roles to what you want:I want to add a 4K version and leave my existing container untouched.
radarrx: roles: [ 4k ]
I want to add webdl and remux versions and leave my existing container untouched.
radarrx: roles: [ 1080webdl, 1080remux ]
I want to replace my existing version and add reality and kids versions.
radarrx: roles: [ "", reality, kids ]
Refer to the notes above about overwriting the default container.
-
Run the radarrx role as a normal community role.
cd ~/community sudo ansible-playbook community.yml --tags radarrx
Remember that all those names are arbitrary and purely cosmetic for your own use. There is nothing that ties radarrkids.YOURDOMAIN.TLD
to kids' movies aside from the configuration that you are going to give it.
-
Edit
settings.yml
and change the bazarrx roles to what you want:I want to add a 4K version and leave my existing container untouched.
bazarrx: roles: [ 4k ]
I want to add webdl and remux versions and leave my existing container untouched.
bazarrx: roles: [ 1080webdl, 1080remux ]
I want to replace my existing version and add reality and kids versions.
bazarrx: roles: [ "", reality, kids ]
Refer to the notes above about overwriting the default container.
-
Run the bazarrx role as a normal community role.
cd ~/community sudo ansible-playbook community.yml --tags bazarrx
Remember that all those names are arbitrary and purely cosmetic for your own use. There is nothing that ties bazarrkids.YOURDOMAIN.TLD
to kids' movies aside from the configuration that you are going to give it.
-
Edit
settings.yml
and change the bazarrx roles to:bazarrx: roles: [""]
-
Run the bazarrx role as a normal community role.
cd ~/community sudo ansible-playbook community.yml --tags bazarrx
-
Refer to the first example under the "Multiple Radarr/Sonarr" sections above.
-
Containers should be up and running again. With the same paths as were setup with CB, i.e. your data will have been migrated over if you had the original "radarrx" and "sonarrx" installed.
If you use NZBHydra2 as an indexer in Radarr create a duplicate entry with caching enabled as an additional parameter. Repeat for Sonarr.
During the initial install of Bazarr, use either of the following setups to set up Sonarr and Radarr
- Hostname or IP Address: name of your Radarr/Sonarr container
- Listening port: 8989
- Base URL: empty
- SSL Enabled: no
- API Key: API Key retrieved from Sonarr/Radarr settings -> general
- Hostname or IP Address: full domain of your Radarr/Sonarr instance, do not specify https (e.g., sonarr.example.com)
- Listening port: 443
- Base URL: empty
- SSL Enabled: yes
- API Key: API Key retrieved from Sonarr/Radarr settings -> general
The latter may be simpler if you are configuring multiple BazarrX instances connected to multiple RadarrX/SonarrX instances, since you won't need to gather the ports for each individual instance.
- airdcpp
- Airsonic
- alltube
- always
- amongus
- Apprise
- archivebox
- arrX (SonarrX, RadarrX, BazarrX)
- AssHama
- autoscan
- Bazarrx
- Beets
- Bitwarden
- Booksonic
- Bookstack
- btrfsmaintenance
- calibre-web
- calibre
- Coder
- comicstreamer
- comixed
- couchpotato
- Dashmachine
- deemix
- deezloader-remix
- Deluge
- DelugeVPN
- Drive STRM
- eBooks: Calibre and Calibre web
- emby2
- embystat
- EPMS
- Filebot
- Filebrowser
- filezilla
- FlareSolverr
- Funkwhale
- Gazee
- Gitea
- Glances
- Goplaxt
- gotify
- grafana
- Guacamole
- Handbrake
- Heimdall
- Hetzner NFS VLAN
- influxdb
- InvoiceNinja
- JDownloader2
- Jellyfin
- Jirafeau
- KCPTUN
- Kitana
- komga
- Krusader
- LazyLibrarian
- lidarrx
- Logarr
- Mango
- Mediabutler
- medusa
- Mellow
- Minecraft
- Monitorr
- Mylar
- mylar3
- navidrome
- Nextcloud
- NowShowing
- NZBHydra (v1)
- ombix
- Organizr (v1)
- ouroboros
- overseerr
- paperless-ng
- plex2
- Pyload
- qBittorrent
- qbittorrentvpn
- Quassel
- RadarrX
- redbot
- requestrr
- requestrrx
- resilio-sync
- rocketchat
- sickchill
- searx
- SonarrX
- Speedtest
- SSHswifty
- stash
- Subsonic
- SyncLounge
- Tdarr
- telegraf
- Telly
- TheLounge
- transmissionvpn
- transmissionx
- ubooquity
- Unifi
- unmanic
- Varken
- vnstat
- wallabag
- Watchtower
- Wordpress
- Xteve
- ZNC
- Custom python plexlibrary libraries
- Speed up Plex / Emby / Jellyfin
- Tautulli Custom Scripts
- Plex Scanners and Agents