Git Product home page Git Product logo

compose-rr's Introduction

Torrent media library docker-compose file

Disclaimer

I am not responsible for any malicious or illegal use of this configuration, use it at your own risk.

Services

This docker-compose can be used to spin up :

  • A VPN (using gluetun)
  • Jackett for torrent indexing
  • Sonarr and Radarr for automatic management and download
  • Jellyfin to manage the media library
  • qBittorrent for torrent downloading
  • Jellyseer for easier usage

Setup

  1. Run make .env to create the environment files.
  2. If you want to use a VPN, you need to set some variables in vpn.env, you can see gluetun's wiki for reference. For ProtonVPN, for instance :
VPN_SERVICE_PROVIDER=protonvpn
OPENVPN_USER=<user> # from https://account.proton.me/u/0/vpn/OpenVpnIKEv2>
OPENVPN_PASSWORD=<password>
SERVER_COUNTRIES=Netherland
  1. Run make up (or docker-compose up) to spin up the services.
  2. The services can then be managed using docker-compose normally.

Configuration

The services configuration will change depending on whether or not he VPN is used :

  • With the VPN, all services are internally available through localhost
  • Without the VPN, you need to set them up using the name of the services as host

API Keys

You can run make <service>.api-key to retrieve api keys for *rr services and Jackett. For instance, the Radarr API Key is obtainable through make radarr.api-key.

Usage without a VPN

I would recommend using a VPN to avoid issues, such as with your ISP. However, it is possible to use this without a VPN.

To disable it, simply run make vpn.disable then make up to start the services again (they will be automatically stopped beforehand). You can then enable it again using make vpn.enable.

Adding services

Adding a service requires a few modifications :

  • Adding the service itself in the docker-compose file
  • Adding the port to the VPN service
  • Adding the service name to the list of services in the Makefile
  • Creating the corresponding service.env file (this is done automatically by make .env but if the .env file already exists this won't work)

Configuration is then intended through env files, specifically <service>.env

compose-rr's People

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.