aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README100
1 files changed, 48 insertions, 52 deletions
diff --git a/README b/README
index 5767598d0..905d97d3b 100644
--- a/README
+++ b/README
@@ -7,13 +7,13 @@ What is GNUnet?
7GNUnet is peer-to-peer framework focusing on security. The first and 7GNUnet is peer-to-peer framework focusing on security. The first and
8primary application for GNUnet is anonymous file-sharing. GNUnet is 8primary application for GNUnet is anonymous file-sharing. GNUnet is
9currently developed by a worldwide group of independent free software 9currently developed by a worldwide group of independent free software
10developers. GNUnet is a part of the GNU project (http://www.gnu.org/). 10developers. GNUnet is a GNU package (http://www.gnu.org/).
11 11
12This is an ALPHA release. There are known and significant bugs as 12This is an ALPHA release. There are known and significant bugs as
13well as many missing features in this release. 13well as many missing features in this release.
14 14
15For a longer description of the GNUnet System see our webpages 15Additional documentation about GNUnet can be found at
16http://www.gnu.org/software/gnunet/ and https://ng.gnunet.org/. 16https://gnunet.org/.
17 17
18 18
19Dependencies: 19Dependencies:
@@ -45,40 +45,41 @@ How to install?
45 45
46The fastest way is to use a binary package if it is available for your 46The fastest way is to use a binary package if it is available for your
47system. For a more detailed description, read the installation 47system. For a more detailed description, read the installation
48instructions on the webpage at https://ng.gnunet.org/installation. 48instructions on the webpage at https://gnunet.org/installation.
49
50GNUnet requires the GNU MP library (http://www.gnu.org/software/gmp/)
51and libgcrypt (http://www.gnupg.org/). You can specify the path to
52libgcrypt by passing "--with-gcrypt=PATH" to configure. You will also
53need either sqlite (http://www.sqlite.org/) or MySQL
54(http://www.mysql.org/).
49 55
50If you install from source, you need to install GNU libextractor first 56If you install from source, you need to install GNU libextractor first
51(download from http://www.gnu.org/software/libextractor/). We also 57(download from http://www.gnu.org/software/libextractor/). We also
52recommend installing GNU libmicrohttpd. Then you can start the actual 58recommend installing GNU libmicrohttpd (download from
53GNUnet compilation process with: 59http://www.gnu.org/software/libmicrohttpd/). Then you can start the
60actual GNUnet compilation process with:
54 61
55$ ./configure --prefix=$HOME --with-extractor=$HOME 62$ ./configure --prefix=$HOME --with-extractor=$HOME
56$ make 63$ make
57# make install 64# make install
58# sudo -u gnunet gnunet-setup # (note: does not yet exist!) 65# sudo -u gnunet mkdir ~/.gnunet/
66# sudo -u gnunet touch ~/.gnunet/gnunet.conf
59# sudo -u gnunet gnunet-arm -s 67# sudo -u gnunet gnunet-arm -s
60 68
61This will compile and install GNUnet to ~/bin/, ~/lib/ and ~/man/. 69This will compile and install GNUnet to $HOME/bin/, $HOME/lib/ and
62gnunet-setup will create the configuration; this step is interactive. 70$HOME/share/ and start the system with the default configuration. It
63You can run gnunet-setup as root for a system-wide installation or as 71is recommended that you add a user "gnunet" to run "gnunet-arm". You
64a particular user to create a personal installation. It is 72can then still run the end-user applications as another user. If you
65recommended that you add a user "gnunet" to run "gnunet-arm". You can
66then still run the end-user applications as another user. If you
67create a user "gnunet", it is recommended that you edit the 73create a user "gnunet", it is recommended that you edit the
68configuration file slightly so that data can be stored in 74configuration file slightly so that data can be stored in
69"/var/lib/gnunet"; you may also want to use "/etc/gnunet.conf" for the 75"/var/lib/gnunet"; you may also want to use "/etc/gnunet.conf" for the
70configuration in this case. 76location of the configuration file in this case.
71 77
72Note that additional, per-user configuration files 78Note that additional, per-user configuration files
73(~/.gnunet/gnunet.conf) need to be created by each user (for example, 79(~/.gnunet/gnunet.conf) need to be created by each user (for example,
74by running gnunet-setup). For more general information about the GNU 80by running gnunet-setup). For more general information about the GNU
75build process read the INSTALL file. 81build process read the INSTALL file.
76 82
77GNUnet requires the GNU MP library (http://www.gnu.org/software/gmp/)
78and libgcrypt. You can specify the path to libgcrypt by passing
79"--with-gcrypt=PATH" to configure. You will also need either sqlite
80(version 3 or higher) or MySQL (version 5.0 or higher).
81
82If you are compiling the code from subversion, you have to run 83If you are compiling the code from subversion, you have to run
83". bootstrap" before ./configure. If you receive an error during the 84". bootstrap" before ./configure. If you receive an error during the
84running of ". bootstrap" that looks like "macro `AM_PATH_GTK' not 85running of ". bootstrap" that looks like "macro `AM_PATH_GTK' not
@@ -91,24 +92,20 @@ $ aclocal -I /usr/local/share/aclocal
91Configuration 92Configuration
92============= 93=============
93 94
94// FIXME: update this section once we have gnunet-setup! GNUnet uses 95GNUnet uses two types of configuration files, one that specifies the
95two types of configuration files, one for the daemon (called 96system-wide defaults (typically located in /usr/share/gnunet/defaults
96gnunetd.conf) and one for each user (gnunet.conf). You can create and 97.conf) and a second one that overrides default values with
97edit these configuration files with the gnunet-setup tool. The 98user-specific preferences. The user-specific configuration file
98defaults that are created the first time you run gnunet-setup are 99should be located in "~/.gnunet/gnunet.conf" or its location can be
99usually ok, you may want to adjust the limitations (space consumption, 100specified by giving the "-c" option to the respective GNUnet
100bandwidth, etc.) though. The configuration files are human-readable; 101application.
101GNUnet's configuration is typically located at
102"~/.gnunet/gnunet.conf".
103 102
104You MUST create "~/.gnunet/gnunet.conf" explicitly before starting 103The defaults that are shipped with the installation are usually ok,
105GNUnet, and the recommended way to do this is to run gnunet-setup. 104you may want to adjust the limitations (space consumption, bandwidth,
106You can also create an empty configuration file, in which case 105etc.) though. The configuration files are human-readable. Note that
107default values will be used for everything. 106you MUST create "~/.gnunet/gnunet.conf" explicitly before starting
108 107GNUnet. You can either copy "defaults.conf" or simply create an empty
109If you want to use a different configuration file, pass the name of 108file.
110the configuration file as an argument with the option "-c" to any
111GNUnet application.
112 109
113 110
114Usage 111Usage
@@ -126,19 +123,19 @@ $ cat $SERVICEHOME/data/hosts/* > the_file
126 123
127and offering 'the_file' via your web server. Alternatively, you can 124and offering 'the_file' via your web server. Alternatively, you can
128run the build-in web server by adding '-p' to the OPTIONS value 125run the build-in web server by adding '-p' to the OPTIONS value
129in the "hostlist" section of gnunet.conf. 126in the "hostlist" section of gnunet.conf and opening the respective
127HTTPPORT to the public.
130 128
131If the solution with the URL is not feasible for your situation, you 129If the solution with the hostlist URL is not feasible for your
132can also add hosts manually. Simply copy the hostkeys to 130situation, you can also add hosts manually. Simply copy the hostkeys
133"$SERVICEHOME/data/hosts/" (where $SERVICEHOME is the directory 131to "$SERVICEHOME/data/hosts/" (where $SERVICEHOME is the directory
134specified in the /etc/gnunet.conf configuration file). 132specified in the gnunet.conf configuration file).
135 133
136Now start the local node using "gnunet-arm -s". GNUnet should run 24/7 if 134Now start the local node using "gnunet-arm -s". GNUnet should run 24/7 if
137you want to maximize your anonymity. 135you want to maximize your anonymity.
138 136
139// FIXME: gnunet-gtk is not yet supported in 0.9.x 137The GTK user interface is shipped separately. After downloading and
140The GTK user interface is shipped separately from GNUnet. After 138installing gnunet-gtk, you can invoke the GUI with:
141downloading and installing gnunet-gtk, you can invoke the GUI with:
142 139
143$ gnunet-gtk 140$ gnunet-gtk
144 141
@@ -202,13 +199,13 @@ Running http on port 80
202======================= 199=======================
203 200
204In order to hide GNUnet's HTTP traffic perfectly, you might consider 201In order to hide GNUnet's HTTP traffic perfectly, you might consider
205running GNUnet's HTTP transport on port 80. However, you should not 202running GNUnet's HTTP transport on port 80. However, we do not
206run GNUnet as root. Instead, forward port 80 to say 8080 with this 203recommend running GNUnet as root. Instead, forward port 80 to say
207command (as root, in your startup scripts): 2048080 with this command (as root, in your startup scripts):
208 205
209# iptables -t nat -A PREROUTING -p tcp -m tcp --dport 80 -j REDIRECT --to-ports 8080 206# iptables -t nat -A PREROUTING -p tcp -m tcp --dport 80 -j REDIRECT --to-ports 8080
210 207
211Then set in the HTTP section of gnunetd.conf the "ADVERTISED-PORT" 208Then set in the HTTP section of gnunet.conf the "ADVERTISED-PORT"
212to "80" and "PORT" to 8080. You can do the same trick for the 209to "80" and "PORT" to 8080. You can do the same trick for the
213TCP and UDP transports if you want to map them to a priviledged 210TCP and UDP transports if you want to map them to a priviledged
214port (from the point of view of the network). 211port (from the point of view of the network).
@@ -227,12 +224,11 @@ P2P over SMTP, read the instructions at http://gnunet.org/smtp.php3
227Stay tuned 224Stay tuned
228========== 225==========
229 226
230* http://www.gnu.org/software/gnunet/ 227* https://gnunet.org/
231* http://gnunet.org/
232* https://gnunet.org/bugs/ 228* https://gnunet.org/bugs/
233* https://ng.gnunet.org/ 229* https://gnunet.org/svn/
230* http://www.gnu.org/software/gnunet/
234* http://mail.gnu.org/mailman/listinfo/gnunet-developers 231* http://mail.gnu.org/mailman/listinfo/gnunet-developers
235* http://mail.gnu.org/mailman/listinfo/help-gnunet 232* http://mail.gnu.org/mailman/listinfo/help-gnunet
236* http://mail.gnu.org/mailman/listinfo/info-gnunet 233* http://mail.gnu.org/mailman/listinfo/info-gnunet
237* http://mail.gnu.org/mailman/listinfo/gnunet-svn 234* http://mail.gnu.org/mailman/listinfo/gnunet-svn
238