update readme

This commit is contained in:
vvzvlad 2022-08-22 02:25:26 +03:00
parent 2cbb482fd9
commit 3966fbbddf

View File

@ -1 +1,13 @@
# trickster-vpn
# 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