mathdatech/Compose-Examples
1
0
Fork 0
mirror of https://github.com/Haxxnet/Compose-Examples synced 2024-11-23 20:11:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Update README.md

Browse Source
This commit is contained in:
LRVT 2024-11-18 12:44:59 +01:00 committed by GitHub
parent f9530ae590
commit e43285a8ed
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
examples/arr-suite/README.md
View File

@ -37,22 +37,19 @@ Docker stack consisting of various arr-services like:
- Bazarr - Bazarr
- Used for subtitles - Used for subtitles
- Flaresolverr - Flaresolverr
- Used to bypass Cloudflare for prowlarr - Used to bypass CloudFlare for indexers on Prowlarr
- You must add it at prowlarr as indexer with the tag `flaresolverr`
- Qbittorrent - Qbittorrent
- Used as download client; run behind gluetun vpn killswitch container - Used as download client; run behind gluetun vpn killswitch container
- A temporary password for the `admin` user will be printed to the container log on startup. Change it immediately to a static one that does not change again.
- Gluetun - Gluetun
- Used for establishing an openvpn/wireguard killswitch vpn connection for qbittorrent - Used to establish a VPN killswitch connection for Qbittorrent to a commercial VPN provider (e.g. Mullvad)
- Requires an active subscription for a vpn provider (e.g. Mullvad) - Emby or Jellyfin
- Emby / Jellyfin - Used to manage your media libraries and stream content from various devices
- Used to manage your media libraries and stream it from various devices
The following bind mount volumes are defined: The following bind mount volumes are defined:
- `/arr-suite/configs/<container-name>` - `/arr-suite/configs/<container-name>`
- holds the config files of an arr container - holds the config files of an arr container
- `/arr-suite/media/<type>` - `/arr-suite/media/<folder>`
- will hold your media files such as movies, music, books, tv-shows, qbittorrent downloads etc. - will hold your media files such as movies, music, books, tv-shows, qbittorrent downloads etc.
## Setup ## Setup
@ -129,6 +126,10 @@ Then head over to `Settings > Downloads` and configure the custom download path
![image](https://github.com/user-attachments/assets/5c7531eb-2cd7-4b16-968d-32a00cc4020a) ![image](https://github.com/user-attachments/assets/5c7531eb-2cd7-4b16-968d-32a00cc4020a)
#### Indexers
Add your preferred indexers such as 1337X and many others. Do not forget to add the `flaresolverr` tag to bypass CloudFlare.
### Sonarr, Radarr, Lidarr, Readarr, Bazarr ### Sonarr, Radarr, Lidarr, Readarr, Bazarr
All other arr applications follow the same configuration steps. All other arr applications follow the same configuration steps.
@ -139,9 +140,8 @@ Follow these steps for each individuall arr container:
2. Ensure to define your media location. Can be done regularly via `Settings > Media Management > Root Folders > Path`. Should point to `/media/music` for Lidarr, `/media/tv-shows` for Sonarr, `/media/movies` for Radarr and `/media/books` for Readarr and so on. If those subdirectories do not exist yet, go ahead and create them via the following command: 2. Ensure to define your media location. Can be done regularly via `Settings > Media Management > Root Folders > Path`. Should point to `/media/music` for Lidarr, `/media/tv-shows` for Sonarr, `/media/movies` for Radarr and `/media/books` for Readarr and so on. If those subdirectories do not exist yet, go ahead and create them via the following command:
- `mkdir -p /mnt/docker-volumes/arr-suite/media/{downloads,movies,tv-shows,music,books}` - `mkdir -p /mnt/docker-volumes/arr-suite/media/{downloads,movies,tv-shows,music,books}`
4. Configure Qbittorrent as download client. Can be done regularly via `Settings > Download Clients`. Define your server's IP address at `Host` (or the container name `arr-suite-gluetun`) and `8080` at `Port`. 4. Configure Qbittorrent as download client. Can be done regularly via `Settings > Download Clients`. Define your server's IP address at `Host` (or the container name `arr-suite-gluetun`) and `8080` at `Port`.
5. Configure your quality definitions and indexers (optional) 5. Configure Bazarr for Radarr and Sonarr. See https://wiki.bazarr.media/Getting-Started/Setup-Guide/
6. Configure Bazarr for Radarr and Sonarr. See https://wiki.bazarr.media/Getting-Started/Setup-Guide/ 6. Fix all `System > Health` warnings and errors reported by each arr container. May refer to https://wiki.servarr.com/.
7. Fix all `System > Health` warnings and errors reported by each arr container. May refer to https://wiki.servarr.com/.
- Sonarr is accessible at `http://<YOUR-IP>:8989/` - Sonarr is accessible at `http://<YOUR-IP>:8989/`
- Radarr is accessible at `http://<YOUR-IP>:7979/` - Radarr is accessible at `http://<YOUR-IP>:7979/`