add documentation

README.md

@@ -0,0 +1,61 @@
+Installation
+============
+
+Debian/Ubuntu
+-------------
+
+    apt-get install openresolv git tinc
+
+
+Archlinux
+---------
+
+    pacman -S openresolv git tinc
+
+
+Konfiguration
+-------------
+
+* SSH-Schlüssel uns geben oder erstellen, wenn keiner vorhanden ist
+
+    cat ~/.ssh/id_rsa.pub || ssh-keygen -t rsa -b 4096 && cat ~/.ssh/id_rsa.pub
+
+* Wenn der Schlüssel eingetragen im git eingetragen ist, die Konfiguration
+  clonen:
+
+    cd /etc/tinc
+    mkdir closedvpn
+    sudo chown $USER closedvpn
+    git clone git@higgsboson.tk:closedvpn-hosts closedvpn
+
+* Konfiguration anpassen
+
+    cd /etc/tinc/closedvpn
+
+  - in `tinc.conf` <DEIN NAME> durch wiedererkennbaren Server/Rechnernamen
+    ersetzen (Nur Buchstaben, keine Bindestriche)
+  - im Ordner `hosts` eine Datei mit dem gleichen Namen anlegen
+  - in `tinc-up` <DEINE IP> durch eine von uns festgelegte IP ersetzen
+
+* Schlüssel erzeugen
+
+    tinc -n closedvpn -K
+
+Dies erzeugt einen Private-Key in `/etc/tinc/closedvpn/rsa_key.priv` und fügt
+den Public Key an die Datei hosts/<DEIN NAME> an. Die Host-Datei zu git
+hinzufügen:
+
+    git add hosts/<DEIN NAME>
+    git commit -m "Add host <DEIN NAME>"
+
+Wenn wir den Schlüssel hinzugefügt haben, kannst du das vpn zum Testen mit
+folgenden Befehl starten:
+
+    tincd -c /etc/tinc/closedvpn -D
+
+Durch drücken von Strg+C wird die Logausgabe erhöht. Strg+\ beendet das
+Programm.
+
+Wenn alles funktioniert kannst du die Adresse 10.42.16.1 erreichbar sein
+
+    ping 10.42.16.1

tinc-up

@@ -1,6 +1,6 @@
 #!/bin/sh
-ifconfig $INTERFACE 10.42.16.1 netmask 255.255.255.0
-route del -net 10.42.16.0 netmask 255.255.255.0 dev $INTERFACE
+ifconfig $INTERFACE <DEINE IP> netmask 255.255.255.255
+route del -net <DEINE IP> netmask 255.255.255.255 dev $INTERFACE
 route add -net 10.42.0.0 netmask 255.255.0.0 dev $INTERFACE
 
 printf "nameserver 10.42.16.1\ndomain vpn" | resolvconf -a "$INTERFACE.inet"

tinc.conf

@@ -1,4 +1,4 @@
-name = <YOUR NAME>
+name = <DEIN NAME>
 Compression = 9
 ConnectTo = devkid
 ConnectTo = higgsboson