From 676f8bbfbcb965a595ed105e5327211f1617761d Mon Sep 17 00:00:00 2001 From: Tanguy Herbron Date: Tue, 25 May 2021 11:04:24 +0200 Subject: [PATCH] Update README with proper instructions --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index da021c6..35b2ef2 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ # Torrent stack ## Usage -Game server for the Minecraft game. It includes configurations for server optimization and quality of life. The repository also contains the map, which can be downloaded separately and used independently. -Set of services to search through, sort and download torrents. Everything can be configured through an individual web UI. +Torrent downloading stack, supporting movie and tv show automatic downloads. It is meant to give an easy to use, highly configuration interface to pick and download various media, through a large variety of torrent providers. | Service | WebUI | Usage | | ------- | ----- | ----- | @@ -14,14 +13,15 @@ Set of services to search through, sort and download torrents. Everything can be Do deploy this instance, you only need to install `docker-compose` and `docker`. ## Installation -To deploy a copy of this instance, you might want to modify where the volumes are pointing to. -Then run +Before deploying this services, you will want to copy `.env.sample` into `.env` and update the file accordingly. ``` -docker-compose up -d +./start.sh ``` All necessary images should be downloaded automatically and the service should be started in the background. ## Wireguard configuration The stack needs a wireguard connection by default, please follow the offical wireguard configuration to connect to your desired server. + +The docker container will create a configuration directory by default when first booted but that will NOT INCLUDE the wireguard configuration file. To have wireguard properly running, put a properly configured `wg0.conf` into the wireguard configuration directory.