Add README

This commit is contained in:
Otto Seiskari 2018-08-21 22:14:56 +03:00
parent 0b497fed17
commit 27c6d49e2c
1 changed files with 21 additions and 0 deletions

21
README.md Normal file
View File

@ -0,0 +1,21 @@
# Docker VPN browser
Run Firefox and an OpenVPN client inside a Docker container. Firefox starts
without any cookies, history or such.
### Usage
0. Install Docker (v. 1.12 or above, I think)
1. Build Docker image: `./build.sh`
2. (optional) Create a directory `openvpn` and put your `openvpn.conf` there.
Make sure it's called `openvpn.conf` and all extra files it may need are
also in the `openvpn/` directory (this will be mounted in the container)
3. Start container `./run.sh`
Also `ASSERT_COUNTRY=Finland ./run.sh` to check that ifconfig.co thinks that
the your IP address is in a given country before starting Firefox.
### Disclaimer
We can be quite sure that this will stop working (or being even remotely safe
to run) in about 1 to 2 years after the latest commit to this repository.