Building Docker images for all CPU architectures (#57)

* Created Travis config to build images for all CPU architectures
* Updated readme

.dockerignore

@@ -1,4 +1,9 @@
 .git
+.vscode
 readme
-*.yml
+.gitignore
-*.md
+.travis.yml
+ci.sh
+docker-compose.yml
+LICENSE
+README.md

.travis.yml

@@ -0,0 +1,25 @@
+dist: xenial
+sudo: required
+git:
+  quiet: true
+  depth: 1
+branches:
+  only:
+  - master
+  - xbuild
+env:
+  global:
+    - IMAGE_PATH=qmcgaw/private-internet-access
+    - BASE_TAG=xbuild
+before_install:
+  - curl -fsSL https://get.docker.com | sh
+  - echo '{"experimental":"enabled"}' | sudo tee /etc/docker/daemon.json
+  - mkdir -p $HOME/.docker
+  - echo '{"experimental":"enabled"}' | sudo tee $HOME/.docker/config.json
+  - sudo service docker start
+install:
+  - docker run --rm --privileged multiarch/qemu-user-static --reset -p yes
+  - docker buildx create --name xbuilder --use
+script: bash ci.sh $IMAGE_PATH
+after_success:
+  - curl -X POST https://hooks.microbadger.com/images/qmcgaw/private-internet-access/tQFy7AxtSUNANPe6aoVChYdsI_I= || exit 0

Dockerfile

@@ -1,12 +1,14 @@
 ARG ALPINE_VERSION=3.10
 
 FROM alpine:${ALPINE_VERSION}
+ARG VERSION
 ARG BUILD_DATE
 ARG VCS_REF
+ARG TAG=latest
 LABEL \
     org.opencontainers.image.authors="quentin.mcgaw@gmail.com" \
     org.opencontainers.image.created=$BUILD_DATE \
-    org.opencontainers.image.version="" \
+    org.opencontainers.image.version="$VERSION" \
     org.opencontainers.image.revision=$VCS_REF \
     org.opencontainers.image.url="https://github.com/qdm12/private-internet-access-docker" \
     org.opencontainers.image.documentation="https://github.com/qdm12/private-internet-access-docker" \

README.md

@@ -1,6 +1,8 @@
-# Private Internet Access Client (OpenVPN+Iptables+DNS over TLS on Alpine Linux)
+# Private Internet Access Client
 
-*Lightweight VPN client to tunnel to private internet access servers*
+*Lightweight swiss-knife-like VPN client to tunnel to private internet access servers, using OpenVPN, iptables, DNS over TLS, ShadowSocks, Tinyproxy and more*
+
+**ANNOUCEMENT**: Supports all CPU architectures :art: just pull the image!
 
 [![PIA Docker OpenVPN](https://github.com/qdm12/private-internet-access-docker/raw/master/readme/title.png)](https://hub.docker.com/r/qmcgaw/private-internet-access/)
 
@@ -19,7 +21,7 @@
 [![Image size](https://images.microbadger.com/badges/image/qmcgaw/private-internet-access.svg)](https://microbadger.com/images/qmcgaw/private-internet-access)
 [![Image version](https://images.microbadger.com/badges/version/qmcgaw/private-internet-access.svg)](https://microbadger.com/images/qmcgaw/private-internet-access)
 
-| Image size | RAM usage | CPU usage |
+| Image size (amd64) | RAM usage | CPU usage |
 | --- | --- | --- |
 | 23.3MB | 14MB to 80MB | Low to Medium |
 
@@ -50,7 +52,7 @@
 
     </p></details>
 - Connect other containers to it, [see this](https://github.com/qdm12/private-internet-access-docker#connect-to-it)
-- **ARM** compatible
+- Compatible with amd64, i686 (32 bit), ARM 64 bit, ARM 32 bit v6 and v7, ppc64le and even that s390x 🎆
 - Port forwarding
 - The *iptables* firewall allows traffic only with needed PIA servers (IP addresses, port, protocol) combinations
 - OpenVPN reconnects automatically on failure
@@ -59,7 +61,7 @@
 - OpenVPN can run *without root* but this disallows OpenVPN reconnecting, it can be set with `NONROOT=yes`
 - Connect your LAN devices
   - HTTP Web proxy *tinyproxy*
-  - SOCKS5 proxy *shadowsocks*
+  - SOCKS5 proxy *shadowsocks* (better as it does UDP too)
 
 ## Setup
 
@@ -87,17 +89,6 @@
     modprobe tun
     ```
 
-1. <details><summary>If you have a non-amd64 device (**ARM** etc.), either...</summary><p>
-
-    - **IN PROGRESS** download the slightly slower and larger pre-built Docker image ([why?](https://www.reddit.com/r/docker/comments/c7vo7f/arm_buildx_on_amd64_vs_build_on_arm_device/esk3ejb))
-    - Build the image on your device:
-
-        ```sh
-        docker build -t qmcgaw/private-internet-access https://github.com/qdm12/private-internet-access-docker.git
-        ```
-
-    </p></details>
-
 1. Launch the container with:
 
     ```bash
@@ -118,6 +109,8 @@
     - Use `-p 8388:8388/tcp -p 8388:8388/udp` to access the SOCKS5 proxy (and put your LAN in `EXTRA_SUBNETS` environment variable)
     - Pass additional arguments to *openvpn* using Docker's command function (commands after the image name)
 
+You can update the image with `docker pull qmcgaw/private-internet-access:latest`
+
 ## Testing
 
 Check the PIA IP address matches your expectations
@@ -296,9 +289,9 @@ Note that not all regions support port forwarding.
 
 ## TODOs
 
-- Shadowsocks
+- Golang binary to setup the container at start, and:
-    - Get logs from file and merge with docker stdout
+  - Mix logs of unbound, tinyproxy, shadowsocks and openvpn together somehow
-- Mix Logs of Unbound
+  - support other VPN providers
 - Maybe use `--inactive 3600 --ping 10 --ping-exit 60` as default behavior
 - Try without tun
 

ci.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+
+if [ "$TRAVIS_PULL_REQUEST" = "true" ]; then
+  docker buildx build --platform=$PLATFORMS  .
+  return $?
+fi
+echo $DOCKER_PASSWORD | docker login -u qmcgaw --password-stdin &> /dev/null
+IMAGE_PATH=$1
+TAG="$TRAVIS_BRANCH"
+if [ "$TAG" = "master" ]; then
+  TAG="${TRAVIS_TAG:-latest}"
+fi
+echo "Building Docker images for \"$IMAGE_PATH:$TAG\""
+docker buildx build \
+    --platform=linux/amd64,linux/386,linux/arm64,linux/arm/v7,linux/arm/v6,linux/ppc64le,linux/s390x \
+    --build-arg BUILD_DATE=`date -u +"%Y-%m-%dT%H:%M:%SZ"` \
+    --build-arg VCS_REF=`git rev-parse --short HEAD` \
+    --build-arg VERSION=$TAG \
+    -t $IMAGE_PATH:$TAG \
+    --push \
+    .

hooks/build

@@ -1,5 +0,0 @@
-#!/bin/bash
-
-docker build --build-arg BUILD_DATE=`date -u +"%Y-%m-%dT%H:%M:%SZ"` \
-             --build-arg VCS_REF=`git rev-parse --short HEAD` \
-             -t $IMAGE_NAME .

hooks/post_build

@@ -1,3 +0,0 @@
-#!/bin/bash
-
-curl -X POST https://hooks.microbadger.com/images/qmcgaw/${DOCKER_REPO}/tQFy7AxtSUNANPe6aoVChYdsI_I= || exit 0