diff --git a/Mini-HowTo.md b/Mini-HowTo.md index a11fea4..4be0618 100644 --- a/Mini-HowTo.md +++ b/Mini-HowTo.md @@ -1,32 +1,31 @@ -Glorytun does not touch the configuration of its network interface (except for the MTU), -It is up to the user to do it according to the tools available -on his system (systemd-networkd, netifd, ...). +Glorytun does not touch the configuration of its network interface (except for the MTU). +It is up to the user to do it according to the tools available on his system (systemd-networkd, netifd, ...). This also allows a wide variety of configurations. To start a server: - # (umask 066; glorytun keygen > my_secret_key) - # glorytun bind 0.0.0.0 keyfile my_secret_key & + # (umask 066; glorytun keygen > gt.key) + # glorytun bind 0.0.0.0 keyfile gt.key & You should now have an unconfigured network interface (let's say `tun0`). For example, the simplest setup with `ifconfig`: # ifconfig tun0 10.0.1.1 pointopoint 10.0.1.2 up -To check if the server is running, simply call `glorytun show`. -It will show you all of the running tunnels. +To check if the server is running, simply call `glorytun show` or `glorytun show dev tun0` if you have several tunnels started. -To start a new client, you need to get the secret key generated for the server. +To start a new client, you have to get the secret key generated for the server. Then simply call: - # glorytun bind 0.0.0.0 to SERVER_IP keyfile my_secret_key & + # glorytun bind 0.0.0.0 to keyfile gt.key & # ifconfig tun0 10.0.1.2 pointopoint 10.0.1.1 up -Now you have to setup your path, let's say you have an ADSL link that can do 1Mbit upload and 20Mbit download then call: +It's almost done! Now you have to setup your first path. - # glorytun path up LOCAL_IPADDR rate tx 1mbit rx 20mbit +For this, You need the local ip of the interface and the rate (upload and download to your server). +Let's say you have an ADSL link that can do 1Mbit upload and 20Mbit download then call: + + # glorytun path up rate tx 1mbit rx 20mbit 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`. - -If you use systemd-networkd, you can easily setup your tunnels with the helper program `glorytun-setup`.