From 3966fbbddf6a83b6df939994f54ea0cb777a06d1 Mon Sep 17 00:00:00 2001 From: vvzvlad Date: Mon, 22 Aug 2022 02:25:26 +0300 Subject: [PATCH] update readme --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 079d51b..692c91e 100644 --- a/README.md +++ b/README.md @@ -1 +1,13 @@ -# trickster-vpn \ No newline at end of file +# Trickster VPN +Trickster VPN is a configuration for WG that allows you to route local (internal to Russia) routes through a local (in-country) server and all other routes through a foreign server. + +You will need two servers: one inside the country (called internal) and one outside the country (called external). +For a test installation just clone the repository, and run the desired bootstrap script: bootstrap_external.sh for the external server, bootstrap_internal.sh for internal, and bootstrap_mobile.sh to show the QR code to connect from a mobile device. +Note that bootstrap scripts use configs with preset encryption keys, which in this case will be the same for all installations: do not use configs with non-default keys for anything except testing! +!!! For production use, generate the keys yourself !!! + + +#TODO +1) Generation of keys by script when running bootstrap script +2) Docker-image +3) Nix-configuration