Readme update and typo fixes
This commit is contained in:
@@ -1,6 +1,7 @@
|
|||||||
ARG BASE_IMAGE
|
ARG BASE_IMAGE=alpine
|
||||||
|
ARG ALPINE_VERSION=3.9
|
||||||
|
|
||||||
FROM ${BASE_IMAGE:-alpine}:3.9
|
FROM ${BASE_IMAGE}:${ALPINE_VERSION}
|
||||||
ARG BUILD_DATE
|
ARG BUILD_DATE
|
||||||
ARG VCS_REF
|
ARG VCS_REF
|
||||||
LABEL org.label-schema.schema-version="1.0.0-rc1" \
|
LABEL org.label-schema.schema-version="1.0.0-rc1" \
|
||||||
|
|||||||
36
README.md
36
README.md
@@ -75,7 +75,7 @@
|
|||||||
modprobe tun
|
modprobe tun
|
||||||
```
|
```
|
||||||
|
|
||||||
1. **IF YOU HAVE AN ARM DEVICE, follow the steps** in the [ARM devices section](#arm-devices)
|
1. **IF YOU HAVE AN ARM DEVICE**, follow the steps in the [ARM devices section](#arm-devices)
|
||||||
|
|
||||||
1. Launch the container with:
|
1. Launch the container with:
|
||||||
|
|
||||||
@@ -143,7 +143,7 @@ For containers in the same `docker-compose.yml` as PIA, you can use `network: "s
|
|||||||
|
|
||||||
### Access ports of PIA-connected containers
|
### Access ports of PIA-connected containers
|
||||||
|
|
||||||
1. For example, the following containers are launched connected to PIA:
|
For example, the following containers are launched connected to PIA:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker run -d --name=deluge --network=container:pia linuxserver/deluge
|
docker run -d --name=deluge --network=container:pia linuxserver/deluge
|
||||||
@@ -151,9 +151,12 @@ For containers in the same `docker-compose.yml` as PIA, you can use `network: "s
|
|||||||
```
|
```
|
||||||
|
|
||||||
We want to access:
|
We want to access:
|
||||||
|
|
||||||
- The HTTP web UI of Deluge at port **8112**
|
- The HTTP web UI of Deluge at port **8112**
|
||||||
- The HTTP Web UI of Hydra at port **5075**
|
- The HTTP Web UI of Hydra at port **5075**
|
||||||
|
|
||||||
|
#### With plain Docker
|
||||||
|
|
||||||
1. In this case we use Nginx for its small size. Create `./nginx.conf` with:
|
1. In this case we use Nginx for its small size. Create `./nginx.conf` with:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@@ -195,38 +198,22 @@ For containers in the same `docker-compose.yml` as PIA, you can use `network: "s
|
|||||||
|
|
||||||
For more containers, add more `--link pia:xxx` and modify *nginx.conf* accordingly
|
For more containers, add more `--link pia:xxx` and modify *nginx.conf* accordingly
|
||||||
|
|
||||||
The docker compose file would look like:
|
#### With an external docker-compose
|
||||||
|
|
||||||
|
The docker compose file would look like (see above for *nginx.conf* content):
|
||||||
|
|
||||||
```yml
|
```yml
|
||||||
version: '3'
|
version: '3'
|
||||||
services:
|
services:
|
||||||
pia:
|
|
||||||
image: qmcgaw/private-internet-access
|
|
||||||
container_name: pia
|
|
||||||
cap_add:
|
|
||||||
- NET_ADMIN
|
|
||||||
devices:
|
|
||||||
- /dev/net/tun
|
|
||||||
environment:
|
|
||||||
- USER=js89ds7
|
|
||||||
- PASSWORD=8fd9s239G
|
|
||||||
- PROTOCOL=udp
|
|
||||||
- ENCRYPTION=strong
|
|
||||||
- REGION=CA Montreal
|
|
||||||
- EXTRA_SUBNETS=
|
|
||||||
- NONROOT=
|
|
||||||
restart: always
|
|
||||||
nginx:
|
nginx:
|
||||||
image: nginx:alpine
|
image: nginx:alpine
|
||||||
container_name: pia_proxy
|
container_name: pia_proxy
|
||||||
ports:
|
ports:
|
||||||
|
- 8000:8000/tcp
|
||||||
- 8001:8001/tcp
|
- 8001:8001/tcp
|
||||||
- 8002:8002/tcp
|
|
||||||
links:
|
links:
|
||||||
- pia:deluge
|
- pia:deluge
|
||||||
- pia:hydra
|
- pia:hydra
|
||||||
depends_on:
|
|
||||||
- pia
|
|
||||||
volumes:
|
volumes:
|
||||||
- ./nginx.conf:/etc/nginx/nginx.conf:ro
|
- ./nginx.conf:/etc/nginx/nginx.conf:ro
|
||||||
deluge:
|
deluge:
|
||||||
@@ -245,6 +232,10 @@ services:
|
|||||||
# add more volumes etc.
|
# add more volumes etc.
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### All in one docker-compose
|
||||||
|
|
||||||
|
To be written, see [issue 21](https://github.com/qdm12/private-internet-access-docker/issues/21)
|
||||||
|
|
||||||
## ARM devices
|
## ARM devices
|
||||||
|
|
||||||
- If your architecture is ARMHF (32 bit), run this on your ARM device:
|
- If your architecture is ARMHF (32 bit), run this on your ARM device:
|
||||||
@@ -280,7 +271,6 @@ services:
|
|||||||
## TODOs
|
## TODOs
|
||||||
|
|
||||||
- [ ] SOCKS/HTTP proxy or VPN server for LAN devices to use the container
|
- [ ] SOCKS/HTTP proxy or VPN server for LAN devices to use the container
|
||||||
- [ ] Travis CI for arm images
|
|
||||||
- [ ] Nginx scratch
|
- [ ] Nginx scratch
|
||||||
- [ ] Port forwarding
|
- [ ] Port forwarding
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user