athens-school/Torrent-Stack
4
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

Update README with proper instructions

Browse Source
This commit is contained in:
Tanguy Herbron 2021-05-25 11:04:24 +02:00
parent 08ff527a05
commit 676f8bbfbc
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -1,7 +1,6 @@
# Torrent stack # Torrent stack
## Usage ## 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. 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.
Set of services to search through, sort and download torrents. Everything can be configured through an individual web UI.
| Service | WebUI | Usage | | 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`. Do deploy this instance, you only need to install `docker-compose` and `docker`.
## Installation ## Installation
To deploy a copy of this instance, you might want to modify where the volumes are pointing to. Before deploying this services, you will want to copy `.env.sample` into `.env` and update the file accordingly.
Then run
``` ```
docker-compose up -d ./start.sh
``` ```
All necessary images should be downloaded automatically and the service should be started in the background. All necessary images should be downloaded automatically and the service should be started in the background.
## Wireguard configuration ## Wireguard configuration
The stack needs a wireguard connection by default, please follow the offical wireguard configuration to connect to your desired server. 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.