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

Updated Installation (markdown)

Adrien Gallouët
2020-01-13 10:55:51 +01:00
parent 90c4fdcbf2
commit 62fc2e4d7b
1 changed files with 19 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
Installation.md

@@ -1,16 +1,29 @@
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.
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
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:
$ 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
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
# 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:
$ sudo apt install git make gcc libsodium-dev # debian based
$ sudo yum install git make gcc libsodium-devel # redhat based
To build and install the latest stable version from GitHub:
$ git clone https://github.com/angt/glorytun --recursive --branch stable
$ cd glorytun
$ make
@@ -26,8 +39,4 @@ 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.
On Linux 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 /usr/bin/glorytun