aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2012-02-23 17:48:10 +0000
committerChristian Grothoff <christian@grothoff.org>2012-02-23 17:48:10 +0000
commit51aab09f2804d71b39e10fdb281f2bfad2239ded (patch)
treef90fe6dbae367b97771c5e08618c2cf2bb8b2f6c /README
parent880fbe91d5dd4d605ed70745cda425954f221009 (diff)
downloadgnunet-51aab09f2804d71b39e10fdb281f2bfad2239ded.tar.gz
gnunet-51aab09f2804d71b39e10fdb281f2bfad2239ded.zip
-updating readme and configure
Diffstat (limited to 'README')
-rw-r--r--README50
1 files changed, 30 insertions, 20 deletions
diff --git a/README b/README
index 3f4dff7ad..b2b7233ed 100644
--- a/README
+++ b/README
@@ -67,30 +67,38 @@ If you install from source, you need to install GNU libextractor first
67(download from http://www.gnu.org/software/libextractor/). We also 67(download from http://www.gnu.org/software/libextractor/). We also
68recommend installing GNU libmicrohttpd (download from 68recommend installing GNU libmicrohttpd (download from
69http://www.gnu.org/software/libmicrohttpd/). Then you can start the 69http://www.gnu.org/software/libmicrohttpd/). Then you can start the
70actual GNUnet compilation process with: 70actual GNUnet compilation and installation process with:
71 71
72$ ./configure --prefix=$HOME --with-extractor=$HOME 72$ export GNUNET_PREFIX=/usr/local # or other directory of your choice
73$ addgroup gnunetdns
74$ adduser gnunet gnunet
75$ ./configure --prefix=$GNUNET_PREFIX --with-extractor=$LE_PREFIX
73$ make 76$ make
74# make install 77# make install
75# sudo -u gnunet mkdir ~/.gnunet/ 78# sudo -u gnunet mkdir ~/.gnunet/
76# sudo -u gnunet touch ~/.gnunet/gnunet.conf 79# sudo -u gnunet touch ~/.gnunet/gnunet.conf
77# sudo -u gnunet gnunet-arm -s 80# sudo -u gnunet gnunet-arm -s
78 81
79This will compile and install GNUnet to $HOME/bin/, $HOME/lib/ and 82This will create the users and groups needed for running GNUnet
80$HOME/share/ and start the system with the default configuration. It 83securely and then compile and install GNUnet to $GNUNET_PREFIX/bin/,
81is recommended that you add a user "gnunet" to run "gnunet-arm". You 84$GNUNET_PREFIX/lib/ and $GNUNET_PREFIX/share/ and start the system
82can then still run the end-user applications as another user. If you 85with the default configuration. It is strongly recommended that you
83create a user "gnunet", it is recommended that you edit the 86add a user "gnunet" to run "gnunet-arm". You can then still run the
84configuration file slightly so that data can be stored in 87end-user applications as another user.
85"/var/lib/gnunet"; you may also want to use "/etc/gnunet.conf" for the 88
86location of the configuration file in this case. 89If you create a system user "gnunet", it is recommended that you edit
90the configuration file slightly so that data can be stored in the
91system user home directory at "/var/lib/gnunet"; you may also want to
92use "/etc/gnunet.conf" for the location of the configuration file in
93this case.
87 94
88You can avoid running 'make install' as root if you run configure 95You can avoid running 'make install' as root if you run configure
89with the "--with-sudo=yes" option and have extensive sudo rights 96with the "--with-sudo=yes" option and have extensive sudo rights
90(can run chmod +s and chown via sudo). If you run 'make install' 97(can run "chmod +s" and "chown" via 'sudo'). If you run 'make install'
91as a normal user without sudo rights (or the configure option), 98as a normal user without sudo rights (or the configure option),
92certain binaries that require additional priviledges will not be 99certain binaries that require additional priviledges will not be
93installed properly (and NAT traversal, WLAN and VPN will not work). 100installed properly (and autonomous NAT traversal, WLAN, DNS/GNS and
101the VPN will then not work).
94 102
95Note that additional, per-user configuration files 103Note that additional, per-user configuration files
96(~/.gnunet/gnunet.conf) need to be created by each user (for example, 104(~/.gnunet/gnunet.conf) need to be created by each user (for example,
@@ -113,12 +121,12 @@ Configuration
113============= 121=============
114 122
115GNUnet uses two types of configuration files, one that specifies the 123GNUnet uses two types of configuration files, one that specifies the
116system-wide defaults (typically located in /usr/share/gnunet/defaults 124system-wide defaults (typically located in
117.conf) and a second one that overrides default values with 125$GNUNET_PREFIX/share/gnunet/config.d/) and a second one that overrides
118user-specific preferences. The user-specific configuration file 126default values with user-specific preferences. The user-specific
119should be located in "~/.gnunet/gnunet.conf" or its location can be 127configuration file should be located in "~/.gnunet/gnunet.conf" or its
120specified by giving the "-c" option to the respective GNUnet 128location can be specified by giving the "-c" option to the respective
121application. 129GNUnet application.
122 130
123The defaults that are shipped with the installation are usually ok, 131The defaults that are shipped with the installation are usually ok,
124you may want to adjust the limitations (space consumption, bandwidth, 132you may want to adjust the limitations (space consumption, bandwidth,
@@ -168,9 +176,11 @@ together with a description. To publish files on GNUnet, use the
168 176
169 177
170The GTK user interface is shipped separately. After downloading and 178The GTK user interface is shipped separately. After downloading and
171installing gnunet-gtk, you can invoke the GUI with: 179installing gnunet-gtk, you can invoke the setup tool and the
180file-sharing GUI with:
172 181
173$ gnunet-gtk 182$ gnunet-setup
183$ gnunet-fs-gtk
174 184
175For further documentation, see our webpage. 185For further documentation, see our webpage.
176 186