From 27c6d49e2c6908c28ace5a7d6d4277afa34507b3 Mon Sep 17 00:00:00 2001 From: Otto Seiskari Date: Tue, 21 Aug 2018 22:14:56 +0300 Subject: [PATCH] Add README --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..fc7cb5a --- /dev/null +++ b/README.md @@ -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.