freifunk/icvpn
8
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

README.md: fix formatting

Browse source
This commit is contained in:
hexa- 2015-04-18 16:43:09 +02:00
parent e3247d7cb5
commit 51582c3185
1 changed files with 19 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
README.md
View file

@ -4,33 +4,39 @@ This repository contains the tinc hosts for ICVPN-Peers and several helper scrip
## Setup ## 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. current pre-release version 1.1pre11 seems to work just fine.
### Clone the repository ### Clone the repository
cd /etc/tinc/ # cd /etc/tinc/
git clone https://github.com/freifunk/icvpn.git # git clone https://github.com/freifunk/icvpn.git
cd icvpn # cd icvpn
cp scripts/post-merge .git/hooks/ # cp scripts/post-merge .git/hooks/
### Create your tinc configuration ### Create your tinc configuration
Open your favorite editor and create the /etc/tinc/icvpn/tinc.conf. Open your favorite editor and create the /etc/tinc/icvpn/tinc.conf.
Name=entenhausen1 Name=entenhausen1
Mode=switch Mode=switch
More options can be found through More options can be found through
man tinc.conf
# man tinc.conf
Afterwards create a keypair with tincd. 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 <code>generate-rsa-keys</code>. Hint: In version 1.1 this option was moved to the tinc binary and is called <code>generate-rsa-keys</code>.
### Execute post-merge hook ### Execute post-merge hook
This step is necessary to populate your new configuration with infos about the metanodes. 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. ### 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 @daily cd /etc/tinc/icvpn/; git pull > /dev/null
## What are meta nodes? ## 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. the `./metanodes` file.
Criteria for the selection of meta nodes are: Criteria for the selection of meta nodes are:
1) autonomous system diversity
2) community diversity 1. autonomous system diversity
3) ample resources (cpu, memory, traffic) 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 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 network graph a direct transfer is possible and will be tried: at first via UDP, then via TCP, then indirectly. While