From 8d3afb18d7918e62b7128191ddd3fab39f2434bc Mon Sep 17 00:00:00 2001 From: Jean Froment Date: Sun, 3 Mar 2019 21:27:59 +0100 Subject: [PATCH] Update README.md --- README.md | 32 ++++++++++++++++++++------------ init-traefik.sh => init.sh | 2 +- 2 files changed, 21 insertions(+), 13 deletions(-) rename init-traefik.sh => init.sh (61%) diff --git a/README.md b/README.md index 615679a..a9e1d6f 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,23 @@ # Seedbox + A collection of Dockerfiles and a docker-compose configuration to set up a seedbox and personal media server. ## Included Applications + | Application | Web Interface | -----------------------|----------------------------| | Plex | plex.yourdomain.com | | Deluge | deluge.yourdomain.com | | Sonarr | sonarr.yourdomain.com | | Radarr | radarr.yourdomain.com | -| Bazaar | bazaar.yourdomain.com | +| Bazarr | bazarr.yourdomain.com | | Jackett | jackett.yourdomain.com | | JDownloader | jdownloader.yourdomain.com | | Tautulli (plexPy) | tautulli.yourdomain.com | | NextCloud | nextcloud.yourdomain.com | | Portainer | portainer.yourdomain.com | +| Netdata | netdata.yourdomain.com | The front-end reverse proxy (Traefik) routes based on the lowest level subdomain (e.g. `deluge.example.com` would route to deluge). Since this is how the router @@ -28,40 +31,45 @@ Note: Plex is also available directly through the `32400` port without going through the reverse proxy. ## Dependencies + - [Docker](https://github.com/docker/docker) >= 1.13.0 + Install guidelines for Ubuntu 16.04: https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-on-ubuntu-16-04 - [Docker Compose](https://github.com/docker/compose) >=v1.10.0 + Install guidelines for Ubuntu 16.04: https://www.digitalocean.com/community/tutorials/how-to-install-docker-compose-on-ubuntu-16-04 - [local-persist Docker plugin](https://github.com/CWSpear/local-persist): installed directly on host (not in container). This is a volume plugin that extends the default local driver’s functionality by allowing you specify a mountpoint anywhere on the host, which enables the files to always persist, even if the volume is removed via `docker volume rm. Use *systemd* install for Ubuntu 16.04. +## Configuration + Before running, please create the volumes which will be statically mapped to the ones on the host: + ```sh -$ sudo su -c "cd /; mkdir data; cd data; mkdir config; mkdir torrents" -$ sudo ./init-traefik.sh +sudo su -c "mkdir /data && mkdir /data/config && mkdir /data/torrents"" +./init.sh ``` -## Running +Edit the `.env` file and change the variables as desired. +The variables are all self-explanatory. +Sames goes for `open-tunnel.sh` script to open a tunnel with port forwarding in order to access Plex Tools directly in your browser. (documentation needs to be updated - for now just install manually Plex Tools) + +## Running & updating + ```sh -$ ./update-all.sh +./update-all.sh ``` + 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. -## Configuration -Copy the `.env.sample` file to `.env` and change the variables as desired. -The variables are all self-explanatory. -Sames goes for `tunnel-options.sh.sample` which will enable the `open-tunnel.sh` -script to open a tunnel with port forwarding in order to access Plex Tools directly in -your browser. - ## PlexPass + Just set the `VERSION` environment variable to `latest` on the Plex service (enabled by default). See https://hub.docker.com/r/linuxserver/plex. ## 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. diff --git a/init-traefik.sh b/init.sh similarity index 61% rename from init-traefik.sh rename to init.sh index a9cc20e..75d8db1 100755 --- a/init-traefik.sh +++ b/init.sh @@ -1,6 +1,6 @@ #!/bin/bash -touch /opt/traefik/acme.json && chmod 600 /opt/traefik/acme.json +sudo touch /opt/traefik/acme.json && sudo chmod 600 /opt/traefik/acme.json cp .env.sample .env cp tunnel-options.sh.sample tunnel-options.sh echo "Please edit .env file and tunnel-options.sh"