seedbox/README.md

57 lines
1.9 KiB
Markdown

# Seedbox
A collection of Dockerfiles and docker-compose configuration to set up a
seedbox.
## Accessing the available WebUIs
Go to `X.domain` where `X` is the item you want to access.
Included items are:
- rtorrent
- sickrage
- syncthing
- plex
The front-end reverse proxy routes based on the lowest level subdomain (e.g.
`rtorrent.example.com` would route to rtorrent). 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.
## Running
```sh
$ docker-compose pull
$ docker-compose --x-networking up -d
```
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`.
## Dependencies
- [Docker](https://github.com/docker/docker)
- [Docker Compose](https://github.com/docker/compose)
## 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.
## Where is my data?
All data are saved in the docker volumes `seedbox_config` or
`seedbox_torrents`.
## OpenVPN
The OpenVPN container generates a single client key/cert pair by default.
Run the `create-client CLIENT_NAME` tool in the openvpn container to generate
the openvpn file. e.g. `create-client client >> client.ovpn`. You can transfer
the file back using syncthing or scp. You can also create more certs by using
easy-rsa.