From 7bc08c3358db5ca0caf6c678d6441b857ae5a640 Mon Sep 17 00:00:00 2001 From: Matthew Faltys Date: Thu, 6 Jul 2017 13:35:21 -0500 Subject: [PATCH] Update documentation --- readme.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/readme.md b/readme.md index 4647b06..57e4871 100644 --- a/readme.md +++ b/readme.md @@ -10,6 +10,7 @@ In theory this will support any VPN that uses openvpn and a basic auth file. The quickest way to get going to by pulling the docker image from dockerhub. The image name is `unixvoid/seedpod` and can be found [here](https://hub.docker.com/r/unixvoid/seedpod/). You will need (at minimum) a PIA credentials file that we will be linking into the container. This credentials file will allow openvpn to run in the background of the image so all information going in and out will be private. +#### Configuring - **Credentials**: you will need to link in a credentials file (see below for the recommended run command) named `creds.x` into `/openvpn/` in the container. The formatting for the credentials file is simple, first line is the username, second is the password. Example: ``` p1122334 @@ -17,7 +18,7 @@ You will need (at minimum) a PIA credentials file that we will be linking into t ``` - **Config**: you can optionally supply an openvpn configuration file if you are using a VPN that support openvpn. Just place the configuration file (named `config.ovpn`) into the container at `/openvpn/`. -### Running +#### Running ``` sudo docker run \ -d \ @@ -33,7 +34,7 @@ sudo docker run \ ``` Please note the use of `--cap-add=NET_ADMIN`, `--cap-add=NET_RAW`, `--device=/dev/net/tun`. These are needed by the image to create the VPN connection properly. Without these arguments the container will not be able to connect to the VPN. -### Accessing +#### Accessing Once you have started the container is accessable on port 9091 with the following credentials: - user: `admin` - pass: `password`