aboutsummaryrefslogtreecommitdiff
path: root/src/vpn
diff options
context:
space:
mode:
authorPhilipp Tölke <toelke@in.tum.de>2011-05-04 07:31:04 +0000
committerPhilipp Tölke <toelke@in.tum.de>2011-05-04 07:31:04 +0000
commit9ee83b1cb503a4d604c9ae4f53acfde2e95c1d09 (patch)
treefc9afe28e3a841af5e4c40efdb4bca41c8805095 /src/vpn
parentb0a0cc3b954911a42ffd376b9d84d9536fc82a5c (diff)
downloadgnunet-9ee83b1cb503a4d604c9ae4f53acfde2e95c1d09.tar.gz
gnunet-9ee83b1cb503a4d604c9ae4f53acfde2e95c1d09.zip
begin writing user- and developer-documentation
Diffstat (limited to 'src/vpn')
-rw-r--r--src/vpn/README75
1 files changed, 75 insertions, 0 deletions
diff --git a/src/vpn/README b/src/vpn/README
new file mode 100644
index 000000000..9cc5264c5
--- /dev/null
+++ b/src/vpn/README
@@ -0,0 +1,75 @@
1For Users
2=========
3
4To use the gnunet-vpn you have to have at least the following configuration in
5your ~/.gnunet/gnunet.conf:
6
7#v+
8TODO
9#v-
10
11If you start gnunet now, you will get a new network-interface called
12gnunet-vpn (or however you named it) with the IP addresses you configured. You
13"normal" internet-usage should not be impaired (check that!) but you should be
14able to point your web browser to something like http://gnunet.gnunet/ and the
15the gnunet webpage! That's it, you are set to use gnunet to access legacy
16services!
17
18If you want to offer services such as your webpage vi gnunet you have to have
19a file ~/.gnunet/dns.conf with the following content:
20
21#v+
22TODO
23#v-
24
25Also you will have to configure and start the exit-daemon:
26
27#v+
28TODO
29#v-
30
31Now point you computer (or any other computer in the gnunet) to
32http://yourwebsite.gnunet/ and you will get your website.
33
34Add the following options if you want to resolve DNS-queries for other users
35of gnunet:
36
37#v+
38TODO
39#v-
40
41Add the following options if you want to provide access to your internet
42connection to other users of gnunet:
43
44#v+
45TODO
46#v-
47
48Be aware, that this enables people to use your internet connection for
49nefarious things which might make you liable!
50
51For Developers
52==============
53
54The gnunet-vpn is a combination of three programs:
55
56- gnunet-daemon-vpn opens a tap-interface, configures it and controls the
57 network
58- gnunet-service-dns configures a hijack for outgoing DNS-requests, so that
59 they get sent to gnunet-daemon-vpn, which sends them on to
60 gnunet-service-dns which sends them on, either to their original destination
61 or to gnunet. It also publishes names from dns.conf to the dht.
62- gnunet-daemon-exit takes gets connections from the gnunet and sends them on
63 to the legacy internet.
64
65The gnunet-service-dns decides where to send the query with an easy check:
66
67- it is a query for something.gnunet: it gets sent to the dht
68- it is a query sent to the configured VIRT_DNS: it gets sent on to some other
69 gnunet-service-dns somewhere in the gnunet (anyone having configured
70 DNS_EXIT TODO)
71- else: it gets sent to the original destination
72
73These programs exchange whole TCP- or UDP-packets, they only strip of the
74IP-header. This way gnunet achieves translation between IPv6-services and
75IPv4-clients and vice versa!