-ignore
[oweals/gnunet.git] / README
diff --git a/README b/README
index dce9e66f06d79d77b06ef53044748e8fab2ac4a6..99ac34e45188369e50a4e971b2c6abd119ea4177 100644 (file)
--- a/README
+++ b/README
@@ -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 2010.  While using older packages may in some
+stable distributions in 2011.  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,14 +29,14 @@ 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.2
+- libmicrohttpd >= 0.9.21
 - libgcrypt     >= 1.2
-- libgmp        >= 4.0
 - libcurl       >= 7.21.0
+- libunistring  >= 0.9.2
 - libltdl       >= 2.2 (part of GNU libtool)
-- sqlite        >= 3.0 (alternative to MySQL)
+- sqlite        >= 3.0 (default database)
 - mysql         >= 5.1 (alternative to sqLite)
-- postgres      >= ??? (not yet supported)
+- postgres      >= 8.3 (alternative to sqLite)
 
 Recommended autotools for compiling the SVN version are:
 - autoconf >= 2.59
@@ -60,8 +60,8 @@ traversal).
 GNUnet requires the GNU MP library (http://www.gnu.org/software/gmp/)
 and libgcrypt (http://www.gnupg.org/).  You can specify the path to
 libgcrypt by passing "--with-gcrypt=PATH" to configure.  You will also
-need either sqlite (http://www.sqlite.org/) or MySQL
-(http://www.mysql.org/).
+need either sqlite (http://www.sqlite.org/), MySQL
+(http://www.mysql.org/) or PostGres (http://www.postgres.org/).
 
 If you install from source, you need to install GNU libextractor first
 (download from http://www.gnu.org/software/libextractor/).  We also
@@ -85,10 +85,20 @@ configuration file slightly so that data can be stored in
 "/var/lib/gnunet"; you may also want to use "/etc/gnunet.conf" for the
 location of the configuration file in this case.
 
+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 NAT traversal, WLAN and VPN will not work).
+
 Note that additional, per-user configuration files
 (~/.gnunet/gnunet.conf) need to be created by each user (for example,
-by running gnunet-setup). For more general information about the GNU
-build process read the INSTALL file.
+by running gnunet-setup).  Note that gnunet-setup is a separate
+download and requires recent versions of GTK+ and Glade; you can also
+edit the configuration file by hand, but this is not recommended.  For
+more general information about the GNU build process read the INSTALL
+file.
 
 If you are compiling the code from subversion, you have to run
 ". bootstrap" before ./configure.  If you receive an error during the
@@ -114,8 +124,8 @@ The defaults that are shipped with the installation are usually ok,
 you may want to adjust the limitations (space consumption, bandwidth,
 etc.) though.  The configuration files are human-readable.  Note that
 you MUST create "~/.gnunet/gnunet.conf" explicitly before starting
-GNUnet.  You can either copy "defaults.conf" or simply create an empty
-file.
+GNUnet.  You can either run gnunet-setup (available as part of the
+gnunet-gtk source package) or simply create an empty file.
 
 
 Usage
@@ -142,20 +152,9 @@ to "$SERVICEHOME/data/hosts/" (where $SERVICEHOME is the directory
 specified in the gnunet.conf configuration file).
 
 Now start the local node using "gnunet-arm -s".  GNUnet should run 24/7 if
-you want to maximize your anonymity.  
-
-The GTK user interface is shipped separately.  After downloading and
-installing gnunet-gtk, you can invoke the GUI with:
-
-$ gnunet-gtk
-
-// FIXME: gnunet-qt is not yet supported in 0.9.x
-For Qt/KDE users, there is also a QT user interface (also shipped 
-separately).  If you install gnunet-qt, you can invoke the GUI with:
+you want to maximize your anonymity.
 
-$ gnunet-qt
-
-If you want to use the shell (part of this distribution), use
+You should then be able to access GNUnet using the shell:
 
 $ gnunet-search KEYWORD
 
@@ -167,11 +166,11 @@ to retrieve a file.  The GNUNET_URI is printed by gnunet-search
 together with a description.  To publish files on GNUnet, use the
 "gnunet-publish" command.
 
-// FIXME: auto-share is not yet supported in 0.9.x
-In order to share files, the easiest way is to create a directory
-with the files (and directories) that you want to share and run
 
-$ nohup gnunet-auto-share NAME-OF-THE-DIRECTORY &
+The GTK user interface is shipped separately.  After downloading and
+installing gnunet-gtk, you can invoke the GUI with:
+
+$ gnunet-gtk
 
 For further documentation, see our webpage.
 
@@ -199,10 +198,11 @@ $ make install
 $ export GNUNET_PREFIX=$SOMEWHERE
 $ make check
 
-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/.
+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 
+system at https://gnunet.org/bugs/.
 
 
 Running http on port 80 and https on port 443
@@ -230,17 +230,6 @@ network).  However, we are not aware of this providing any advantages
 at this point.
 
 
-
-Running the SMTP transport
-==========================
-
-// NOTE: SMTP is not currently available in this version of GNUnet
-Running GNUnet over SMTP (e-mail) is a bit more involved.  Note that
-you do not need to run all transports (only running the NAT transport
-is the only thing that will not work).  If you really want to do
-P2P over SMTP, read the instructions at http://gnunet.org/smtp
-
-
 Stay tuned
 ==========