From 227d0a48b55605d9fe29bfc3b270e923b5ae418f Mon Sep 17 00:00:00 2001 From: Matthias Lohr Date: Thu, 6 Sep 2018 09:09:32 +0200 Subject: [PATCH] improved documentation --- Dockerfile | 1 - Makefile | 2 ++ README.md | 41 ++++++++++++++++++++++++++++++++++++++--- 3 files changed, 40 insertions(+), 4 deletions(-) diff --git a/Dockerfile b/Dockerfile index 9df4e03..6d69ae5 100644 --- a/Dockerfile +++ b/Dockerfile @@ -17,4 +17,3 @@ RUN mkdir -p /tmp/f5fpc && \ ADD ./files/opt/* /opt/ -CMD /opt/run.sh diff --git a/Makefile b/Makefile index a205d44..7100c08 100644 --- a/Makefile +++ b/Makefile @@ -1,3 +1,5 @@ +.PHONY: default + default: docker build -t matthiaslohr/f5fpc . diff --git a/README.md b/README.md index ff8248e..9648788 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,57 @@ # F5 VPN client +This Docker image provides the F5 VPN Client, which can be used without local installation. +The docker image allows two operating modes: + +* Using F5 VPN client with local installation like a local installed VPN client. +* Use the running Docker container as router/gateway to avoid VPN split tunneling. + In this mode, the only modification to your local system is a route for your VPN subnets to the running Docker container. + + ## Setup * Install Docker. **Important:** Do **not** use the packages provided by your distribution packages sources. Use the officical resources from docker: https://docs.docker.com/engine/installation/. -* Install required python packages: +* If you want to use the gateway mode: Install required python packages: ``` pip install -r requirements.txt ``` ### Mac -* For automatic route setup on Mac you need to install ```iproute2mac``` via homebrew. +* If you want to use the gateway mode: + For automatic route setup on Mac you need to install ```iproute2mac``` via homebrew. ## Start F5 VPN client +### VPN client mode + +Start the Docker container with the following command: +``` +docker run --name f5fpc --net host -it --rm --privileged matthiaslohr/f5fpc /bin/bash +``` + +Start the VPN client and connect to your VPN server with +``` +f5fpc -s +``` + +Status check: +``` +f5fpc -i +``` + +Disconnect: +``` +f5fpc -o +``` + + +### Gateway mode + There's a wrapper script (```f5fpy-client.py```) which helps to set up the docker container, the VPN connection and the desired network routes. @@ -26,7 +60,7 @@ Simple run: ./f5fpc-client.py ``` -Connect to a VPN network which uses the 10.0.0.0/8 IP range: +Auto route setup for connecting to a VPN network which uses the 10.0.0.0/8 IP range (needs root add/remove routes): ``` sudo ./f5fpc-client.py -n 10.0.0.0/8 ``` @@ -35,3 +69,4 @@ For more information and options see ``` ./f5fpc-client.py -h ``` +