Skip to content

Commit

Permalink
improved documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
MatthiasLohr committed Sep 6, 2018
1 parent 8653b64 commit 227d0a4
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 4 deletions.
1 change: 0 additions & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,3 @@ RUN mkdir -p /tmp/f5fpc && \

ADD ./files/opt/* /opt/

CMD /opt/run.sh
2 changes: 2 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@

.PHONY: default

default:
docker build -t matthiaslohr/f5fpc .
41 changes: 38 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -26,7 +60,7 @@ Simple run:
./f5fpc-client.py <VPN_HOST> <USER>
```

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 <VPN_HOST> <USER> -n 10.0.0.0/8
```
Expand All @@ -35,3 +69,4 @@ For more information and options see
```
./f5fpc-client.py -h
```

0 comments on commit 227d0a4

Please sign in to comment.