Skip to content

Commit

Permalink
improved README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Matthias Lohr committed Jun 9, 2017
1 parent 2d341d8 commit 2d92311
Showing 1 changed file with 11 additions and 22 deletions.
33 changes: 11 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,27 @@

# F5 VPN client

*inspired by https://github.com/brk3/docker-f5fpc*

## General 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 docker-py:
```
pip install docker
```

## Run as router

```
sudo ./f5fpc-client.py
```

## Run image in standalone mode from Dockerhub

```
docker run \
--privileged \
--name f5fpc \
matthiaslohr/f5fpc
```

## Start F5 VPN client

### Useful commands
There's a wrapper script (```f5fpy-client.py```) which helps to set up
the docker container, the VPN connection and the desired network routes.

* Show VPN status
Simple run:
```
docker exec f5fpc f5fpc -i
./f5fpc-client.py <VPN_HOST> <USER>
```

* Show VPN resolv.conf
For more information and options see
```
docker exec f5fpc cat /etc/resolv.conf.fp-tmp
./f5fpc-client.py -h
```

0 comments on commit 2d92311

Please sign in to comment.