aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README45
1 files changed, 17 insertions, 28 deletions
diff --git a/README b/README
index 84330e2ab..8404e6b3a 100644
--- a/README
+++ b/README
@@ -26,33 +26,23 @@ Dependencies:
26For the impatient, here is the list of immediate dependencies for 26For the impatient, here is the list of immediate dependencies for
27running GNUnet: 27running GNUnet:
28 28
29- libextractor >= 0.5.20b 29- libextractor >= 0.5.23
30- libmicrohttpd >= 0.4.2
30- libgcrypt >= 1.2 31- libgcrypt >= 1.2
31- libgmp >= 4.0 32- libgmp >= 4.0
32- libcurl >= 7.15.4 33- libcurl >= 7.15.4
33- libltdl >= 2.2 (part of GNU libtool) 34- libltdl >= 2.2 (part of GNU libtool)
34- libguile >= 1.8 (required for gnunet-setup)
35- GNU adns >= 1.0 (strongly recommended)
36- mysql >= 5.0 (strongly recommended) 35- mysql >= 5.0 (strongly recommended)
37- sqlite >= 3.0 (alternative to MySQL) 36- sqlite >= 3.0 (alternative to MySQL)
38 37
39Certain gnunet-setup plugins would also like to have: 38Certain gnunet-setup plugins would also like to have:
40- GTK >= 2.6.0 39- GTK >= 2.6.0
41- Qt >= 4.0 40- Qt >= 4.0
42- dialog >= 1.0-20051207
43- ncurses
44
45Certain transports would also like to have:
46- libmicrohttpd >= 0.4.0b
47- libcurl >= 7.15.4
48- libesmtp >= 1.0.4
49
50 41
51Recommended autotools for compiling the SVN version are: 42Recommended autotools for compiling the SVN version are:
52- autoconf >= 2.59 43- autoconf >= 2.59
53- automake >= 1.9.4 44- automake >= 1.9.4
54- libtool >= 1.5 45- libtool >= 2.2 (only in Debian experimental)
55- libltdl >= 2.2.0 (only in Debian experimental)
56 46
57See also README.debian for a list of Debian packages. 47See also README.debian for a list of Debian packages.
58 48
@@ -72,16 +62,16 @@ you can start the actual GNUnet compilation process with:
72$ ./configure --prefix=$HOME --with-extractor=$HOME 62$ ./configure --prefix=$HOME --with-extractor=$HOME
73$ make 63$ make
74# make install 64# make install
75# gnunet-setup -d 65# gnunet-setup # (note: does not yet exist!)
76# gnunetd 66# gnunet-arm -s
77 67
78This will compile and install GNUnet to ~/bin/, ~/lib/ and ~/man/. 68This will compile and install GNUnet to ~/bin/, ~/lib/ and ~/man/.
79gnunet-setup will create the daemon configuration (-d); this step is 69gnunet-setup will create the configuration; this step is
80interactive. You can run gnunet-setup as root for a system-wide 70interactive. You can run gnunet-setup as root for a system-wide
81installation or as a particular user to create a personal 71installation or as a particular user to create a personal
82installation. If you do not want to run gnunetd as root, gnunet-setup 72installation. If you do not want to run gnunetd as root, gnunet-setup
83can be used to add a user "gnunet". Data will then be stored in 73can be used to add a user "gnunet". Data will then be stored in
84/var/lib/GNUnet and gnunetd will run as that user. Note that 74/var/lib/gnunet and gnunetd will run as that user. Note that
85additional, per-user configuration files (~/.gnunet/gnunet.conf) also 75additional, per-user configuration files (~/.gnunet/gnunet.conf) also
86need to be created by each user by running gnunet-setup without the -d 76need to be created by each user by running gnunet-setup without the -d
87option. Depending on your operating system the wizards of 77option. Depending on your operating system the wizards of
@@ -106,6 +96,7 @@ $ aclocal -I /usr/local/share/aclocal
106Configuration 96Configuration
107============= 97=============
108 98
99// FIXME: update this section once we have gnunet-setup!
109GNUnet uses two types of configuration files, one for the daemon 100GNUnet uses two types of configuration files, one for the daemon
110(called gnunetd.conf) and one for each user (gnunet.conf). You can 101(called gnunetd.conf) and one for each user (gnunet.conf). You can
111create and edit these configuration files with the gnunet-setup tool. 102create and edit these configuration files with the gnunet-setup tool.
@@ -120,7 +111,7 @@ A default version of the per-user configuration will automatically
120be created whenever you run any tool that needs that particular 111be created whenever you run any tool that needs that particular
121cofniguration file. 112cofniguration file.
122 113
123You MUST create /etc/gnunetd.conf explicitly before starting gnunetd, 114You MUST create /etc/gnunet.conf explicitly before starting gnunetd,
124and the recommended way to do this is to run gnunet-setup -d (plus 115and the recommended way to do this is to run gnunet-setup -d (plus
125possibly options to specify which user interface you would perfer). 116possibly options to specify which user interface you would perfer).
126 117
@@ -131,20 +122,17 @@ cause gnunetd to re-read the configuration file. Note that not all
131options can be changed at runtime this way (e.g. to change any port 122options can be changed at runtime this way (e.g. to change any port
132number, you must fully restart gnunetd). 123number, you must fully restart gnunetd).
133 124
134After changing certain options (or updating GNUnet) you must re-run
135gnunet-update.
136
137 125
138Usage 126Usage
139===== 127=====
140 128
141First, you must obtain an initial list of GNUnet hosts. Knowing a 129First, you must obtain an initial list of GNUnet hosts. Knowing a
142single peer is sufficient since after that GNUnet propagates 130single peer is sufficient since after that GNUnet propagates
143information about other peers. Note that the default "gnunetd.conf" 131information about other peers. Note that the default "gnunet.conf"
144contains URLs from where gnunetd downloads an initial hostlist 132contains URLs from where GNUnet downloads an initial hostlist
145whenever it is started. If you want to create an alternative URL for 133whenever it is started. If you want to create an alternative URL for
146others to use, the file can be generated on any machine running 134others to use, the file can be generated on any machine running
147gnunetd by periodically executing 135GNUnet by periodically executing
148 136
149$ cat $GNUNETD_HOME/data/hosts/* > the_file 137$ cat $GNUNETD_HOME/data/hosts/* > the_file
150 138
@@ -153,12 +141,12 @@ can also add hosts manually. The GNUnet webpage has a public
153directory of hostkeys under http://gnunet.org/hosts/. You 141directory of hostkeys under http://gnunet.org/hosts/. You
154can of course use any other source for these files. Copy the hostkeys 142can of course use any other source for these files. Copy the hostkeys
155to "$GNUNETD_HOME/data/hosts/" (where $GNUNETD_HOME is the 143to "$GNUNETD_HOME/data/hosts/" (where $GNUNETD_HOME is the
156directory specified in the /etc/gnunetd.conf configuration file). 144directory specified in the /etc/gnunet.conf configuration file).
157 145
158Now start the local node using "gnunetd". gnunetd should run 24/7 if 146Now start the local node using "gnunet-arm -s". GNUnet should run 24/7 if
159you want to maximize your anonymity. You may start it as a service 147you want to maximize your anonymity. You may start it as a service
160with "/etc/init.d/gnunetd start". To insert files into GNUnet, use 148with "/etc/init.d/gnunet start". To publish files on GNUnet, use
161the "gnunet-insert" command. 149the "gnunet-publish" command.
162 150
163The GTK user interface is shipped separately from GNUnet. After 151The GTK user interface is shipped separately from GNUnet. After
164downloading and installing gnunet-gtk, you can invoke the GUI with: 152downloading and installing gnunet-gtk, you can invoke the GUI with:
@@ -237,6 +225,7 @@ port (from the point of view of the network).
237Running the SMTP transport 225Running the SMTP transport
238========================== 226==========================
239 227
228// NOTE: SMTP is not currently available in this version of GNUnet
240Running GNUnet over SMTP (e-mail) is a bit more involved. Note that 229Running GNUnet over SMTP (e-mail) is a bit more involved. Note that
241you do not need to run all transports (only running the NAT transport 230you do not need to run all transports (only running the NAT transport
242is the only thing that will not work). If you really want to do 231is the only thing that will not work). If you really want to do