miegl/glorytun
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update wiki 

Signed-off-by: Adrien Gallouët <adrien@gallouet.fr>
Adrien Gallouët
2020-03-27 13:22:53 +00:00
parent 62fc2e4d7b
commit 8bebb054e0
3 changed files with 40 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
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).

28
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!

4
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 <WAN_IFACE> -s 10.0.1.2 -j MASQUERADE