From 8bebb054e0263cb49d0a4f7fc681aca9a510436e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adrien=20Gallou=C3=ABt?= Date: Fri, 27 Mar 2020 13:22:53 +0000 Subject: [PATCH] Update wiki MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Adrien Gallouët --- Home.md | 17 +++++++++++++++++ Installation.md | 28 +++++++++++++++++++--------- Mini-HowTo.md | 4 ++++ 3 files changed, 40 insertions(+), 9 deletions(-) diff --git a/Home.md b/Home.md index 28653f7..169458f 100644 --- a/Home.md +++ b/Home.md @@ -2,8 +2,21 @@ Glorytun is a small, simple and secure VPN over [mud](https://github.com/angt/mud). +## Compatibility + +Glorytun only depends on [libsodium](https://github.com/jedisct1/libsodium) version >= 1.0.4. +Which can be installed on a wide variety of systems. + +Linux is the platform of choice but the code is standard so it should be easily ported on other posix systems. +It was successfully tested on OpenBSD, FreeBSD and MacOS. + +IPv4 and IPv6 are supported. +On Linux you can have both at the same time by binding `::`. + ## Features +The key features of Glorytun come directly from mud: + * **Fast and highly secure** Glorytun uses a new and very fast AEAD construction called AEGIS-256 if AES-NI is available otherwise ChaCha20-Poly1305 is used. @@ -32,3 +45,7 @@ Glorytun is a small, simple and secure VPN over [mud](https://github.com/angt/mu As it is critical, Glorytun will try to setup it correctly by guessing its value. It doesn't rely on Next-hop MTU to avoid ICMP black holes. In asymmetric situations the minimum MTU is selected. + +--- + +For feature requests and bug reports, please create an [issue](https://github.com/angt/glorytun/issues). diff --git a/Installation.md b/Installation.md index f061757..af94bab 100644 --- a/Installation.md +++ b/Installation.md @@ -4,22 +4,22 @@ Which can be installed on a wide variety of systems. Linux is the platform of choice but the code is standard so it should be easily ported on other POSIX systems. It was successfully tested on OpenBSD, FreeBSD and MacOS. -# Linux +### Linux Download the binary of the release you want [here](https://github.com/angt/glorytun/releases). -For example if you want to install glorytun 0.2.2 on x86_64: +For example if you want to install glorytun 0.3.4 on x86_64: - $ wget https://github.com/angt/glorytun/releases/download/v0.2.2/glorytun-0.2.2-x86_64-linux-musl.bin - $ chmod +x glorytun-0.2.2-x86_64-linux-musl.bin - $ ./glorytun-0.2.2-x86_64-linux-musl.bin version - 0.2.2 + $ wget https://github.com/angt/glorytun/releases/download/v0.3.4/glorytun-0.3.4-x86_64-linux-musl.bin + $ chmod +x glorytun-0.3.4-x86_64-linux-musl.bin + $ ./glorytun-0.3.4-x86_64-linux-musl.bin version + 0.3.4 It is really easy to get a working glorytun without being root. The only required capability is `CAP_NET_ADMIN`: - $ sudo setcap cap_net_admin=ep glorytun-0.2.2-x86_64-linux-musl.bin version + $ sudo setcap cap_net_admin=ep glorytun-0.3.4-x86_64-linux-musl.bin version -# Unix-like systems or exotic architectures +### Unix-like systems or exotic architectures You will need `git`, `make`, `gcc` (or `clang`) and `libsodium`: To build and install the latest stable version from GitHub: @@ -37,6 +37,16 @@ Finally, to install the stripped binary, call: This will install the stripped binary in `/usr/bin` by default. -As usual you can use options `CC`, `INSTALL`, `prefix` and `DESTDIR` to adapt to your use-cases. +As usual you can use options `CC`, `prefix` and `DESTDIR` to adapt to your use-cases. +### Cross-building a static binary +If you have a specific toolchain, like for example `mips-linux-musl`, +building a static binary is easy as: + + $ git clone https://github.com/angt/glorytun --recursive --branch stable + $ cd glorytun + $ ./sodium.sh mips-linux-musl + $ make X=mips-linux-musl + +Enjoy! diff --git a/Mini-HowTo.md b/Mini-HowTo.md index 4be0618..6d97d8d 100644 --- a/Mini-HowTo.md +++ b/Mini-HowTo.md @@ -29,3 +29,7 @@ Let's say you have an ADSL link that can do 1Mbit upload and 20Mbit download the Again, to check if your path is working, you can watch its status with `glorytun path`. You should now be able to ping your server with `ping 10.0.1.1`. + +A simple IP masquerade on the server side should be enough to give you access to Internet from your tunnel: + + # iptables -w -t nat -A POSTROUTING -o -s 10.0.1.2 -j MASQUERADE