Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/master-hax/compose-downloadsquad
a multi-container application to run a VPN protected download pod
https://github.com/master-hax/compose-downloadsquad
docker docker-compose downloadsquad firewall gluetun lidarr openvpn prowlarr radarr readarr rtorrent socket sonarr torrent unix unix-domain-socket vpn wireguard
Last synced: 1 day ago
JSON representation
a multi-container application to run a VPN protected download pod
- Host: GitHub
- URL: https://github.com/master-hax/compose-downloadsquad
- Owner: master-hax
- Created: 2022-11-14T06:35:16.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-04-09T07:27:37.000Z (over 1 year ago)
- Last Synced: 2023-09-09T05:27:03.598Z (about 1 year ago)
- Topics: docker, docker-compose, downloadsquad, firewall, gluetun, lidarr, openvpn, prowlarr, radarr, readarr, rtorrent, socket, sonarr, torrent, unix, unix-domain-socket, vpn, wireguard
- Language: HTML
- Homepage:
- Size: 68.4 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# compose-downloadsquad
a multi-container docker application to run an automated download pod, aptly named downloadsquad.
dark mode:
light mode:
contains the following in a single compose file:
1. wireguard ([linuxserver/docker-wireguard](https://github.com/linuxserver/docker-wireguard)) but any VPN tunnel can be used like [qdm12/gluetun](https://github.com/qdm12/gluetun) or [dperson/openvpn-client](https://github.com/dperson/openvpn-client)
1. rtorrent behind the VPN container ([crazy-max/docker-rtorrent-rutorrent](https://github.com/crazy-max/docker-rtorrent-rutorrent))
1. prowlarr behind the VPN container ([linuxserver/docker-prowlarr](https://github.com/linuxserver/docker-prowlarr))
1. radarr ([linuxserver/docker-radarr](https://github.com/linuxserver/docker-radarr))
1. lidarr ([linuxserver/docker-lidarr](github.com/linuxserver/docker-prowlarr))
1. sonarr ([linuxserver/docker-sonarr](https://github.com/linuxserver/docker-sonarr))
1. readarr ([linuxserver/docker-readarr](https://github.com/linuxserver/docker-readarr))
features:
1. unix domain sockets for secure & efficient communicate around the VPN, without having to use the hacky docker links approach
1. all containers accessible from a single port, without having to use URL redirects
1. simple web UI with status indicators & dark mode support
## how to set it up
1. clone this repo
1. configure the VPN tunnel (wg0.conf into ./wireguard or use a different tunnel entirely)
1. run docker-compose up
## how to use it
the web UIs of all containers is accessible at port 80, depending on what hostname is passed in the HTTP request.
add the following line to your hosts file to access the web UI easily (using the IP address of your docker host):
```
127.0.0.1 downloadsquad rtorrent.downloadsquad sonarr.downloadsquad lidarr.downloadsquad readarr.downloadsquad radarr.downloadsquad prowlarr.downloadsquad
```
then you can visit the following in your browser to access the service status page:
* [http://downloadsquad](http://downloadsquad) (or [http://downloadsquad.](http://downloadsquad.) if you are on Windows, note the trailing dot)
individual service can be accessed at the following URLs:
* [http://rtorrent.downloadsquad](http://rtorrent.downloadsquad)
* [http://prowlarr.downloadsquad](http://rtorrent.downloadsquad)
* [http://radarr.downloadsquad](http://rtorrent.downloadsquad)
* [http://lidarr.downloadsquad](http://rtorrent.downloadsquad)
* [http://sonarr.downloadsquad](http://rtorrent.downloadsquad)
* [http://readarr.downloadsquad](http://rtorrent.downloadsquad)
give it 30 seconds or so for the individual services to start up
notes:
* all containers are visible to each other as "localhost"
* make sure you are using http (no s)
* you will likely want to set up port forwarding on the VPN tunnel container for rtorrent if not using Wireguard
* this project runs out of the box but make sure you change the volumes to persistent ones if you want to use it long term
* make sure to test that prowlarr & rtorrent are behind the VPN by running `docker exec -it compose-downloadsquad-rtorrent-1 curl api.ipify.org` & `docker exec -it compose-downloadsquad-prowlarr-1 curl api.ipify.org`
* test to make sure e.g. sonarr is not behind the VPN `docker exec -it compose-downloadsquad-sonarr-1 curl api.ipify.org`
optional:
* consider locking the docker image versions to specific versions rather than "latest" for supply chain security/consistency.
## how it works
we only want to pass `rtorrent` & `prowlarr` through the VPN, but they still need to communicate with containers outside the VPN. So we use [unix domain sockets](https://en.wikipedia.org/wiki/Unix_domain_socket) on a temporary docker volume for secure & efficient communication around the VPN + 2 instances of nginx to proxy requests through them.
the security of this project has not been verified. please do not use it for anything important without double-checking it yourself.
## related projects
[master-hax/compose-wireguard-ipfs](https://github.com/master-hax/compose-wireguard-ipfs) - a similar project for IPFS instead of bittorrent
[master-hax/uds-proxy-mod](https://github.com/master-hax/uds-proxy-mod) - an s6 based docker mod to proxy requests through unix domain sockets