seedbox/README.md

3.8 KiB
Raw Blame History

Seedbox

A collection of Dockerfiles and a docker-compose configuration to set up a seedbox and personal media server.

Credits

Main credits go to Kelvin Chen who started the development of its own seedbox using Docker. Mine was first a fork of Kelvin's one, but I made some serious changes in the code and plan to add even more tools and services that keeping this project as a fork started to have less sense as code diverged.

Accessing a Service's Web Interface

Go to x.hostname where x is the service you want to access. Included services are:

  • deluge
  • sonarr
  • jackett (included in the sonarr image)
  • plex
  • h5ai (service accessible via explore.hostname)
  • radarr

The front-end reverse proxy routes based on the lowest level subdomain (e.g. deluge.example.com would route to deluge). Since this is how the router works, it is recommended for you to get a top level domain. If you do not have one, you can edit your domains locally by changing your hosts file or use a browser plugin that changes the host header.

Note: Plex is also available directly through the 32400 port without going through the reverse proxy. You will have to sign in with your plex.tv account if you do this.

Dependencies

Before running, please create the volumes which will be statically mapped to the ones on the host:

$ sudo su -c "cd /; mkdir data; cd data; mkdir config; mkdir torrents"

Running

$ docker-compose pull
$ docker-compose up -d

docker-compose should manage all the volumes and network setup for you. If it does not, verify that your docker and docker-compose version is updated.

Make sure you install the dependencies and finish configuration before doing this.

You may optionally build the images yourself instead of pulling by running ./build-all.sh.

Configuration

Copy the config.default file to config and change the variables as desired. The variables are all self-explanatory.

If you want to enable SSL, you would need to have your certificate and key be at /config/frontend/ssl.crt and /config/frontend/ssl.key respectively. The frontend image includes a command ssl-gen to automatically create self signed certificates for you.

PlexPass

If you own PlexPass, you can get the docker image to auto-update to the latest PlexPass version when the container starts up. This is arguably bad docker practice since containers are supposed to be immutable, but in this case, I think the convenience outweighs that. All you have to do is set the PLEX_EMAIL and PLEX_PASSWORD variables in the config file.

Where is my data?

All data is saved in the docker volumes seedbox_config or seedbox_torrents. These volumes are mapped to the config and torrents folders located in /data on the host. You can change these static paths in the docker-compose.yml file. Thanks to the local-persist Docker plugin, the data located in these volumes is persistent, meaning that volumes are not deleted, even when using the docker-compose down command. It would be a shame to loose everything by running a simple docker command ;-)