From f5919d0aabc174c6e5446bc1d4b19903d3f86927 Mon Sep 17 00:00:00 2001 From: Quentin McGaw Date: Mon, 29 Oct 2018 17:03:24 +0100 Subject: [PATCH] Readme update --- README.md | 16 ++++------------ 1 file changed, 4 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 82e67709..005045ae 100644 --- a/README.md +++ b/README.md @@ -62,21 +62,18 @@ It is based on: insmod /lib/modules/tun.ko ``` - Or ```bash sudo modprobe tun ``` - 1. Create a network to be used by this container and other containers connecting to it with: ```bash docker network create pianet ``` - 1. Create a file *auth.conf* in `./`, with: - On the first line: your PIA username (i.e. `js89ds7`) - On the second line: your PIA password (i.e. `8fd9s239G`) @@ -89,24 +86,19 @@ It is based on: qmcgaw/private-internet-access ``` - or use [docker-compose.yml](https://github.com/qdm12/private-internet-access-docker/blob/master/docker-compose.yml) with: - ```bash docker-compose up -d ``` - Note that you can change `REGION`, `PROTOCOL` and `ENCRYPTION`, see the [Environment variables section](#environment-variables) - 1. Wait about 5 seconds for it to connect to the PIA server. You can check with: ```bash docker logs -f pia ``` - 1. Follow the [**Testing section**](#testing) ## Testing @@ -223,10 +215,10 @@ For more containers, add more `--link pia:xxx` and modify *nginx.conf* according ## TODOs - [ ] Iptables should change after initial ip address is obtained -- More checks for environment variables provided -- Add checks when launching PIA $? -- VPN server for other devices to go through the tunnel +- [ ] More checks for environment variables provided +- [ ] Add checks when launching PIA $? +- [ ] VPN server for other devices to go through the tunnel ## License -This repository is under an [MIT license](https://github.com/qdm12/REPONAME_GITHUB/master/license) +This repository is under an [MIT license](https://github.com/qdm12/private-internet-access-docker/master/license)