From 99cef5f8b81b7c172710319f4538fe8d00f5d2f4 Mon Sep 17 00:00:00 2001 From: Matthew Faltys Date: Thu, 6 Jul 2017 11:36:04 -0500 Subject: [PATCH] Update documentation --- readme.md | 18 ------------------ 1 file changed, 18 deletions(-) diff --git a/readme.md b/readme.md index 341e708..20068e1 100644 --- a/readme.md +++ b/readme.md @@ -1,21 +1,3 @@ -Seedpod -======= -This project is a rkt pod dedicated to private torrenting. It supports PIA with openvpn to be in a constant VPN connection. When the VPN becomes disconnected for whatever reason, the torrenting stops, in fact the torrent is only allowed to seed/leech if it is inside of the VPN tunnel. - -Quickstart -========== -To quickly get seedpod up and running you will need a PIA openvpn config file (or use default) and your access creds. -In theory this will support any VPN that uses openvpn and a basic auth file. - -* config: place your config in `deps/` full path to the file will be `deps/config.ovpn`. the default openvpn configuration - file is set up to use us-midwest in PIA -* credentials: we link a credential file into the container at build time, add your credentials to this file `deps/creds.x` and they will be - copied in when you build the image. this should be a two lined file, first being your username, second your password. you can link this file - in at runtime as well, just mount it to `/creds.x`. -* running: execute `make build_web` to build the container and `make run` to run the container with the proper run commands. -* accessing: after the server is run, you can access the clutch frontend in your brower on port `9091`. the default user and pass - are `admin` and `password` respectively. - # Seedpod This project is a rkt pod dedicated to private torrenting. It supports PIA with openvpn to be in a constant VPN connection. When the VPN becomes disconnected for whatever reason, the torrenting stops, in fact the torrent is only allowed to seed/leech if it is inside of the VPN tunnel.