gnunet-svn
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[GNUnet-SVN] r24241 - gnunet


From: gnunet
Subject: [GNUnet-SVN] r24241 - gnunet
Date: Tue, 9 Oct 2012 21:31:21 +0200

Author: grothoff
Date: 2012-10-09 21:31:21 +0200 (Tue, 09 Oct 2012)
New Revision: 24241

Modified:
   gnunet/README
   gnunet/configure.ac
Log:
-updating docu

Modified: gnunet/README
===================================================================
--- gnunet/README       2012-10-09 19:05:28 UTC (rev 24240)
+++ gnunet/README       2012-10-09 19:31:21 UTC (rev 24241)
@@ -76,8 +76,6 @@
 $ ./configure --prefix=$GNUNET_PREFIX --with-extractor=$LE_PREFIX
 $ make
 # make install
-# sudo -u gnunet mkdir ~gnunet/.gnunet/ 
-# sudo -u gnunet touch ~gnunet/.gnunet/gnunet.conf
 # sudo -u gnunet gnunet-arm -s
 
 This will create the users and groups needed for running GNUnet
@@ -89,9 +87,13 @@
 
 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
-system user home directory at "/var/lib/gnunet"; you may also want to
+system user home directory at "/var/lib/gnunet".  Depending on what
+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.
+this case (instead of ~gnunet/.gnunet/gnunet.conf").  In this case,
+you need to start GNUnet using "gnunet-arm -s -c /etc/gnunet.conf".
 
 You can avoid running 'make install' as root if you run configure
 with the "--with-sudo=yes" option and have extensive sudo rights
@@ -125,14 +127,24 @@
 Configuration
 =============
 
-Note that additional, per-user configuration files
-(~/.gnunet/gnunet.conf) need to be created by each user (for example,
-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.
+Note that additional, per-user configuration files can be created by
+each user.  However, this is usually not necessary as there are few
+per-user options that normal users would want to modify.  The defaults
+that are shipped with the installation are usually just fine.
 
+The gnunet-setup tool is particularly useful to generate the master
+configuration for the peer.  gnunet-setup can be used to configure and
+test (!) the network settings, choose which applications should be run
+and configure databases.  Other options you might want to control
+include system limitations (such as disk space consumption, bandwidth,
+etc.).  The resulting configuration files are human-readable and can
+theoretically be created or edited by hand.
+
+gnunet-setup is a separate download and requires somewhat recent
+versions of GTK+ and Glade. You can also create the configuration file
+by hand, but this is not recommended.  For more general information
+about the GNU build process read the INSTALL file.
+
 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
@@ -141,20 +153,13 @@
 location can be specified by giving the "-c" option to the respective
 GNUnet application.
 
-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 run gnunet-setup (available as part of the
-gnunet-gtk source package) or simply create an empty file.
 
-
 Usage
 =====
 
 First, you must obtain an initial list of GNUnet hosts.  Knowing a
 single peer is sufficient since after that GNUnet propagates
-information about other peers.  Note that the default "gnunet.conf"
+information about other peers.  Note that the default configuration
 contains URLs from where GNUnet downloads an initial hostlist
 whenever it is started.  If you want to create an alternative URL for
 others to use, the file can be generated on any machine running
@@ -170,16 +175,24 @@
 If the solution with the hostlist URL is not feasible for your
 situation, you can also add hosts manually.  Simply copy the hostkeys
 to "$SERVICEHOME/data/hosts/" (where $SERVICEHOME is the directory
-specified in the gnunet.conf configuration file).
+specified in the gnunet.conf configuration file).  You can also use
+"gnunet-peerinfo -g" to GET a URI for a peer and "gnunet-peerinfo -p
+URI" to add a URI from another peer.  Finally, GNUnet peers that use
+UDP or WLAN will discover each other automatically (if they are in the
+vicinity of each other) using broadcasts (IPv4/WLAN) or multicasts
+(IPv6).
 
-Now start the local node using "gnunet-arm -s".  GNUnet should run 24/7 if
-you want to maximize your anonymity.
+The local node is started using "gnunet-arm -s".  GNUnet should run
+24/7 if you want to maximize your anonymity, as this makes partitioning
+attacks harder.
 
-You should then be able to access GNUnet using the shell:
+Once your peer is running, you should then be able to access GNUnet
+using the shell:
 
 $ gnunet-search KEYWORD
 
-This will display a list of results to the console. Then use
+This will display a list of results to the console.  You can abort
+the command using "CTRL-C".  Then use
 
 $ gnunet-download -o FILENAME GNUNET_URI
 
@@ -228,7 +241,7 @@
 system at https://gnunet.org/bugs/.
 
 
-Running http on port 80 and https on port 443
+Running HTTP on port 80 and HTTPS on port 443
 =============================================
 
 In order to hide GNUnet's HTTP/HTTPS traffic perfectly, you might
@@ -252,7 +265,18 @@
 network).  However, we are not aware of this providing any advantages
 at this point.
 
+If you are already running an HTTP or HTTPS server on port 80 (or 443),
+you may be able to configure it as a "ReverseProxy".  Here, you tell
+GNUnet that the externally visible URI is some sub-page on your website,
+and GNUnet can then tunnel its traffic via your existing HTTP server.
+This is particularly powerful if your existing server uses HTTPS, as
+it makes it harder for an adversary to distinguish normal traffic to
+your server from GNUnet traffic.  Finally, even if you just use HTTP,
+you might benefit (!) from ISP's traffic shaping as opposed to being
+throttled by ISPs that dislike P2P.  Details for configuring the
+reverse proxy are documented on our website.
 
+
 Stay tuned
 ==========
 

Modified: gnunet/configure.ac
===================================================================
--- gnunet/configure.ac 2012-10-09 19:05:28 UTC (rev 24240)
+++ gnunet/configure.ac 2012-10-09 19:31:21 UTC (rev 24241)
@@ -1203,25 +1203,38 @@
 
 
 AC_MSG_NOTICE([********************************************
-Please make sure that you have created a user and group 'gnunet'
-and additionally a group 'gnunetdns'.  Make sure that '/var/lib/gnunet'
-is owned (and writable) by user 'gnunet'.  Then, you can compile GNUnet 
-with
-       make
+Please make sure NOW that you have created a user and group 'gnunet'
+and additionally a group 'gnunetdns':
+        addgroup gnunetdns
+        adduser gnunet
+
+Make sure that '/var/lib/gnunet' is owned (and writable) by user
+'gnunet'.  Then, you can compile GNUnet with
+        make
+
 After that, run (if necessary as 'root')
         make install
 to install everything. 
-Then, in order to start your peer, run as the 'gnunet' user
-       mkdir ~gnunet/.gnunet/
-       touch ~gnunet/.gnunet/gnunet.conf
-       gnunet-arm -s
 
-Each GNUnet user should also be added to the 'gnunet' group (may
-require fresh login to come into effect) and create an (at least 
-initially) empty configuration file:
-       mkdir $HOME/.gnunet/
-       touch $HOME/.gnunet/gnunet.conf
+Each GNUnet user should be added to the 'gnunet' group (may
+require fresh login to come into effect):
+        adduser $USERNAME gnunet
+(run the above command as root once for each of your users, replacing
+"$USERNAME" with the respective login names).  If you have a global IP
+address, no further configuration is required.
        
-Optionally, download and compile:
-- gnunet-gtk to get a GUI for file-sharing and configuration.
+Optionally, download and compile gnunet-gtk to get a GUI for 
+file-sharing and configuration.  This is particularly recommended
+if your network setup is non-trivial, as gnunet-setup can be
+used to test in the GUI if your network configuration is working.
+gnunet-setup should be run as the "gnunet" user under X.  As it
+does very little with the network, running it as "root" is likely
+also harmless.  You can also run it as a normal user, but then
+you have to copy ~/.gnunet/gnunet.conf" over to the "gnunet" user's
+home directory in the end.
+
+Once you have configured your peer, run (as the 'gnunet' user)
+       gnunet-arm -s
+to start the peer.  You can then run the various GNUnet-tools as
+your "normal" user (who should only be in the group 'gnunet').
 ********************************************])




reply via email to

[Prev in Thread] Current Thread [Next in Thread]