-implement SRV serialization
[oweals/gnunet.git] / README
diff --git a/README b/README
index 412867037df092d50e8d5db7a8675346136cfc76..1700c4f8e5e1cb349124fdce0fc2565ace50fee9 100644 (file)
--- a/README
+++ b/README
@@ -9,8 +9,8 @@ primary application for GNUnet is anonymous file-sharing.  GNUnet is
 currently developed by a worldwide group of independent free software
 developers.  GNUnet is a GNU package (http://www.gnu.org/).
 
-This is an ALPHA release.  There are known and significant bugs as 
-well as many missing features in this release.  
+This is an ALPHA release.  There are known and significant bugs as
+well as many missing features in this release.
 
 Additional documentation about GNUnet can be found at
 https://gnunet.org/.
@@ -21,7 +21,7 @@ Dependencies:
 
 Please note that for many of its dependencies GNUnet requires very
 recent versions of the libraries which are often NOT to be found in
-stable distributions in 2011.  While using older packages may in some
+stable distributions in 2014.  While using older packages may in some
 cases on some operating systems may seem to work in some limited
 fashion, we are in many cases aware of serious problems with older
 packages.  Hence please make sure to use  the versions listed below.
@@ -29,20 +29,28 @@ packages.  Hence please make sure to use  the versions listed below.
 These are the direct dependencies for running GNUnet:
 
 - libextractor  >= 0.6.1
-- libmicrohttpd >= 0.9.18
-- libgcrypt     >= 1.2
-- libcurl       >= 7.21.3
+- libmicrohttpd >= 0.9.33
+- libgcrypt     >= 1.6
+- libgnurl      >= 7.35.0 (available from https://gnunet.org/gnurl)
 - libunistring  >= 0.9.2
-- gnutls        >= 2.12.0
+- gnutls        >= 3.2.12
+- libidn        >= 1.0
+- libglpk       >= 4.45
+- openssl       >= 1.0 (binary, used to generate X.509 certificate)
 - libltdl       >= 2.2 (part of GNU libtool)
-- sqlite        >= 3.0 (default database)
-- mysql         >= 5.1 (alternative to sqLite)
-- postgres      >= 8.3 (alternative to sqLite)
+- sqlite        >= 3.8 (default database, required)
+- mysql         >= 5.1 (alternative to sqlite)
+- postgres      >= 8.3 (alternative to sqlite)
+- libopus       >= 1.0.1 (optional for experimental conversation tool)
+- libpulse      >= 2.0 (optional for experimental conversation tool)
+- libogg        >= 1.3.0 (optional for experimental conversation tool)
+- python-zbar   >= 0.10 (optional for gnunet-qr)
+- TeX Live      >= 2012 (optional for gnunet-bcd)
 
 Recommended autotools for compiling the SVN version are:
 - autoconf >= 2.59
 - automake >= 1.11.1
-- libtool  >= 2.2 
+- libtool  >= 2.2
 
 
 How to install?
@@ -71,19 +79,26 @@ http://www.gnu.org/software/libmicrohttpd/).  Then you can start the
 actual GNUnet compilation and installation process with:
 
 $ export GNUNET_PREFIX=/usr/local # or other directory of your choice
-$ addgroup gnunetdns
-$ adduser gnunet gnunet
-$ ./configure --prefix=$GNUNET_PREFIX --with-extractor=$LE_PREFIX
+# addgroup gnunetdns
+# adduser gnunet gnunet
+# ./configure --prefix=$GNUNET_PREFIX --with-extractor=$LE_PREFIX
 $ make
 # make install
 # sudo -u gnunet gnunet-arm -s
 
+Note that running the 'configure' and 'make install' steps as
+root (or with sudo) is required as some parts of the installation
+require the creation of SUID binaries.  The installation will
+work if you do not run these steps as root, but some components
+may not be installed in the perfect place or with the right
+permissions and thus won't work.
+
 This will create the users and groups needed for running GNUnet
 securely and then compile and install GNUnet to $GNUNET_PREFIX/bin/,
 $GNUNET_PREFIX/lib/ and $GNUNET_PREFIX/share/ and start the system
 with the default configuration.  It is strongly recommended that you
 add a user "gnunet" to run "gnunet-arm".  You can then still run the
-end-user applications as another user.  
+end-user applications as another user.
 
 If you create a system user "gnunet", it is recommended that you edit
 the configuration file slightly so that data can be stored in the
@@ -92,15 +107,16 @@ the $HOME-directory of your "gnunet" user is, you might need to set
 the SERVICEHOME option in section "[PATHS]" to "/var/lib/gnunet" to
 do this.  Depending on your personal preferences, you may also want to
 use "/etc/gnunet.conf" for the location of the configuration file in
-this case (instead of ~gnunet/.gnunet/gnunet.conf").  In this case,
-you need to start GNUnet using "gnunet-arm -s -c /etc/gnunet.conf".
+this case (instead of ~gnunet/.config/gnunet.conf").  In this case,
+you need to start GNUnet using "gnunet-arm -s -c /etc/gnunet.conf" or
+set "XDG_CONFIG_HOME=/etc/".
 
 You can avoid running 'make install' as root if you run configure
 with the "--with-sudo=yes" option and have extensive sudo rights
 (can run "chmod +s" and "chown" via 'sudo').  If you run 'make install'
 as a normal user without sudo rights (or the configure option),
 certain binaries that require additional priviledges will not be
-installed properly (and autonomous NAT traversal, WLAN, DNS/GNS and 
+installed properly (and autonomous NAT traversal, WLAN, DNS/GNS and
 the VPN will then not work).
 
 If you run 'configure' and 'make install' as root or use the SUDO
@@ -149,7 +165,7 @@ GNUnet uses two types of configuration files, one that specifies the
 system-wide defaults (typically located in
 $GNUNET_PREFIX/share/gnunet/config.d/) and a second one that overrides
 default values with user-specific preferences.  The user-specific
-configuration file should be located in "~/.gnunet/gnunet.conf" or its
+configuration file should be located in "~/.config/gnunet.conf" or its
 location can be specified by giving the "-c" option to the respective
 GNUnet application.
 
@@ -202,7 +218,7 @@ together with a description.  To publish files on GNUnet, use the
 
 
 The GTK user interface is shipped separately.  After downloading and
-installing gnunet-gtk, you can invoke the setup tool and the 
+installing gnunet-gtk, you can invoke the setup tool and the
 file-sharing GUI with:
 
 $ gnunet-setup
@@ -235,9 +251,9 @@ $ export GNUNET_PREFIX=$SOMEWHERE
 $ make check
 
 Some of the testcases require python >= 2.6 and pexpect to be
-installed.  If any testcases fail to pass on your system, run 
-"contrib/report.sh" and report the output together with 
-information about the failing testcase to the Mantis bugtracking 
+installed.  If any testcases fail to pass on your system, run
+"contrib/report.sh" and report the output together with
+information about the failing testcase to the Mantis bugtracking
 system at https://gnunet.org/bugs/.