From 51582c31858f543baf74b8472463d052501c83cc Mon Sep 17 00:00:00 2001 From: hexa- Date: Sat, 18 Apr 2015 16:43:09 +0200 Subject: [PATCH] README.md: fix formatting --- README.md | 31 +++++++++++++++++++------------ 1 file changed, 19 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 71de455..7849425 100644 --- a/README.md +++ b/README.md @@ -4,33 +4,39 @@ This repository contains the tinc hosts for ICVPN-Peers and several helper scrip ## Setup -This network requires the use of the Tinc VPN Daemon. You should use at least version 1.0.24 or higher, als the +This network requires the use of the Tinc VPN Daemon. You should use at least version 1.0.24 or higher, also the current pre-release version 1.1pre11 seems to work just fine. ### Clone the repository - cd /etc/tinc/ - git clone https://github.com/freifunk/icvpn.git - cd icvpn - cp scripts/post-merge .git/hooks/ + # cd /etc/tinc/ + # git clone https://github.com/freifunk/icvpn.git + # cd icvpn + # cp scripts/post-merge .git/hooks/ ### Create your tinc configuration Open your favorite editor and create the /etc/tinc/icvpn/tinc.conf. + Name=entenhausen1 Mode=switch More options can be found through - man tinc.conf + + # man tinc.conf Afterwards create a keypair with tincd. - tincd -n icvpn -K + + # tincd -n icvpn -K Hint: In version 1.1 this option was moved to the tinc binary and is called generate-rsa-keys. ### Execute post-merge hook - This step is necessary to populate your new configuration with infos about the metanodes. - ./git/hooks/post-merge + + # ./git/hooks/post-merge ### Set up a cronjob to update the repository in regular intervals. + # crontab -e +and insert for example + @daily cd /etc/tinc/icvpn/; git pull > /dev/null ## What are meta nodes? @@ -49,9 +55,10 @@ which results in much less strain on the whole network. This is why we now use m the `./metanodes` file. Criteria for the selection of meta nodes are: -1) autonomous system diversity -2) community diversity -3) ample resources (cpu, memory, traffic) + +1. autonomous system diversity +2. community diversity +3. ample resources (cpu, memory, traffic) When data needs to be transferd between two nodes, this will happen indepently of those meta nodes. Through the shared network graph a direct transfer is possible and will be tried: at first via UDP, then via TCP, then indirectly. While