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