README

   1                        Welcome to GNUnet
   2
   3
   4 What is GNUnet?
   5 ===============
   6
   7 GNUnet is peer-to-peer framework focusing on security.  The first and
   8 primary application for GNUnet is anonymous file-sharing.  GNUnet is
   9 currently developed by a worldwide group of independent free software
  10 developers.  GNUnet is a GNU package (http://www.gnu.org/).
  11
  12 This is an ALPHA release.  There are known and significant bugs as
  13 well as many missing features in this release.
  14
  15 Additional documentation about GNUnet can be found at
  16 https://gnunet.org/.
  17
  18
  19 Dependencies:
  20 =============
  21
  22 Please note that for many of its dependencies GNUnet requires very
  23 recent versions of the libraries which are often NOT to be found in
  24 stable distributions in 2011.  While using older packages may in some
  25 cases on some operating systems may seem to work in some limited
  26 fashion, we are in many cases aware of serious problems with older
  27 packages.  Hence please make sure to use  the versions listed below.
  28
  29 These are the direct dependencies for running GNUnet:
  30
  31 - libextractor  >= 0.6.1
  32 - libmicrohttpd >= 0.9.17
  33 - libgcrypt     >= 1.2
  34 - libcurl       >= 7.21.0
  35 - libunistring  >= 0.9.2
  36 - libltdl       >= 2.2 (part of GNU libtool)
  37 - sqlite        >= 3.0 (default database)
  38 - mysql         >= 5.1 (alternative to sqLite)
  39 - postgres      >= 8.3 (alternative to sqLite)
  40
  41 Recommended autotools for compiling the SVN version are:
  42 - autoconf >= 2.59
  43 - automake >= 1.11.1
  44 - libtool  >= 2.2
  45
  46
  47 How to install?
  48 ===============
  49
  50 The fastest way is to use a binary package if it is available for your
  51 system.  For a more detailed description, read the installation
  52 instructions on the webpage at https://gnunet.org/installation.
  53
  54 Note that some functions of GNUnet require "root" access.  GNUnet will
  55 install (tiny) SUID binaries for those functions is you run "make
  56 install" as root.  If you do not, GNUnet will still work, but some
  57 functionality will not be available (including certain forms of NAT
  58 traversal).
  59
  60 GNUnet requires the GNU MP library (http://www.gnu.org/software/gmp/)
  61 and libgcrypt (http://www.gnupg.org/).  You can specify the path to
  62 libgcrypt by passing "--with-gcrypt=PATH" to configure.  You will also
  63 need either sqlite (http://www.sqlite.org/), MySQL
  64 (http://www.mysql.org/) or PostGres (http://www.postgres.org/).
  65
  66 If you install from source, you need to install GNU libextractor first
  67 (download from http://www.gnu.org/software/libextractor/).  We also
  68 recommend installing GNU libmicrohttpd (download from
  69 http://www.gnu.org/software/libmicrohttpd/).  Then you can start the
  70 actual GNUnet compilation process with:
  71
  72 $ ./configure --prefix=$HOME --with-extractor=$HOME
  73 $ make
  74 # make install
  75 # sudo -u gnunet mkdir ~/.gnunet/
  76 # sudo -u gnunet touch ~/.gnunet/gnunet.conf
  77 # sudo -u gnunet gnunet-arm -s
  78
  79 This will compile and install GNUnet to $HOME/bin/, $HOME/lib/ and
  80 $HOME/share/ and start the system with the default configuration.  It
  81 is recommended that you add a user "gnunet" to run "gnunet-arm".  You
  82 can then still run the end-user applications as another user.  If you
  83 create a user "gnunet", it is recommended that you edit the
  84 configuration file slightly so that data can be stored in
  85 "/var/lib/gnunet"; you may also want to use "/etc/gnunet.conf" for the
  86 location of the configuration file in this case.
  87
  88 You can avoid running 'make install' as root if you run configure
  89 with the "--with-sudo=yes" option and have extensive sudo rights
  90 (can run chmod +s and chown via sudo).  If you run 'make install'
  91 as a normal user without sudo rights (or the configure option),
  92 certain binaries that require additional priviledges will not be
  93 installed properly (and NAT traversal, WLAN and VPN will not work).
  94
  95 Note that additional, per-user configuration files
  96 (~/.gnunet/gnunet.conf) need to be created by each user (for example,
  97 by running gnunet-setup).  Note that gnunet-setup is a separate
  98 download and requires recent versions of GTK+ and Glade; you can also
  99 edit the configuration file by hand, but this is not recommended.  For
 100 more general information about the GNU build process read the INSTALL
 101 file.
 102
 103 If you are compiling the code from subversion, you have to run
 104 ". bootstrap" before ./configure.  If you receive an error during the
 105 running of ". bootstrap" that looks like "macro `AM_PATH_GTK' not
 106 found in library", you may need to run aclocal by hand with the -I
 107 option, pointing to your aclocal m4 macros, i.e.
 108
 109 $ aclocal -I /usr/local/share/aclocal
 110
 111
 112 Configuration
 113 =============
 114
 115 GNUnet uses two types of configuration files, one that specifies the
 116 system-wide defaults (typically located in /usr/share/gnunet/defaults
 117 .conf) and a second one that overrides default values with
 118 user-specific preferences.  The user-specific configuration file
 119 should be located in "~/.gnunet/gnunet.conf" or its location can be
 120 specified by giving the "-c" option to the respective GNUnet
 121 application.
 122
 123 The defaults that are shipped with the installation are usually ok,
 124 you may want to adjust the limitations (space consumption, bandwidth,
 125 etc.) though.  The configuration files are human-readable.  Note that
 126 you MUST create "~/.gnunet/gnunet.conf" explicitly before starting
 127 GNUnet.  You can either run gnunet-setup (available as part of the
 128 gnunet-gtk source package) or simply create an empty file.
 129
 130
 131 Usage
 132 =====
 133
 134 First, you must obtain an initial list of GNUnet hosts.  Knowing a
 135 single peer is sufficient since after that GNUnet propagates
 136 information about other peers.  Note that the default "gnunet.conf"
 137 contains URLs from where GNUnet downloads an initial hostlist
 138 whenever it is started.  If you want to create an alternative URL for
 139 others to use, the file can be generated on any machine running
 140 GNUnet by periodically executing
 141
 142 $ cat $SERVICEHOME/data/hosts/* > the_file
 143
 144 and offering 'the_file' via your web server.  Alternatively, you can
 145 run the build-in web server by adding '-p' to the OPTIONS value
 146 in the "hostlist" section of gnunet.conf and opening the respective
 147 HTTPPORT to the public.
 148
 149 If the solution with the hostlist URL is not feasible for your
 150 situation, you can also add hosts manually.  Simply copy the hostkeys
 151 to "$SERVICEHOME/data/hosts/" (where $SERVICEHOME is the directory
 152 specified in the gnunet.conf configuration file).
 153
 154 Now start the local node using "gnunet-arm -s".  GNUnet should run 24/7 if
 155 you want to maximize your anonymity.
 156
 157 You should then be able to access GNUnet using the shell:
 158
 159 $ gnunet-search KEYWORD
 160
 161 This will display a list of results to the console. Then use
 162
 163 $ gnunet-download -o FILENAME GNUNET_URI
 164
 165 to retrieve a file.  The GNUNET_URI is printed by gnunet-search
 166 together with a description.  To publish files on GNUnet, use the
 167 "gnunet-publish" command.
 168
 169
 170 The GTK user interface is shipped separately.  After downloading and
 171 installing gnunet-gtk, you can invoke the GUI with:
 172
 173 $ gnunet-gtk
 174
 175 For further documentation, see our webpage.
 176
 177
 178 Hacking GNUnet
 179 ==============
 180
 181 Contributions are welcome, please submit bugs to
 182 https://gnunet.org/bugs/.  Please make sure to run contrib/report.sh
 183 and include the output with your bug reports.  More about how to
 184 report bugs can be found in the GNUnet FAQ on the webpage.  Submit
 185 patches via E-Mail to gnunet-developers@gnu.org.
 186
 187 In order to run the unit tests with "make check", you need to
 188 set an environment variable ("GNUNET_PREFIX") to the directory
 189 where GNUnet is installed (usually, GNUnet will use OS specific
 190 tricks in order to try to figure out the PREFIX, but since the
 191 testcase binaries are not installed, that trick does not work
 192 for them).  Also, before running any testcases, you must
 193 complete the installation first.  Quick summary:
 194
 195 $ ./configure --prefix=$SOMEWHERE
 196 $ make
 197 $ make install
 198 $ export GNUNET_PREFIX=$SOMEWHERE
 199 $ make check
 200
 201 Some of the testcases require python >= 2.6 and pexpect to be
 202 installed.  If any testcases fail to pass on your system, run
 203 "contrib/report.sh" and report the output together with
 204 information about the failing testcase to the Mantis bugtracking
 205 system at https://gnunet.org/bugs/.
 206
 207
 208 Running http on port 80 and https on port 443
 209 =============================================
 210
 211 In order to hide GNUnet's HTTP/HTTPS traffic perfectly, you might
 212 consider running GNUnet's HTTP/HTTPS transport on port 80/443.
 213 However, we do not recommend running GNUnet as root.  Instead, forward
 214 port 80 to say 8080 with this command (as root, in your startup
 215 scripts):
 216
 217 # iptables -t nat -A PREROUTING -p tcp -m tcp --dport 80 -j REDIRECT --to-ports 8080
 218
 219 or for HTTPS
 220
 221 # iptables -t nat -A PREROUTING -p tcp -m tcp --dport 443 -j REDIRECT --to-ports 4433
 222
 223 Then set in the HTTP section of gnunet.conf the "ADVERTISED-PORT" to
 224 "80" and "PORT" to 8080 and similarly in the HTTPS section the
 225 "ADVERTISED-PORT" to "443" and "PORT" to 4433.
 226
 227 You can do the same trick for the TCP and UDP transports if you want
 228 to map them to a priviledged port (from the point of view of the
 229 network).  However, we are not aware of this providing any advantages
 230 at this point.
 231
 232
 233 Stay tuned
 234 ==========
 235
 236 * https://gnunet.org/
 237 * https://gnunet.org/bugs/
 238 * https://gnunet.org/svn/
 239 * http://www.gnu.org/software/gnunet/
 240 * http://mail.gnu.org/mailman/listinfo/gnunet-developers
 241 * http://mail.gnu.org/mailman/listinfo/help-gnunet
 242 * http://mail.gnu.org/mailman/listinfo/info-gnunet
 243 * http://mail.gnu.org/mailman/listinfo/gnunet-svn