admin/gluetun
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Readme update

Browse Source
This commit is contained in:
Quentin McGaw
2018-10-29 17:03:24 +01:00
parent 08d1afccfe
commit f5919d0aab
1 changed files with 4 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -62,21 +62,18 @@ It is based on:
insmod /lib/modules/tun.ko insmod /lib/modules/tun.ko
``` ```
Or Or
```bash ```bash
sudo modprobe tun sudo modprobe tun
``` ```
1. Create a network to be used by this container and other containers connecting to it with: 1. Create a network to be used by this container and other containers connecting to it with:
```bash ```bash
docker network create pianet docker network create pianet
``` ```
1. Create a file *auth.conf* in `./`, with: 1. Create a file *auth.conf* in `./`, with:
- On the first line: your PIA username (i.e. `js89ds7`) - On the first line: your PIA username (i.e. `js89ds7`)
- On the second line: your PIA password (i.e. `8fd9s239G`) - On the second line: your PIA password (i.e. `8fd9s239G`)
@@ -89,24 +86,19 @@ It is based on:
qmcgaw/private-internet-access qmcgaw/private-internet-access
``` ```
or use [docker-compose.yml](https://github.com/qdm12/private-internet-access-docker/blob/master/docker-compose.yml) with: or use [docker-compose.yml](https://github.com/qdm12/private-internet-access-docker/blob/master/docker-compose.yml) with:
```bash ```bash
docker-compose up -d docker-compose up -d
``` ```
Note that you can change `REGION`, `PROTOCOL` and `ENCRYPTION`, see the [Environment variables section](#environment-variables) 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: 1. Wait about 5 seconds for it to connect to the PIA server. You can check with:
```bash ```bash
docker logs -f pia docker logs -f pia
``` ```
1. Follow the [**Testing section**](#testing) 1. Follow the [**Testing section**](#testing)
## Testing ## Testing
@@ -223,10 +215,10 @@ For more containers, add more `--link pia:xxx` and modify *nginx.conf* according
## TODOs ## TODOs
- [ ] Iptables should change after initial ip address is obtained - [ ] Iptables should change after initial ip address is obtained
- More checks for environment variables provided - [ ] More checks for environment variables provided
- Add checks when launching PIA $? - [ ] Add checks when launching PIA $?
- VPN server for other devices to go through the tunnel - [ ] VPN server for other devices to go through the tunnel
## License ## 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)