@node GNUnet Installation Handbook
@chapter GNUnet Installation Handbook
-This handbook describes how to install (build setup, compilation) and
-setup (configuration, start) GNUnet 0.10.x. After following these
+This handbook describes how to install (build, setup, compile) and
+setup (configure, start) GNUnet @value{VERSION}. After following these
instructions you should be able to install and then start user-interfaces
to interact with the network.
-This manual is far from complete, and we welcome informed contributions,
-be it in the form of new chapters or insightful comments.
+Note: This manual is far from complete, and we welcome contributions, be
+it in the form of new chapters or insightful comments.
@menu
* Dependencies::
* Pre-installation notes::
* Generic installation instructions::
* Build instructions for Ubuntu 12.04 using Git::
+* Build instructions for software builds from source::
* Build Instructions for Microsoft Windows Platforms::
* Build instructions for Debian 7.5::
* Installing GNUnet from Git on Ubuntu 14.4::
* Build instructions for Debian 8::
+@c * Build instructions for OpenBSD 6.2::
* Outdated build instructions for previous revisions::
-* Portable GNUnet::
+@c * Portable GNUnet::
* The graphical configuration interface::
* How to start and stop a GNUnet peer::
@end menu
@menu
* External dependencies::
-* Fixing libgnurl build issues::
* Optional dependencies::
* Internal dependencies::
@end menu
@item miniupnpc
@item gettext
@item which
-@item texinfo
+@item texinfo @geq{} 5.2
@item GNU libmicrohttpd @geq{} 0.9.30 @footnote{We recommend to build it
with a GnuTLS version that was configured with libunbound}
@item GNU libextractor @geq{} 1.0
@item zlib
@end itemize
-@node Fixing libgnurl build issues
-@subsection Fixing libgnurl build issues
-
-If you have to compile libgnurl from source since the version included in
-your distribution is to old you perhaps get an error message while
-running the @file{configure} script:
-
-@example
-$ configure
-...
-checking for 64-bit curl_off_t data type... unknown
-checking for 32-bit curl_off_t data type... unknown
-checking for 16-bit curl_off_t data type... unknown
-configure: error: cannot find data type for curl_off_t.
-@end example
-
-@noindent
-Solution:
-
-Before running the configure script, set:
-
-@example
-CFLAGS="-I. -I$BUILD_ROOT/include"
-@end example
-
@node Optional dependencies
@subsection Optional dependencies
These applications must be installed for various experimental or otherwise
-optional features such as @code{gnunet-conversation}, @code{gnunet-gtk}.
+optional features such as @command{gnunet-conversation},
+and @command{gnunet-conversation-gtk} (most of these features are only build if you
+configure GNUnet with @command{--enable-experimental}):
@itemize @bullet
-@item libpulse 2.0 or higher, optional (for gnunet-conversation)
-@item libopus 1.0.1 or higher, optional (for gnunet-conversation)
-@item libogg 1.3.0 or higher, optional (for gnunet-conversation)
-@item certool (binary) optional @footnote{for convenient installation of
-the GNS proxy (available as part of Debian's libnss3-tools)}
-@item python-zbar 0.10 or higher, optional (for gnunet-qr)
-@item Gtk+ 3.0 or higher, optional (for gnunet-gtk)
-@item libgladeui must match Gtk+ version, optional (for gnunet-gtk)
-@item libqrencode 3.0 or higher, optional (for gnunet-namestore-gtk)
+@item libpulse @geq{} 2.0,
+optional (for @command{gnunet-conversation})
+@item libopus @geq{} 1.0.1,
+optional (for @command{gnunet-conversation})
+@item libogg @geq{} 1.3.0,
+optional (for @command{gnunet-conversation})
+@item libnss contained @command{certool} binary,
+optional for convenient installation of
+the GNS proxy.
+@item python-zbar @geq{} 0.10,
+optional (for @command{gnunet-qr})
+@item Gtk+ @geq{} 3.0,
+optional (for @command{gnunet-gtk})
+@item libgladeui (must match Gtk+ version),
+optional (for @command{gnunet-gtk})
+@item libqrencode @geq{} 3.0,
+optional (for @command{gnunet-namestore-gtk})
+@item libpbc @geq{} 0.5.14, optional for Attribute-Based Encryption and Identity Provider functionality
+@item libgabe (https://github.com/schanzen/libgabe), optional for Attribute-Based Encryption and Identity Provider functionality
@end itemize
@node Internal dependencies
This section tries to give an overview of what processes a typical GNUnet
peer running a particular application would consist of. All of the
processes listed here should be automatically started by
-@code{gnunet-arm -s}.
+@command{gnunet-arm -s}.
The list is given as a rough first guide to users for failure diagnostics.
Ideally, end-users should never have to worry about these internal
-dependencies.
+dependencies.
+
In terms of internal dependencies, a minimum file-sharing system consists
of the following GNUnet processes (in order of dependency):
database (MySQL, sqlite or Postgres).
The following instructions will assume that you installed at least sqlite.
For most distributions you should be able to find pre-build packages for
-the database. Again, make sure to install the client libraries and the
+the database. Again, make sure to install the client libraries @b{and} the
respective development headers (if they are packaged separately) as well.
You can find specific, detailed instructions for installing of the
dependencies (and possibly the rest of the GNUnet installation) in the
platform-specific descriptions, which can be found in the Index.
Please consult them now.
-If your distribution is not listed, please study the instructions for
-Debian stable carefully as you try to install the dependencies for your
+If your distribution is not listed, please study
+@ref{Build instructions for Debian 8}, the build instructions for
+Debian stable, carefully as you try to install the dependencies for your
own distribution.
Contributing additional instructions for further platforms is always
appreciated.
Please take in mind that operating system development tends to move at
a rather fast speed. Due to this you should be aware that some of
-the instructionss could be outdated by the time you are reading this.
+the instructions could be outdated by the time you are reading this.
If you find a mistake, please tell us about it (or even better: send
a patch to the documentation to fix it!).
access, we will assume that you have full control over your system in
these instructions.
First, you should create a system user @emph{gnunet} and an additional
-group @emph{gnunetdns}. On Debian and Ubuntu GNU/Linux, type:
+group @emph{gnunetdns}. On the GNU/Linux distributions Debian and Ubuntu,
+type:
@example
# adduser --system --home /var/lib/gnunet --group \
@end example
@noindent
-On other Unixes, this should have the same effect:
+On other Unixes and GNU systems, this should have the same effect:
@example
# useradd --system --groups gnunet --home-dir /var/lib/gnunet
Now compile and install GNUnet using:
@example
-$ tar xvf gnunet-0.10.?.tar.gz
-$ cd gnunet-0.10.?
+$ tar xvf gnunet-@value{VERSION}.tar.gz
+$ cd gnunet-@value{VERSION}
$ ./configure --with-sudo=sudo --with-nssdir=/lib
$ make
$ sudo make install
If you want to be able to enable DEBUG-level log messages, add
@code{--enable-logging=verbose} to the end of the
-@code{./configure} command.
-DEBUG-level log messages are in English-only and should only be useful for
-developers (or for filing really detailed bug reports).
+@command{./configure} command.
+@code{DEBUG}-level log messages are in English only and
+should only be useful for developers (or for filing
+really detailed bug reports).
-Finally, you probably want to compile @code{gnunet-gtk}, which
-includes gnunet-setup (graphical tool for configuration)
-and @code{gnunet-fs-gtk} (graphical tool for file-sharing):
+Finally, you probably want to compile @command{gnunet-gtk}, which
+includes @command{gnunet-setup} (a graphical tool for
+GNUnet configuration) and @command{gnunet-fs-gtk} (a graphical tool for
+GNUnet file-sharing):
@example
-$ tar xvf gnunet-gtk-0.10.?.tar.gz
-$ cd gnunet-gtk-0.10.?
+$ tar xvf gnunet-gtk-@value{VERSION}.tar.gz
+$ cd gnunet-gtk-@value{VERSION}
$ ./configure --with-gnunet=/usr/local/
$ make
$ sudo make install
$ cd ..
-$ sudo ldconfig # just to be safe
+# just to be safe run this:
+$ sudo ldconfig
@end example
@noindent
@end example
@noindent
-You may need to update your ld.so cache to include files installed in
-@file{/usr/local/lib}:
+You may need to update your @code{ld.so} cache to include
+files installed in @file{/usr/local/lib}:
@example
# ldconfig
@end example
@noindent
-Then, switch from user root to user gnunet to start the peer:
+Then, switch from user @code{root} to user @code{gnunet} to start
+the peer:
@example
# su -s /bin/sh - gnunet
$ gnunet-arm -c /etc/gnunet.conf -s
@end example
-You may also want to add the last line in the gnunet users @file{crontab}
+You may also want to add the last line in the gnunet user's @file{crontab}
prefixed with @code{@@reboot} so that it is executed whenever the system
is booted:
@example
-@@reboot /usr/local/bin/gnunet-arm -c /etc/gnunet.conf -s@
+@@reboot /usr/local/bin/gnunet-arm -c /etc/gnunet.conf -s
@end example
@noindent
This will only start the system-wide GNUnet services.
Type exit to get back your root shell.
Now, you need to configure the per-user part. For each
-$USER on the system, run:
+$USER that should get access to GNUnet on the system, run:
@example
# adduser $USER gnunet
to specify a different port number in their personal configuration file.
Finally, the user should perform the basic initial setup for the GNU Name
-System. This is done by running two commands:
+System (GNS) certificate authority. This is done by running:
@example
-$ gnunet-gns-import.sh
$ gnunet-gns-proxy-setup-ca
@end example
@noindent
The first generates the default zones, wheras the second setups the GNS
-Certificate Authority with the user's browser. Now, to actiave GNS in the
+Certificate Authority with the user's browser. Now, to activate GNS in the
normal DNS resolution process, you need to edit your
@file{/etc/nsswitch.conf} where you should find a line like this:
@noindent
The exact details may differ a bit, which is fine. Add the text
-@emph{"gns [NOTFOUND=return]"} after @emph{"files"}:
+@emph{"gns [NOTFOUND=return]"} after @emph{"files"}.
+Keep in mind that we included a backslash ("\") here just for
+markup reasons. You should write the text below on @b{one line}
+and @b{without} the "\":
@example
-hosts: files gns [NOTFOUND=return] mdns4_minimal [NOTFOUND=return] dns mdns4
+hosts: files gns [NOTFOUND=return] mdns4_minimal \
+[NOTFOUND=return] dns mdns4
@end example
-
+@c FIXME: Document new behavior.
You might want to make sure that @file{/lib/libnss_gns.so.2} exists on
-your system, it should have been created during the installation.
-
-
+your system, it should have been created during the installation.
@node Build instructions for Ubuntu 12.04 using Git
@section Build instructions for Ubuntu 12.04 using Git
-
@menu
* Install the required build tools::
* Install libgcrypt 1.6 and libgpg-error::
@node Install libgcrypt 1.6 and libgpg-error
@subsection Install libgcrypt 1.6 and libgpg-error
-@example
-$ wget ftp://ftp.gnupg.org/gcrypt/libgpg-error/libgpg-error-1.12.tar.bz2
-$ tar xf libgpg-error-1.12.tar.bz2
-$ cd libgpg-error-1.12
-$ ./configure
-$ sudo make install ; cd ..
-@end example
+@ref{generic source installation - libgpg-error}
@node Install gnutls with DANE support
@subsection Install gnutls with DANE support
-@example
-$ wget http://www.lysator.liu.se/~nisse/archive/nettle-2.7.1.tar.gz
-$ tar xf nettle-2.7.1.tar.gz
-$ cd nettle-2.7.1
-$ ./configure
-$ sudo make install ; cd ..
-@end example
-
-@example
-$ wget https://www.nlnetlabs.nl/downloads/ldns/ldns-1.6.16.tar.gz
-$ tar xf ldns-1.6.16.tar.gz
-$ cd ldns-1.6.16
-$ ./configure
-$ sudo make install ; cd ..
-@end example
-
-@example
-$ wget https://unbound.net/downloads/unbound-1.4.21.tar.gz
-$ tar xf unbound-1.4.21.tar.gz
-$ cd unbound-1.4.21
-$ ./configure
-$ sudo make install ; cd ..
-@end example
-
-@example
-$ wget ftp://ftp.gnutls.org/gcrypt/gnutls/v3.1/gnutls-3.1.17.tar.xz
-$ tar xf gnutls-3.1.17.tar.xz
-$ cd gnutls-3.1.17
-$ ./configure
-$ sudo make install ; cd ..
-@end example
-
-@example
-$ wget ftp://ftp.gnupg.org/gcrypt/libgcrypt/libgcrypt-1.6.0.tar.bz2
-$ tar xf libgcrypt-1.6.0.tar.bz2
-$ cd libgcrypt-1.6.0
-$ ./configure
-$ sudo make install ; cd ..
-@end example
+@itemize @bullet
+@item @ref{generic source installation - nettle}
+@item @ref{generic source installation - ldns}
+@item @ref{generic source installation - libunbound/unbound}
+@item @ref{generic source installation - gnutls}
+@item @ref{generic source installation - libgcrypt}
+@end itemize
@node Install libgnurl
@subsection Install libgnurl
-@example
-$ wget https://gnunet.org/sites/default/files/gnurl-7.34.0.tar.bz2
-$ tar xf gnurl-7.34.0.tar.bz2
-$ cd gnurl-7.34.0
-$ ./configure --enable-ipv6 --with-gnutls --without-libssh2 \
- --without-libmetalink --without-winidn --without-librtmp \
- --without-nghttp2 --without-nss --without-cyassl \
- --without-polarssl --without-ssl --without-winssl \
- --without-darwinssl --disable-sspi --disable-ntlm-wb \
- --disable-ldap --disable-rtsp --disable-dict --disable-telnet \
- --disable-tftp --disable-pop3 --disable-imap --disable-smtp \
- --disable-gopher --disable-file --disable-ftp
-$ sudo make install ; cd ..
-@end example
+Follow the @ref{generic source installation - libgnurl}.
@node Install libmicrohttpd from Git
@subsection Install libmicrohttpd from Git
@end example
Use the required configure call including the optional installation prefix
-PREFIX or the sudo permissions:
+@code{PREFIX} or the sudo permissions:
@example
$ ./configure [ --with-sudo | --with-prefix=PREFIX ]
mkdir ~/.gnunet; touch ~/.gnunet/gnunet.conf
@end example
-And finally you can start GNUnet with @code{$ gnunet-arm -s}.
+And finally you can start GNUnet with:
+
+@example
+$ gnunet-arm -s
+@end example
@node Install the GNUnet-gtk user interface from Git
@subsection Install the GNUnet-gtk user interface from Git
@example
$ sudo apt-get install libgtk-3-dev libunique-3.0-dev libgladeui-dev \
-libqrencode-dev
+ libqrencode-dev
@end example
-To build GNUnet (with an optional prefix)and execute:
+Build GNUnet (with an optional prefix) and execute:
@example
$ git clone https://gnunet.org/git/gnunet-gtk/
$ make; sudo make install
@end example
+@node Build instructions for software builds from source
+@section Build instructions for software builds from source
+
+This section describes software builds in case your operating
+system lacks binary substitutes / binary builds for some dependencies
+of GNUnet.
+It is assumed that you have installed common build dependencies
+and that these instructions are treated as generic without any
+debugging help.
+It is furthermore assumed that you use the release tarballs of
+the software, installation from the respective version control
+sources might differ in ways that are only minimal different
+(for example a dependency on autotools etc).
+
+@menu
+* generic source installation - nettle::
+* generic source installation - ldns::
+* generic source installation - libunbound/unbound::
+* generic source installation - libav::
+* generic source installation - libextractor::
+* generic source installation - libgpg-error::
+* generic source installation - libgcrypt::
+* generic source installation - gnutls::
+* generic source installation - libmicrohttpd::
+* generic source installation - libgnurl::
+@end menu
+
+@node generic source installation - nettle
+@subsection generic source installation - nettle
+
+@example
+$ wget http://www.lysator.liu.se/~nisse/archive/nettle-2.7.1.tar.gz
+$ tar xf nettle-2.7.1.tar.gz
+$ cd nettle-2.7.1
+$ ./configure
+$ sudo make install ; cd ..
+@end example
+
+@node generic source installation - ldns
+@subsection generic source installation - ldns
+
+@example
+$ wget https://www.nlnetlabs.nl/downloads/ldns/ldns-1.6.16.tar.gz
+$ tar xf ldns-1.6.16.tar.gz
+$ cd ldns-1.6.16
+$ ./configure
+$ sudo make install ; cd ..
+@end example
+
+@node generic source installation - libunbound/unbound
+@subsection generic source installation - libunbound/unbound
+
+@example
+$ wget https://unbound.net/downloads/unbound-1.4.21.tar.gz
+$ tar xf unbound-1.4.21.tar.gz
+$ cd unbound-1.4.21
+$ ./configure
+$ sudo make install ; cd ..
+@end example
+
+@node generic source installation - libav
+@subsection generic source installation - libav
+
+@example
+$ wget https://libav.org/releases/libav-9.10.tar.xz
+$ cd libav-0.9 ; ./configure --enable-shared;
+$ make; sudo make install; cd ..
+@end example
+
+@node generic source installation - libextractor
+@subsection generic source installation - libextractor
+
+@example
+$ wget https://ftp.gnu.org/gnu/libextractor/libextractor-1.3.tar.gz
+$ tar xvf libextractor-1.3.tar.gz
+$ cd libextractor-1.3 ; ./configure;
+$ make ; sudo make install; cd ..
+@end example
+
+@node generic source installation - libgpg-error
+@subsection generic source installation - libgpg-error
+
+@example
+$ wget https://ftp.gnupg.org/gcrypt/libgpg-error/libgpg-error-1.12.tar.bz2
+$ tar xvf libgpg-error-1.12.tar.bz2
+$ cd libgpg-error-1.12; ./configure;
+$ make ; sudo make install; cd ..
+@end example
+
+@node generic source installation - libgcrypt
+@subsection generic source installation - libgcrypt
+@example
+$ wget https://ftp.gnupg.org/gcrypt/libgcrypt/libgcrypt-1.6.0.tar.bz2
+$ tar xvf libgcrypt-1.6.0.tar.bz2
+$ cd libgcrypt-1.6.0; ./configure --with-gpg-error-prefix=/usr/local;
+$ make ; sudo make install ; cd ..
+@end example
+
+@node generic source installation - gnutls
+@subsection generic source installation - gnutls
+
+@example
+$ wget ftp://ftp.gnutls.org/gcrypt/gnutls/v3.2/gnutls-3.2.7.tar.xz
+$ tar xvf gnutls-3.2.7.tar.xz
+$ cd gnutls-3.2.7
+@end example
+
+@noindent
+If you want a GnuTLS with DANE functionality (recommended for GNUnet),
+you have to compile it against libunbound. Assuming that libunbound
+is installed on your system:
+
+@example
+$ ./configure --enable-libdane
+@end example
+
+@noindent
+Note that the build system of GnuTLS should pick up libunbound without
+the explicit mention of @code{--enable-libdane}.
+If you don't want libdane support you should pass @code{--disable-libdane}
+instead.
+
+@example
+$ ./configure
+$ make ; sudo make install ; cd ..
+@end example
+
+@node generic source installation - libmicrohttpd
+@subsection generic source installation - libmicrohttpd
+
+@example
+$ wget https://ftp.gnu.org/gnu/libmicrohttpd/libmicrohttpd-0.9.33.tar.gz
+$ tar xvf libmicrohttpd-0.9.33.tar.gz
+$ cd libmicrohttpd-0.9.33; ./configure;
+$ make ; sudo make install ; cd ..
+@end example
+
+@node generic source installation - libgnurl
+@subsection generic source installation - libgnurl
+
+Example installation of libgnurl version 7.57.0 from source.
+
+@example
+$ wget https://ftp.gnu.org/gnu/gnunet/gnurl-7.57.0.tar.xz
+$ wget https://ftp.gnu.org/gnu/gnunet/gnurl-7.57.0.tar.xz.sig
+$ gpg --verify gnurl-7.57.0.tar.xz.sig
+@end example
+
+@noindent
+If that command fails because you do not have the required public key,
+then run this command to import it:
+
+@example
+$ gpg --keyserver pgp.mit.edu --recv-keys A88C8ADD129828D7EAC02E52E22F9BBFEE348588
+@end example
+
+@noindent
+and rerun the gpg --verify command.
+
+@example
+$ tar xvf gnurl-7.57.0.tar.xz
+$ cd gnurl-7.57.0
+$ ./configure --disable-ntlm-wb
+$ make ; sudo make install; cd ..
+@end example
+
+You have now build and installed libgnurl from source.
+
+@menu
+* Fixing libgnurl build issues::
+@end menu
+
+@node Fixing libgnurl build issues
+@subsubsection Fixing libgnurl build issues
+
+@c FIXME: Obviously this subsection should be evaluated and
+@c if still necessary moved into gnURL itself (README) or
+@c into a separate section which deals with gnURL.
+If you have to compile libgnurl from source (for example if the version
+included in your distribution is too old or it's not included at all)
+you perhaps might get an error message while running the
+@command{configure} script:
+
+@example
+$ configure
+...
+checking for 64-bit curl_off_t data type... unknown
+checking for 32-bit curl_off_t data type... unknown
+checking for 16-bit curl_off_t data type... unknown
+configure: error: cannot find data type for curl_off_t.
+@end example
+
+@noindent
+Solution:
+
+Before running the @command{configure} script, set:
+
+@example
+CFLAGS="-I. -I$BUILD_ROOT/include"
+@end example
+
@node Build Instructions for Microsoft Windows Platforms
@section Build Instructions for Microsoft Windows Platforms
This document is a guide to building GNUnet and its dependencies on
-Windows platforms. GNUnet development is mostly done under Linux and
-especially SVN checkouts may not build out of the box.
-We regret any inconvenience, and if you have problems, please report them.
+Windows platforms. GNUnet development is mostly done under GNU/Linux and
+especially git checkouts may not build out of the box.
+We regret any inconvenience, and if you have problems, please report
+them.
@node Requirements
@subsection Requirements
is a convenient set of scripts which creates a working msys/mingw
installation and installs most dependencies required for GNUnet.
-As of the point of the creation of this Howto, GNUnet @strong{requires} a
-Windows @strong{Server} 2003 or newer for full feature support.
+As of the point of the creation of these instructions,
+GNUnet @strong{requires} a Windows @strong{Server} 2003 or
+newer for full feature support.
Windows Vista and later will also work, but
@strong{non-server version can not run a VPN-Exit-Node} as the NAT
features have been removed as of Windows Vista.
+@c TODO: We should document Windows 10!
+@c It seems like the situation hasn't changed with W10
+
@node Dependencies & Initial Setup
@subsection Dependencies & Initial Setup
@item
Install a fresh version of @strong{Python 2.x}, even if you are using a
x64-OS, install a 32-bit version for use with sbuild.
-Python 3.0 currently is incompatible.
+Python 3.0 is currently incompatible.
@item
-Install your favorite @uref{http://code.google.com/p/tortoisegit/, GIT} &
-@uref{http://tortoisesvn.net/, SVN}-clients.
+Install your favorite @uref{http://code.google.com/p/tortoisegit/, git} &
+@uref{http://tortoisesvn.net/, subversion}-clients.
@item
You will also need some archive-manager like
/src which contains all the installation sources sbuild just compiled.
@end itemize
-Check out the current gnunet-sources (git HEAD) from the
-gnunet-repository, we will do this in your home directory:
+Check out the current GNUnet sources (git HEAD) from the
+GNUnet repository "gnunet.git", we will do this in your home directory:
@code{git clone https://gnunet.org/git/gnunet/ ~/gnunet}
--enable-silent-rules --enable-experimental 2>&1 | tee -a ./configure.log
@end example
-The parameters above will configure for a reasonable gnunet installation
+The parameters above will configure for a reasonable GNUnet installation
to the your msys-root directory.
Depending on which features your would like to build or you may need to
specify additional dependencies. Sbuild installed most libs into
this path.
Like on a unixoid system, you might want to use your home directory as
-prefix for your own gnunet installation for development, without tainting
+prefix for your own GNUnet installation for development, without tainting
the buildenvironment. Just change the "prefix" parameter to point towards
~/ in this case.
-Now it's time to compile gnunet as usual. Though this will take some time,
+Now it's time to compile GNUnet as usual. Though this will take some time,
so you may fetch yourself a coffee or some Mate now...
@example
@subsection Adjusting Windows for running and testing GNUnet
Assuming the build succeeded and you
-@strong{added the bin directory of your gnunet to PATH}, you can now use
+@strong{added the bin directory of your GNUnet to PATH}, you can now use
your gnunet-installation as usual.
Remember that UAC or the windows firewall may popup initially, blocking
further execution of gnunet until you acknowledge them.
-You will also have to take the usual steps to get p2p software running
-properly (port forwarding, ...), and gnunet will require administrative
-permissions as it may even install a device-driver (in case you are using
-gnunet-vpn and/or gnunet-exit).
+You will also have to take the usual steps to get peer-to-peer (p2p)
+software running properly (port forwarding, ...),
+and GNUnet will require administrative permissions as it may even
+install a device-driver (in case you are using gnunet-vpn and/or
+gnunet-exit).
@node Building the GNUnet Installer
@subsection Building the GNUnet Installer
The GNUnet installer is made with
-@uref{http://nsis.sourceforge.net/, NSIS} The installer script is located
-in @file{contrib\win} in the GNUnet source tree.
+@uref{http://nsis.sourceforge.net/, NSIS}.
+The installer script is located in @file{contrib\win} in the
+GNUnet source tree.
@node Using GNUnet with Netbeans on Windows
@subsection Using GNUnet with Netbeans on Windows
@code{make install} steps as root (hence the @code{sudo} in the
commands below). Also, you do this from any
directory. We begin by downloading all dependencies, then extracting the
-sources, and finally compiling and installing the libraries:@
+sources, and finally compiling and installing the libraries.
-@example
-$ wget https://libav.org/releases/libav-9.10.tar.xz
-$ wget http://ftp.gnu.org/gnu/libextractor/libextractor-1.3.tar.gz
-$ wget ftp://ftp.gnupg.org/gcrypt/libgpg-error/libgpg-error-1.12.tar.bz2
-$ wget ftp://ftp.gnupg.org/gcrypt/libgcrypt/libgcrypt-1.6.0.tar.bz2
-$ wget ftp://ftp.gnutls.org/gcrypt/gnutls/v3.2/gnutls-3.2.7.tar.xz
-$ wget http://ftp.gnu.org/gnu/libmicrohttpd/libmicrohttpd-0.9.33.tar.gz
-$ wget https://gnunet.org/sites/default/files/gnurl-7.34.0.tar.bz2
-$ tar xvf libextractor-1.3.tar.gz
-$ tar xvf libgpg-error-1.12.tar.bz2
-$ tar xvf libgcrypt-1.6.0.tar.bz2
-$ tar xvf gnutls-3.2.7.tar.xz
-$ tar xvf libmicrohttpd-0.9.33.tar.gz
-$ tar xvf gnurl-7.34.0.tar.bz2
-$ cd libav-0.9 ; ./configure --enable-shared;
-$ make; sudo make install; cd ..
-$ cd libextractor-1.3 ; ./configure;
-$ make ; sudo make install; cd ..
-$ cd libgpg-error-1.12; ./configure;
-$ make ; sudo make install; cd ..
-$ cd libgcrypt-1.6.0; ./configure --with-gpg-error-prefix=/usr/local;
-$ make ; sudo make install ; cd ..
-$ cd gnutls-3.2.7 ; ./configure;
-$ make ; sudo make install ; cd ..
-$ cd libmicrohttpd-0.9.33; ./configure;
-$ make ; sudo make install ; cd ..
-$ cd gnurl-7.34.0
-$ ./configure --enable-ipv6 --with-gnutls=/usr/local --without-libssh2 \
- --without-libmetalink --without-winidn --without-librtmp \
- --without-nghttp2 --without-nss --without-cyassl --without-polarssl \
- --without-ssl --without-winssl --without-darwinssl --disable-sspi \
- --disable-ntlm-wb --disable-ldap --disable-rtsp --disable-dict \
- --disable-telnet --disable-tftp --disable-pop3 --disable-imap \
- --disable-smtp --disable-gopher --disable-file --disable-ftp
-$ make ; sudo make install; cd ..
-@end example
+For these steps, follow the instructions given in the
+installation from source instruction in this order:
+
+@itemize @bullet
+@item @ref{generic source installation - libav}
+@item @ref{generic source installation - libextractor}
+@item @ref{generic source installation - libgpg-error}
+@item @ref{generic source installation - libgcrypt}
+@item @ref{generic source installation - gnutls}
+@item @ref{generic source installation - libmicrohttpd}
+@item @ref{generic source installation - libgnurl}
+@end itemize
@node Installing GNUnet from source
@subsection Installing GNUnet from source
@section Installing GNUnet from Git on Ubuntu 14.4
@strong{Install the required build tools:}
-@code{ $ sudo apt-get install git automake autopoint autoconf }
+
+@example
+$ sudo apt-get install git automake autopoint autoconf
+@end example
@strong{Install the required dependencies}
+
@example
$ sudo apt-get install libltdl-dev libgpg-error-dev libidn11-dev \
libunistring-dev libglpk-dev libbluetooth-dev libextractor-dev \
@strong{Choose one or more database backends}
-SQLite3:
+@itemize @bullet
+
+@item SQLite3:
+
@example
$ sudo apt-get install libsqlite3-dev
@end example
-MySQL:
+
+@item MySQL:
+
@example
$ sudo apt-get install libmysqlclient-dev
@end example
-PostgreSQL:
+
+@item PostgreSQL:
+
@example
$ sudo apt-get install libpq-dev postgresql
@end example
+@end itemize
+
@strong{Install the optional dependencies for gnunet-conversation:}
@example
@end example
@strong{Install the libgrypt 1.6.1:}
-For Ubuntu 14.04:
+
+@itemize @bullet
+
+@item For Ubuntu 14.04:
+
@example
$ sudo apt-get install libgcrypt20-dev
@end example
-For Ubuntu older 14.04:
+
+@item For Ubuntu older 14.04:
+
@example
$ wget ftp://ftp.gnupg.org/gcrypt/libgcrypt/libgcrypt-1.6.1.tar.bz2
$ tar xf libgcrypt-1.6.1.tar.bz2
$ sudo make install
$ cd ..
@end example
+
+@end itemize
+
@strong{Install libgnurl}
+
@example
$ wget https://gnunet.org/sites/default/files/gnurl-7.35.0.tar.bz2
$ tar xf gnurl-7.35.0.tar.bz2
@end example
@strong{Install GNUnet}
+
@example
$ git clone https://gnunet.org/git/gnunet/
$ cd gnunet/
@end example
If you want to:
+
@itemize @bullet
+@item Install to a different directory:
-@item
-Install to a different directory:@
- --prefix=PREFIX
+@example
+--prefix=PREFIX
+@end example
@item
Have sudo permission, but do not want to compile as root:
@node Build instructions for Debian 8
@section Build instructions for Debian 8
+@c FIXME: I -> we
These are the installation instructions for Debian 8. They were tested
sing a fresh Debian 8 AMD64 installation without non-free software (no
We begin by installing a few Debian packages from stable:
@example
-# apt-get install gcc make python-zbar libltdl-dev libsqlite3-dev \
+# apt-get install gcc make python-zbar libltdl-dev libsqlite3-dev \
libunistring-dev libopus-dev libpulse-dev openssl libglpk-dev texlive \
libidn11-dev libmysqlclient-dev libpq-dev libarchive-dev libbz2-dev \
libflac-dev libgif-dev libglib2.0-dev libgtk-3-dev libmpeg2-4-dev \
@example
$ wget ftp://ftp.gnutls.org/gcrypt/gnutls/v3.3/gnutls-3.3.12.tar.xz
-$ wget https://gnunet.org/sites/default/files/gnurl-7.40.0.tar.bz2
$ tar xvf gnutls-3.3.12.tar.xz
-$ tar xvf gnurl-7.40.0.tar.bz2
$ cd gnutls-3.3.12 ; ./configure ; make ; sudo make install ; cd ..
-$ cd gnurl-7.40.0
-$ ./configure --enable-ipv6 --with-gnutls=/usr/local --without-libssh2 \
---without-libmetalink --without-winidn --without-librtmp \
---without-nghttp2 --without-nss --without-cyassl --without-polarssl \
---without-ssl --without-winssl --without-darwinssl --disable-sspi \
---disable-ntlm-wb --disable-ldap --disable-rtsp --disable-dict \
---disable-telnet --disable-tftp --disable-pop3 --disable-imap \
---disable-smtp --disable-gopher --disable-file --disable-ftp \
---disable-smb
-$ make ; sudo make install; cd ..
@end example
+For the installation and compilation of libgnurl/gnURL refer to
+the generic installation section,
+@xref{generic source installation - libgnurl}.
+
@node Installing GNUnet from Source2
@subsection Installing GNUnet from Source2
applications, but MySQL can offer better performance and Postgres better
resillience.
+@c @node Build instructions for OpenBSD 6.2
+@c @section Build instructions for OpenBSD 6.2
+
@node Outdated build instructions for previous revisions
@section Outdated build instructions for previous revisions
GNUnet 0.10.x.
A set of older installation instructions can also be found in the
file @file{doc/outdated-and-old-installation-instructions.txt} in the
-source of GNUnet.
+source tree of GNUnet.
+
This file covers old instructions which no longer receive security
updates or any kind of support.
* Installing GNUnet 0.10.1 on Ubuntu 14.04::
* Building GLPK for MinGW::
* GUI build instructions for Ubuntu 12.04 using Subversion::
-* Installation with gnunet-update::
+@c * Installation with gnunet-update::
* Instructions for Microsoft Windows Platforms (Old)::
@end menu
@node Installing GNUnet 0.10.1 on Ubuntu 14.04
@subsection Installing GNUnet 0.10.1 on Ubuntu 14.04
-Install the required dependencies@
+Install the required dependencies:
@example
$ sudo apt-get install libltdl-dev libgpg-error-dev libidn11-dev \
- libunistring-dev libglpk-dev libbluetooth-dev libextractor-dev \
- libmicrohttpd-dev libgnutls28-dev
+ libunistring-dev libglpk-dev libbluetooth-dev libextractor-dev \
+ libmicrohttpd-dev libgnutls28-dev
@end example
-Choose one or more database backends@
-SQLite3@
+Choose one or more database backends:
+
+@itemize @bullet
+
+@item SQLite3
@example
$ sudo apt-get install libsqlite3-dev@
@end example
-MySQL@
+@item MySQL
@example
$ sudo apt-get install libmysqlclient-dev@
@end example
-PostgreSQL@
+@item PostgreSQL
@example
$ sudo apt-get install libpq-dev postgresql@
@end example
-Install the optional dependencies for gnunet-conversation:@
+@end itemize
+
+Install the optional dependencies for gnunet-conversation:
@example
- $ sudo apt-get install gstreamer1.0 libpulse-dev libopus-dev@
+ $ sudo apt-get install gstreamer1.0 libpulse-dev libopus-dev
@end example
-Install the libgcrypt 1.6:
+Install libgcrypt 1.6:
@itemize @bullet
+
@item For Ubuntu 14.04:
@example
$ sudo apt-get install libgcrypt20-dev
@end example
-@item For Ubuntu older 14.04:
+@item For Ubuntu older than 14.04:
@example
wget ftp://ftp.gnupg.org/gcrypt/libgcrypt/libgcrypt-1.6.1.tar.bz2
@end example
@end itemize
-Install libgnurl@
+Install libgnurl:
-@example
-$ wget https://gnunet.org/sites/default/files/gnurl-7.35.0.tar.bz2
-$ tar xf gnurl-7.35.0.tar.bz2
-$ cd gnurl-7.35.0
-$ ./configure --enable-ipv6 --with-gnutls --without-libssh2 \
---without-libmetalink --without-winidn --without-librtmp
---without-nghttp2 --without-nss --without-cyassl --without-polarssl \
---without-ssl --without-winssl --without-darwinssl --disable-sspi \
---disable-ntlm-wb --disable-ldap --disable-rtsp --disable-dict \
---disable-telnet --disable-tftp --disable-pop3 --disable-imap \
---disable-smtp --disable-gopher --disable-file --disable-ftp
-$ sudo make install@
-$ cd ..@
-@end example
+@pxref{generic source installation - libgnurl}.
-Install GNUnet@
+Install GNUnet:
@example
$ wget http://ftpmirror.gnu.org/gnunet/gnunet-0.10.1.tar.gz
@itemize @bullet
-@item
-Download the latest version from http://ftp.gnu.org/gnu/glpk/
+@item Download the latest version from
+@uref{http://ftp.gnu.org/gnu/glpk/}
-@item
-Unzip it using your favourite unzipper In the MSYS shell:
+@item Unzip the downloaded source tarball using your favourite
+unzipper application In the MSYS shell
-@item
-change to the respective directory
+@item change to the respective directory
-@item
+@item Configure glpk for "i686-pc-mingw32":
@example
./configure '--build=i686-pc-mingw32'
@end example
-@item
-run
+@item run
@example
make install check
@end example
-MinGW does not automatically detect the correct buildtype so you have to
-specify it manually
@end itemize
+MinGW does not automatically detect the correct buildtype so you have to
+specify it manually.
+
@node GUI build instructions for Ubuntu 12.04 using Subversion
@subsection GUI build instructions for Ubuntu 12.04 using Subversion
@end example
Please ensure that the GNUnet shared libraries can be found by the linker.
-If you installed GNUnet libraries in a non standard path (say
-GNUNET_PREFIX=/usr/local/lib/), you can
+If you installed GNUnet libraries in a non standard path
+(say GNUNET_PREFIX=/usr/local/lib/), you can
@itemize @bullet
-@item
-set the environmental variable permanently to
+@item set the environmental variable permanently to:
@example
LD_LIBRARY_PATH=$GNUNET_PREFIX
@end example
-@item
-or add @code{$GNUNET_PREFIX} to @file{/etc/ld.so.conf}
+@item or add @code{$GNUNET_PREFIX} to @file{/etc/ld.so.conf}
@end itemize
-
-Now you can checkout and compile the GNUnet GUI tools@
+Now you can checkout and compile the GNUnet GUI tools:
@example
- $ git clone https://gnunet.org/git/gnunet-gtk
- $ cd gnunet-gtk
- $ ./bootstrap
- $ ./configure --prefix=$GNUNET_PREFIX/.. --with-gnunet=$GNUNET_PREFIX/..
- $ make install
+$ git clone https://gnunet.org/git/gnunet-gtk
+$ cd gnunet-gtk
+$ ./bootstrap
+$ ./configure --prefix=$GNUNET_PREFIX/.. --with-gnunet=$GNUNET_PREFIX/..
+$ make install
@end example
-@node Installation with gnunet-update
-@subsection Installation with gnunet-update
+@c @node Installation with gnunet-update
+@c @subsection Installation with gnunet-update
-gnunet-update project is an effort to introduce updates to GNUnet
-installations. An interesting to-be-implemented-feature of gnunet-update
-is that these updates are propagated through GNUnet's peer-to-peer
-network. More information about gnunet-update can be found at
-@c FIXME: Use correct cgit URL
-@uref{https://gnunet.org/git/gnunet-update.git/tree/plain/README}.
+@c gnunet-update project is an effort to introduce updates to GNUnet
+@c installations. An interesting to-be-implemented-feature of gnunet-update
+@c is that these updates are propagated through GNUnet's peer-to-peer
+@c network. More information about gnunet-update can be found at
+@c @c FIXME: Use correct cgit URL
+@c @uref{https://gnunet.org/git/gnunet-update.git/tree/plain/README}.
-While the project is still under development, we have implemented the
-following features which we believe may be helpful for users and we
-would like them to be tested:
+@c While the project is still under development, we have implemented the
+@c following features which we believe may be helpful for users and we
+@c would like them to be tested:
-@itemize @bullet
+@c @itemize @bullet
-@item
-Packaging GNUnet installation along with its run-time dependencies into
-update packages
+@c @item
+@c Packaging GNUnet installation along with its run-time dependencies into
+@c update packages
-@item
-Installing update packages into compatible hosts
+@c @item
+@c Installing update packages into compatible hosts
-@item
-Updating an existing installation (which had been installed by
-gnunet-update) to a newer one
+@c @item
+@c Updating an existing installation (which had been installed by
+@c gnunet-update) to a newer one
-@end itemize
+@c @end itemize
-The above said features of gnunet-update are currently available for
-testing on GNU/Linux systems.
+@c The above said features of gnunet-update are currently available for
+@c testing on GNU/Linux systems.
-The following is a guide to help you get started with gnunet-update.
-It shows you how to install the testing binary packages of GNUnet
-0.9.1 we have at @uref{https://gnunet.org/install/}.
+@c The following is a guide to help you get started with gnunet-update.
+@c It shows you how to install the testing binary packages of GNUnet
+@c 0.9.1 we have at @uref{https://gnunet.org/install/}.
-gnunet-update needs the following dependencies:
+@c gnunet-update needs the following dependencies:
-@itemize @bullet
-@item
-python @geq{} 2.6
+@c @itemize @bullet
+@c @item
+@c python @geq{} 2.6
-@item
-gnupg
+@c @item
+@c gnupg
-@item
-python-gpgme
-@end itemize
+@c @item
+@c python-gpgme
+@c @end itemize
-Checkout gnunet-update:
+@c Checkout gnunet-update:
-@c FIXME: git!
-@example
-$ svn checkout -r24905 https://gnunet.org/svn/gnunet-update@
-@end example
+@c @c FIXME: git!
+@c @example
+@c $ svn checkout -r24905 https://gnunet.org/svn/gnunet-update@
+@c @end example
-For security reasons, all packages released for gnunet-update from us are
-signed with the key at @uref{https://gnunet.org/install/key.txt}.
-You would need to import this key into your gpg key ring.
-gnunet-update uses this key to verify the integrity of the packages it
-installs:
+@c For security reasons, all packages released for gnunet-update from us are
+@c signed with the key at @uref{https://gnunet.org/install/key.txt}.
+@c You would need to import this key into your gpg key ring.
+@c gnunet-update uses this key to verify the integrity of the packages it
+@c installs:
-@example
-$ gpg --recv-keys 7C613D78@
-@end example
+@c @example
+@c $ gpg --recv-keys 7C613D78@
+@c @end example
-Download the packages relevant to your architecture (currently I have
-access to GNU/Linux machines on x86_64 and i686, so only two for now,
-hopefully more later) from https://gnunet.org/install/.
+@c Download the packages relevant to your architecture (currently I have
+@c access to GNU/Linux machines on x86_64 and i686, so only two for now,
+@c hopefully more later) from https://gnunet.org/install/.
-To install the downloaded package into the directory /foo:
+@c To install the downloaded package into the directory /foo:
-@example
-gnunet-update/bin/gnunet-update install downloaded/package /foo
-@end example
+@c @example
+@c gnunet-update/bin/gnunet-update install downloaded/package /foo
+@c @end example
-The installer reports the directories into which shared libraries and
-dependencies have been installed. You may need to add the reported shared
-library installation paths to LD_LIBRARY_PATH before you start running any
-installed binaries.
+@c The installer reports the directories into which shared libraries and
+@c dependencies have been installed. You may need to add the reported shared
+@c library installation paths to LD_LIBRARY_PATH before you start running any
+@c installed binaries.
-Please report bugs at https://gnunet.org/bugs/ under the project
-'gnunet-update'.
+@c Please report bugs at https://gnunet.org/bugs/ under the project
+@c 'gnunet-update'.
@node Instructions for Microsoft Windows Platforms (Old)
@subsection Instructions for Microsoft Windows Platforms (Old)
-This document is a @b{DEPRECATED} installation guide for gnunet on
+This document is a @b{DEPRECATED} installation guide for GNUnet on
Windows.
-It will not work for recent gnunet versions, but maybe it will be of
-some use if problems arise.
+It will not work for recent GNUnet versions, but maybe it will be of
+some use if problems arise.
The Windows build uses a UNIX emulator for Windows,
@uref{http://www.mingw.org/, MinGW}, to build the executable modules.
These modules run natively on Windows and do not require additional
emulation software besides the usual dependencies.
-GNUnet development is mostly done under Linux and especially SVN
+GNUnet development is mostly done under GNU/Linux and especially git
checkouts may not build out of the box.
We regret any inconvenience, and if you have problems, please report them.
* Installer::
* Source::
@end menu
-
+
@node Hardware and OS requirements
@subsubsection Hardware and OS requirements
@itemize @bullet
-@item
-Pentium II or equivalent processor, 350 MHz or better
+@item Pentium II or equivalent processor, @geq{} 350 MHz
-@item
-128 MB RAM
+@item 128 MB RAM
-@item
-600 MB free disk space
+@item 600 MB free disk space
+
+@item Windows 2000 or Windows XP are recommended
-@item
-Windows 2000 or Windows XP are recommended
@end itemize
@node Software installation
@item
@strong{Compression software}@
-@
+
The software packages GNUnet depends on are usually compressed using UNIX
-tools like tar, gzip and bzip2.
+tools like @command{tar}, @command{gzip}, @command{xzip} and
+@command{bzip2}.
If you do not already have an utility that is able to extract such
archives, get @uref{http://www.7-zip.org/, 7-Zip}.
@item
@strong{UNIX environment}@
-@
+
The MinGW project provides the compiler toolchain that is used to build
-GNUnet.@ Get the following packages from
-@uref{http://sourceforge.net/projects/mingw/files/, the MinGW project}:
+GNUnet.
+Get the following packages from the
+@uref{http://sourceforge.net/projects/mingw/files/, MinGW} project:
@itemize @bullet
@itemize @bullet
-@item
-Install MSYS (to c:\mingw, for example.)@
+@item Install MSYS (to c:\mingw, for example.)@
Do @strong{not} use spaces in the pathname.
For example, avoid a location such as @file{c:\program files\mingw}.
-@item
-Install MinGW runtime, utilities and GCC to a subdirectory
-(to c:\mingw\mingw, for example)
+@item Install MinGW runtime, utilities and GCC to a subdirectory
+(to @file{c:\mingw\mingw}, for example)
-@item
-Install the Development Kit to the MSYS directory (c:\mingw)
+@item Install the Development Kit to the MSYS directory
+(@file{c:\mingw})
-@item
-Create a batch file bash.bat in your MSYS directory with the files:@
+@item Create a batch file bash.bat in your MSYS directory with
+the files:
@example
bin\sh.exe --login
This batch file opens a shell which is used to invoke the build
processes.
-MinGW's standard shell (msys.bat) is not suitable because it opens a
-separate console window.
-On Vista, bash.bat needs to be run as administrator.
+MinGW's standard shell (@command{msys.bat}) is not suitable
+because it opens a separate console window.
+On Vista, @command{bash.bat} needs to be run as Administrator.
@item
-Start bash.sh and rename (c:\mingw\mingw\)lib\libstdc++.la to avoid
-problems:
+Start @command{bash.sh} and rename
+@file{c:\mingw\mingw\lib\libstdc++.la} to avoid problems:
@example
mv /usr/mingw/lib/libstdc++.la /usr/mingw/lib/libstdc++.la.broken
@end example
@item
-Unpack the Windows API to the MinGW directory (c:\mingw\mingw\) and
+Unpack the Windows API to the MinGW directory (@file{c:\mingw\mingw\}) and
remove the declaration of DATADIR from
-(c:\mingw\mingw\)include\objidl.h (lines 55-58)
+(@file{c:\mingw\mingw\include\objidl.h} (lines 55-58)
@item
-Unpack autoconf, automake to the MSYS directory (c:\mingw)
+Unpack autoconf, automake to the MSYS directory (@file{c:\mingw})
@item
-Install all other packages to the MinGW directory (c:\mingw\mingw\)
+Install all other packages to the MinGW directory (@file{c:\mingw\mingw\})
@end itemize
-@item
-@strong{GNU Libtool}@
-@
-GNU Libtool is required to use shared libraries.@
-@
-Get the prebuilt package from here and unpack it to the MinGW directory
-(c:\mingw)
+@item @strong{GNU Libtool}@
+GNU Libtool is required to use shared libraries.
+Get the prebuilt package from here and unpack it to the
+MinGW directory (@file{c:\mingw})
-@item
-@strong{Pthreads}@
-@
-GNUnet uses the portable POSIX thread library for multi-threading..@
+@item @strong{Pthreads}@
+GNUnet uses the portable POSIX thread library for multi-threading:
@itemize @bullet
-
-@item
-Save
+@item Save
@uref{ftp://sources.redhat.com/pub/pthreads-win32/dll-latest/lib/x86/libpthreadGC2.a, libpthreadGC2.a}
(x86) or
@uref{ftp://sources.redhat.com/pub/pthreads-win32/dll-latest/lib/x64/libpthreadGC2.a, libpthreadGC2.a}
(x64) as libpthread.a into the @file{lib}
directory (@file{c:\mingw\mingw\lib\libpthread.a}).
-@item
-Save
+@item Save
@uref{ftp://sources.redhat.com/pub/pthreads-win32/dll-latest/lib/x86/pthreadGC2.dll, pthreadGC2.dll}
(x86) or
@uref{ftp://sources.redhat.com/pub/pthreads-win32/dll-latest/lib/x64/pthreadGC2.dll, libpthreadGC2.a}
(x64) into the MinGW @file{bin} directory (@file{c:\mingw\mingw\bin}).
-@item
-Download all header files from
+@item Download all header files from
@uref{ftp://sources.redhat.com/pub/pthreads-win32/dll-latest/include/, include/}
to the @file{include} directory (@file{c:\mingw\mingw\include}).
@end itemize
-@item
-@strong{GNU MP@
-}@
-@
+@item @strong{GNU MP}@
GNUnet uses the GNU Multiple Precision library for special cryptographic
-operations.@
-@
-Get the GMP binary package from the
+operations. Get the GMP binary package from the
@uref{http://sourceforge.net/projects/mingwrep/, MinGW repository} and
-unpack it to the MinGW directory (c:\mingw\mingw)
+unpack it to the MinGW directory (@file{c:\mingw\mingw})
-@item
-@strong{GNU Gettext}@
-@
-GNU gettext is used to provide national language support.@
-@
+@item @strong{GNU Gettext}@
+GNU gettext is used to provide national language support.
Get the prebuilt package from hereand unpack it to the MinGW
-directory (c:\mingw\mingw)
+directory (@file{c:\mingw\mingw})
-@item
-@strong{GNU iconv}@
-@
-GNU Libiconv is used for character encoding conversion.@
-@
+@item @strong{GNU iconv}@
+GNU Libiconv is used for character encoding conversion.
Get the prebuilt package from here and unpack it to the MinGW
-directory (c:\mingw\mingw)
+directory (@file{c:\mingw\mingw}).
-@item
-@strong{SQLite}@
-@
-GNUnet uses the SQLite database to store data.@
-@
-Get the prebuilt binary from here and unpack it to your MinGW directory.
+@item @strong{SQLite}@
+GNUnet uses the SQLite database to store data.
+Get the prebuilt binary from here and unpack it to your MinGW directory.
@item @strong{MySQL}@
As an alternative to SQLite, GNUnet also supports MySQL.
@item Get the binary installer from the
@uref{http://dev.mysql.com/downloads/mysql/4.1.html#Windows, MySQL project}
-(version 4.1), install it and follow the instructions in README.mysql.
+(version 4.1), install it and follow the instructions in
+@file{README.mysql}.
-@item Create a temporary build directory (c:\mysql)
+@item Create a temporary build directory (@file{c:\mysql})
-@item Copy the directories include\ and lib\ from the MySQL directory to
-the new directory
+@item Copy the directories @file{include\} and @file{lib\} from the
+MySQL directory to the new directory
@item Get the patches from
@uref{http://bugs.mysql.com/bug.php?id=8906&files=1, Bug #8906} and
patch -p 0
@end example
-@item Move lib\opt\libmysql.dll to lib\libmysql.dll
+@item Move @file{lib\opt\libmysql.dll} to @file{lib\libmysql.dll}
-@item Change to lib\ and create an import library:@
+@item Change to @file{lib\} and create an import library:
@example
-dlltool --input-def ../include/libmySQL.def --dllname libmysql.dll
- --output-lib libmysqlclient.a -k
+dlltool --input-def ../include/libmySQL.def \
+--dllname libmysql.dll \
+--output-lib libmysqlclient.a -k
@end example
-@item Copy include\* to include\mysql\
+@item Copy include\* to include\mysql\
-@item Pass "--with-mysql=/c/mysql" to ./configure and copy libmysql.dll
+@item Pass @code{--with-mysql=/c/mysql} to
+@command{./configure} and copy @file{libmysql.dll}
to your PATH or GNUnet's @file{bin} directory
@end itemize
-@item
-@strong{GTK+}@
-@
-gnunet-gtk and libextractor depend on GTK.@
-@
-Get the the binary and developer packages of atk, glib, gtk, iconv,
-gettext-runtime, pango from
-@uref{ftp://ftp.gtk.org/pub/gtk/v2.6/win32, gtk.org} and unpack it to the
-MinGW directory (c:\mingw\mingw)@
-@
-Get @uref{http://www.gtk.org/download/win32.php, pkg-config} and libpng
-and unpack them to the MinGW directory (c:\mingw\mingw)@
-@
-Here is an all-in-one package for
+@item @strong{GTK+}@
+@command{gnunet-fs-gtk} and @command{libextractor} depend on GTK.
+Get the the binary and developer packages of @command{atk},
+@command{glib}, @command{gtk}, @command{iconv},
+@command{gettext-runtime}, @command{pango} from
+@uref{ftp://ftp.gtk.org/pub/gtk/v2.6/win32, gtk.org} and unpack them
+to the MinGW directory (@file{c:\mingw\mingw}).
+@c FIXME: The URL below for pkg-config seems wrong.
+Get @uref{http://www.gtk.org/download/win32.php, pkg-config} and
+@command{libpng} and unpack them to the MinGW directory
+(@file{c:\mingw\mingw}).
+Here is an all-in-one package for the
@uref{http://ftp.gnome.org/pub/gnome/binaries/win32/gtk+/2.24/gtk+-bundle_2.24.10-20120208_win32.zip, gtk+dependencies}
. Do not overwrite any existing files!
-@item
-@strong{Glade}@
-@
-gnunet-gtk and and gnunet-setup were created using this interface builder
+@item @strong{Glade}@
+@command{gnunet-*-gtk} and @command{gnunet-setup} were created using
+this interface builder
@itemize @bullet
+@item Get the Glade and libglade (-bin and -devel) packages
+(without GTK!) from
+@uref{http://gladewin32.sourceforge.net/, GladeWin32} and unpack them to
+the MinGW directory (@file{c:\mingw\mingw}).
-@item
-Get the Glade and libglade (-bin and -devel) packages (without GTK!) from
-@uref{http://gladewin32.sourceforge.net/, GladeWin32} and unpack it to
-the MinGW directory (c:\mingw\mingw)
-
-@item
-Get libxml from here and unpack it to the MinGW
-directory (c:\mingw\mingw).
+@item Get @command{libxml} from here and unpack it to the MinGW
+directory (@file{c:\mingw\mingw}).
@end itemize
-
-@item
-@strong{zLib}@
-@
-libextractor requires zLib to decompress some file formats. GNUnet uses it
-to (de)compress meta-data.@
-@
-Get zLib from here (Signature) and unpack it to the
-MinGW directory (c:\mingw\mingw)
-
-@item
-@strong{Bzip2}@
-@
-libextractor also requires Bzip2 to decompress some file formats.@
-@
-Get Bzip2 (binary and developer package) from
+@c FIXME: URLs
+@item @strong{zLib}@
+@command{libextractor} requires @command{zLib} to decompress some file
+formats. GNUnet uses it to (de)compress meta-data.
+Get zLib from here (Signature) and unpack it to the MinGW directory
+(@file{c:\mingw\mingw}).
+
+@item @strong{Bzip2}@
+@command{libextractor} also requires @command{Bzip2} to
+decompress some file formats.
+Get the Bzip2 (binary and developer package) from
@uref{http://gnuwin32.sourceforge.net/packages/bzip2.htm, GnuWin32} and
-unpack it to the MinGW directory (c:\mingw\mingw)
+unpack it to the MinGW directory (@file{c:\mingw\mingw}).
-@item
-@strong{Libgcrypt}@
-@
-Libgcrypt provides the cryptographic functions used by GNUnet@
-@
+@item @strong{Libgcrypt}@
+@command{Libgcrypt} provides the cryptographic functions used by GNUnet.
Get Libgcrypt from @uref{ftp://ftp.gnupg.org/gcrypt/libgcrypt/, here},
-compile and place it in the MinGW directory (c:\mingw\mingw). Currently
-you need at least version 1.4.2 to compile GNUnet.
+compile and place it in the MinGW directory
+(@file{c:\mingw\mingw}). Currently libgcrypt @geq{} 1.4.2 is required to
+compile GNUnet.
-@item
-@strong{PlibC}@
-@
-PlibC emulates Unix functions under Windows.@
-@
-Get PlibC from here and unpack it to the MinGW
-directory (c:\mingw\mingw)
+@item @strong{PlibC}@
+PlibC emulates Unix functions under Windows. Get PlibC from here and
+unpack it to the MinGW directory (c:\mingw\mingw)
-@item
-@strong{OGG Vorbis}@
-@
-OGG Vorbis is used to extract meta-data from .ogg files@
-@
+@item @strong{OGG Vorbis}@
+@command{OGG Vorbis} is used to extract meta-data from @file{.ogg} files.
Get the packages
@uref{http://www.gnunet.org/libextractor/download/win/libogg-1.1.4.zip, libogg}
and
@uref{http://www.gnunet.org/libextractor/download/win/libvorbis-1.2.3.zip, libvorbis}
from the
@uref{http://ftp.gnu.org/gnu/libextractor/libextractor-w32-1.0.0.zip, libextractor win32 build}
-and unpack them to the MinGW directory (c:\mingw\mingw)
+and unpack them to the MinGW directory (c:\mingw\mingw).
-@item
-@strong{Exiv2}@
-@
-(lib)Exiv2 is used to extract meta-data from files with Exiv2 meta-data@
-@
+@item @strong{Exiv2}@
+(lib)Exiv2 is used to extract meta-data from files with Exiv2 meta-data.
Download
@uref{http://www.gnunet.org/libextractor/download/win/exiv2-0.18.2.zip, Exiv2}
-and unpack it to the MSYS directory (c:\mingw)
+and unpack it to the MSYS directory (c:\mingw).
@end itemize
@node Building libextractor and GNUnet
@subsubsection Building libextractor and GNUnet
-Before you compile libextractor or GNUnet, be sure to set PKG_CONFIG_PATH:
+Before you compile @command{libextractor} or @command{GNUnet},
+be sure to set @code{PKG_CONFIG_PATH}:
@example
export PKG_CONFIG_PATH=/mingw/lib/pkgconfig
@end example
@noindent
-See Installation for basic instructions on building libextractor
-and GNUnet. By default, all modules that are created in this way contain
-debug information and are quite large. To compile release versions (small
-and fast) set the variable CFLAGS:
+@xref{GNUnet Installation Handbook}, for basic instructions on building
+@command{libextractor} and @command{GNUnet}.
+By default, all modules that are created in this way contain
+debug information and are quite large. To compile release versions
+(small and fast) set the variable @code{CFLAGS}:
@example
-export CFLAGS='-O2 -march=pentium -fomit-frame-pointer'
+export CFLAGS='-O2 -march=pentium -fomit-frame-pointer'
./configure --prefix=$HOME --with-extractor=$HOME
@end example
@node Source
@subsubsection Source
-The sources of all dependencies are available here.
+@c FIXME: URL
+The sources of all dependencies are available here.
-@node Portable GNUnet
-@section Portable GNUnet
+@c @node Portable GNUnet
+@c @section Portable GNUnet
-Quick instructions on how to use the most recent GNUnet on most GNU/Linux
-distributions
+@c Quick instructions on how to use the most recent GNUnet on most GNU/Linux
+@c distributions
-Currently this has only been tested on Ubuntu 12.04, 12.10, 13.04, Debian
-and CentOS 6, but it should work on almost any GNU/Linux distribution.
-More in-detail information can be found in the handbook.
+@c Currently this has only been tested on Ubuntu 12.04, 12.10, 13.04, Debian
+@c and CentOS 6, but it should work on almost any GNU/Linux distribution.
+@c More in-detail information can be found in the handbook.
-Note 2017-10: Currently this section assumes the old SVN repo of GNUnet
-which no longer exists.
+@c Note 2017-10: Currently this section assumes the old SVN repo of GNUnet
+@c which no longer exists.
-@menu
-* Prerequisites::
-* Download & set up gnunet-update::
-* Install GNUnet::
-@end menu
+@c @menu
+@c * Prerequisites::
+@c * Download & set up gnunet-update::
+@c * Install GNUnet::
+@c @end menu
-@node Prerequisites
-@subsection Prerequisites
+@c @node Prerequisites
+@c @subsection Prerequisites
-Open a terminal and paste this line into it to install all required tools
-needed:
+@c Open a terminal and paste this line into it to install all required tools
+@c needed:
-@example
-sudo apt-get install python-gpgme subversion
-@end example
+@c @example
+@c sudo apt-get install python-gpgme subversion
+@c @end example
-@node Download & set up gnunet-update
-@subsection Download & set up gnunet-update
+@c @node Download & set up gnunet-update
+@c @subsection Download & set up gnunet-update
-The following command will download a working version of gnunet-update
-with the subversion tool and import the public key which is needed for
-authentication:
+@c The following command will download a working version of gnunet-update
+@c with the subversion tool and import the public key which is needed for
+@c authentication:
-@example
-svn checkout -r24905 https://gnunet.org/svn/gnunet-update ~/gnunet-update
-cd ~/gnunet-update
-gpg --keyserver "hkp://keys.gnupg.net" --recv-keys 7C613D78
-@end example
+@c @example
+@c svn checkout -r24905 https://gnunet.org/svn/gnunet-update ~/gnunet-update
+@c cd ~/gnunet-update
+@c gpg --keyserver "hkp://keys.gnupg.net" --recv-keys 7C613D78
+@c @end example
-@node Install GNUnet
-@subsection Install GNUnet
+@c @node Install GNUnet
+@c @subsection Install GNUnet
-Download and install GNUnet binaries which can be found here and set
-library paths:
+@c Download and install GNUnet binaries which can be found here and set
+@c library paths:
-@example
-wget -P /tmp https://gnunet.org/install/packs/gnunet-0.9.4-`uname -m`.tgz
-./bin/gnunet-update install /tmp/gnunet-0.9*.tgz ~
-echo "PATH DEFAULT=$@{PATH@}:$HOME/bin" >> ~/.pam_environment
-echo -e "$@{HOME@}/lib\n$@{HOME@}/lib/gnunet-deps" | sudo tee \
- /etc/ld.so.conf.d/gnunet.conf > /dev/null
-sudo ldconfig
-@end example
+@c @example
+@c wget -P /tmp https://gnunet.org/install/packs/gnunet-0.9.4-`uname -m`.tgz
+@c ./bin/gnunet-update install /tmp/gnunet-0.9*.tgz ~
+@c echo "PATH DEFAULT=$@{PATH@}:$HOME/bin" >> ~/.pam_environment
+@c echo -e "$@{HOME@}/lib\n$@{HOME@}/lib/gnunet-deps" | sudo tee \
+@c /etc/ld.so.conf.d/gnunet.conf > /dev/null
+@c sudo ldconfig
+@c @end example
-You may need to re-login once after executing these last commands
+@c You may need to re-login once after executing these last commands
-That's it, GNUnet is installed in your home directory now. GNUnet can be
-configured and afterwards started by executing:
+@c That's it, GNUnet is installed in your home directory now. GNUnet can be
+@c configured and afterwards started by executing:
-@example
-gnunet-arm -s
-@end example
+@c @example
+@c gnunet-arm -s
+@c @end example
@node The graphical configuration interface
@section The graphical configuration interface
-If you also would like to use gnunet-gtk and gnunet-setup (highly
-recommended for beginners), do:
+If you also would like to use @command{gnunet-gtk} and
+@command{gnunet-setup} (highly recommended for beginners), do:
@example
wget -P /tmp \
sudo ldconfig
@end example
-Now you can run @code{gnunet-setup} for easy configuration of your
+Now you can run @command{gnunet-setup} for easy configuration of your
GNUnet peer.
@menu
This chapter will describe the various configuration options in GNUnet.
-The easiest way to configure your peer is to use the gnunet-setup tool.
-gnunet-setup is part of the gnunet-gtk download. You might have to
-install it separately.
+The easiest way to configure your peer is to use the
+@command{gnunet-setup} tool.
+@command{gnunet-setup} is part of the @command{gnunet-gtk}
+application. You might have to install it separately.
Many of the specific sections from this chapter actually are linked from
-within gnunet-setup to help you while using the setup tool.
+within @command{gnunet-setup} to help you while using the setup tool.
While you can also configure your peer by editing the configuration
-file by hand, this is not recommended for anyone except for developers.
-
+file by hand, this is not recommended for anyone except for developers
+as it requires a more in-depth understanding of the configuration files
+and internal dependencies of GNUnet.
@node Configuring the Friend-to-Friend (F2F) mode
@subsection Configuring the Friend-to-Friend (F2F) mode
-GNUnet knows three basic modes of operation. In standard "peer-to-peer"
-mode, your peer will connect to any peer. In the pure "friend-to-friend"
+GNUnet knows three basic modes of operation:
+@itemize @bullet
+@item In standard "peer-to-peer" mode,
+your peer will connect to any peer.
+@item In the pure "friend-to-friend"
mode, your peer will ONLY connect to peers from a list of friends
specified in the configuration.
-Finally, in mixed mode, GNUnet will only connect to arbitrary peers if it
+@item Finally, in mixed mode,
+GNUnet will only connect to arbitrary peers if it
has at least a specified number of connections to friends.
+@end itemize
-When configuring any of the F2F modes, you first need to create a file
-with the peer identities of your friends. Ask your friends to run
+When configuring any of the F2F ("friend-to-friend") modes,
+you first need to create a file with the peer identities
+of your friends. Ask your friends to run
@example
$ gnunet-peerinfo -sq
@end example
@noindent
-The output of this command needs to be added to your friends file, which
-is simply a plain text file with one line per friend with the output from
-the above command.
+The resulting output of this command needs to be added to your
+@file{friends} file, which is simply a plain text file with one line
+per friend with the output from the above command.
-You then specify the location of your friends file in the "FRIENDS"
-option of the "topology" section.
+You then specify the location of your @file{friends} file in the
+@code{FRIENDS} option of the "topology" section.
-Once you have created the friends file, you can tell GNUnet to only
-connect to your friends by setting the "FRIENDS-ONLY" option (again in
-the "topology" section) to YES.
+Once you have created the @file{friends} file, you can tell GNUnet to only
+connect to your friends by setting the @code{FRIENDS-ONLY} option
+(again in the "topology" section) to YES.
If you want to run in mixed-mode, set "FRIENDS-ONLY" to NO and configure a
minimum number of friends to have (before connecting to arbitrary peers)
under the "MINIMUM-FRIENDS" option.
If you want to operate in normal P2P-only mode, simply set
-"MINIMUM-FRIENDS" to zero and "FRIENDS_ONLY" to NO. This is the default.
+@code{MINIMUM-FRIENDS} to zero and @code{FRIENDS_ONLY} to NO.
+This is the default.
@node Configuring the hostlist to bootstrap
@subsection Configuring the hostlist to bootstrap
To get an initial connection to the GNUnet network and to get to know
peers already connected to the network you can use the so called
-bootstrap servers.
+"bootstrap servers".
These servers can give you a list of peers connected to the network.
To use these bootstrap servers you have to configure the hostlist daemon
to activate bootstrapping.
-To activate bootstrapping edit your configuration file and edit the
-@code{[hostlist]}-section. You have to set the argument "-b" in the
+To activate bootstrapping, edit the @code{[hostlist]}-section in your
+configuration file. You have to set the argument @command{-b} in the
options line:
@example
included. These lists are persistent, which means that they are saved to
your hard disk regularly and are loaded during startup.
-To activate hostlist learning you have to add the "-e" switch to the
-OPTIONS line in the hostlist section:
+To activate hostlist learning you have to add the @command{-e}
+switch to the @code{OPTIONS} line in the hostlist section:
@example
[hostlist]
@end example
@noindent
-Furthermore you can specify in which file the lists are saved. To save the
-lists in the file "hostlists.file" just add the line:
+Furthermore you can specify in which file the lists are saved.
+To save the lists in the file @file{hostlists.file} just add the line:
@example
HOSTLISTFILE = hostlists.file
The hostlist client can be configured to use a proxy to connect to the
hostlist server.
This functionality can be configured in the configuration file directly
-or using the gnunet-setup tool.
+or using the @command{gnunet-setup} tool.
The hostlist client supports the following proxy types at the moment:
@end itemize
In addition authentication at the proxy with username and password can be
-configured.
+configured.
-To configure proxy support for the hostlist client in the gnunet-setup
-tool, select the "hostlist" tab and select the appropriate proxy type.
+To configure proxy support for the hostlist client in the
+@command{gnunet-setup} tool, select the "hostlist" tab and select
+the appropriate proxy type.
The hostname or IP address (including port if required) has to be entered
in the "Proxy hostname" textbox. If required, enter username and password
in the "Proxy username" and "Proxy password" boxes.
-Be aware that these information will be stored in the configuration in
-plain text.
+Be aware that this information will be stored in the configuration in
+plain text (TODO: Add explanation and generalize the part in Chapter 3.6
+about the encrypted home).
-To configure these options directly in the configuration, you can
-configure the following settings in the @code{[hostlist]}
-section of the configuration:
+To provide these options directly in the configuration, you can
+enter the following settings in the @code{[hostlist]} section of
+the configuration:
@example
# Type of proxy server,
your peer to act as a hostlist server, providing other peers the list of
peers known to him.
-Yor server can act as a bootstrap server and peers needing to obtain a
-list of peers can contact him to download this list.
+Your server can act as a bootstrap server and peers needing to obtain a
+list of peers can contact it to download this list.
To download this hostlist the peer uses HTTP.
-For this reason you have to build your peer with libcurl and microhttpd
-support. How you build your peer with this options can be found here:
-@uref{https://gnunet.org/generic_installation}
+For this reason you have to build your peer with libgnurl (or libcurl)
+and microhttpd support.
+How you build your peer with these options can be found here:
+@xref{Generic installation instructions}.
To configure your peer to act as a bootstrap server you have to add the
-"@code{-p}" option to OPTIONS in the @code{[hostlist]} section of your
-configuration file. Besides that you have to specify a port number for
-the http server. In conclusion you have to add the following lines:
+@command{-p} option to @code{OPTIONS} in the @code{[hostlist]} section
+of your configuration file.
+Besides that you have to specify a port number for the http server.
+In conclusion you have to add the following lines:
@example
[hostlist]
@noindent
With this configuration your peer will a act as a bootstrap server and
-advertise this hostlist to other peers connecting to him. The URL used to
-download the list will be
+advertise this hostlist to other peers connecting to it.
+The URL used to download the list will be
@code{@uref{http://example.org:12981/, http://example.org:12981/}}.
Please notice:
+
@itemize @bullet
-@item The hostlist is not human readable, so you should not try to
+@item The hostlist is @b{not} human readable, so you should not try to
download it using your webbrowser. Just point your GNUnet peer to the
address!
@item Advertising without providing a hostlist does not make sense and
@node Configuring the datastore
@subsection Configuring the datastore
-The datastore is what GNUnet uses to for long-term storage of file-sharing
+The datastore is what GNUnet uses for long-term storage of file-sharing
data. Note that long-term does not mean 'forever' since content does have
an expiration date, and of course storage space is finite (and hence
sometimes content may have to be discarded).
-Use the "QUOTA" option to specify how many bytes of storage space you are
-willing to dedicate to GNUnet.
+Use the @code{QUOTA} option to specify how many bytes of storage space
+you are willing to dedicate to GNUnet.
In addition to specifying the maximum space GNUnet is allowed to use for
the datastore, you need to specify which database GNUnet should use to do
@itemize @bullet
-@item
-On up-to-date hardware where mysql can be used comfortably, this module
+@item On up-to-date hardware wher
+mysql can be used comfortably, this module
will have better performance than the other database choices (according
to our tests).
@subsection Setup Instructions
@itemize @bullet
-@item In @code{gnunet.conf} set in section "DATASTORE" the value for
-"DATABASE" to "mysql".
-@item Access mysql as root:@
+
+@item In @file{gnunet.conf} set in section @code{DATASTORE} the value for
+@code{DATABASE} to @code{mysql}.
+
+@item Access mysql as root:
@example
-$ mysql -u root -p
+$ mysql -u root -p
@end example
@noindent
and issue the following commands, replacing $USER with the username
-that will be running gnunet-arm (so typically "gnunet"):
+that will be running @command{gnunet-arm} (so typically "gnunet"):
@example
CREATE DATABASE gnunet;
@end example
@item
-In the $HOME directory of $USER, create a ".my.cnf" file with the
+In the $HOME directory of $USER, create a @file{.my.cnf} file with the
following lines
@example
@end itemize
-Thats it. Note that @code{.my.cnf} file is a slight security risk unless
-its on a safe partition. The $HOME/.my.cnf can of course be a symbolic
-link. Luckily $USER has only priviledges to mess up GNUnet's tables,
+Thats it. Note that @file{.my.cnf} file is a slight security risk unless
+its on a safe partition. The @file{$HOME/.my.cnf} can of course be
+a symbolic link.
+Luckily $USER has only priviledges to mess up GNUnet's tables,
which should be pretty harmless.
@node Testing
@end example
@noindent
-If you get the message "Database changed" it probably works.
+If you get the message
+
+@example
+Database changed
+@end example
+
+@noindent
+it probably works.
-If you get "ERROR 2002: Can't connect to local MySQL server@
-through socket '/tmp/mysql.sock' (2)" it may be resolvable by@
-"ln -s /var/run/mysqld/mysqld.sock /tmp/mysql.sock"@
+If you get
+
+@example
+ERROR 2002: Can't connect to local MySQL server
+through socket '/tmp/mysql.sock' (2)
+@end example
+
+@noindent
+it may be resolvable by
+
+@example
+ln -s /var/run/mysqld/mysqld.sock /tmp/mysql.sock
+@end example
+
+@noindent
so there may be some additional trouble depending on your mysql setup.
@node Performance Tuning
If you want to run the testcases, you must create a second database
"gnunetcheck" with the same username and password. This database will
-then be used for testing ("make check").
+then be used for testing (@command{make check}).
@node Configuring the Postgres database
@subsection Configuring the Postgres database
@subsection Manual setup instructions
@itemize @bullet
-@item In @code{gnunet.conf} set in section "DATASTORE" the value for
-"DATABASE" to "postgres".
-@item Access Postgres to create a user:@
+@item In @file{gnunet.conf} set in section @code{DATASTORE} the value for
+@code{DATABASE} to @code{postgres}.
+@item Access Postgres to create a user:
@table @asis
@item with Postgres 8.x, use:
@noindent
and enter the name of the user running GNUnet for the role interactively.
Then, when prompted, do not set it to superuser, allow the creation of
-databases, and do not allow the creation of new roles.@
+databases, and do not allow the creation of new roles.
@item with Postgres 9.x, use:
@end example
@noindent
-where $GNUNET_USER is the name of the user running GNUnet.@
+where $GNUNET_USER is the name of the user running GNUnet.
@end table
@item
-As that user (so typically as user "gnunet"), create a database (or two):@
+As that user (so typically as user "gnunet"), create a database (or two):
@example
$ createdb gnunet
@subsection Testing the setup manually
You may want to try if the database connection works. First, again login
-as the user who will run gnunet-arm. Then use,
+as the user who will run @command{gnunet-arm}. Then use:
@example
$ psql gnunet # or gnunetcheck
@end example
@noindent
-If, after you have started gnunet-arm at least once, you get
+If, after you have started @command{gnunet-arm} at least once, you get
a @code{gn090} table here, it probably works.
@node Configuring the datacache
system is rebooted).
You need to specify how many bytes GNUnet is allowed to use for the
-datacache using the "QUOTA" option in the section "dhtcache".
+datacache using the @code{QUOTA} option in the section @code{[dhtcache]}.
Furthermore, you need to specify which database backend should be used to
store the data. Currently, you have the choice between
sqLite, MySQL and Postgres.
In order to use GNUnet for file-sharing, you first need to make sure
that the file-sharing service is loaded.
-This is done by setting the AUTOSTART option in section "fs" to "YES".
-Alternatively, you can run
+This is done by setting the @code{AUTOSTART} option in
+section @code{[fs]} to "YES". Alternatively, you can run
@example
$ gnunet-arm -i fs
@subsection Configuring logging
Logging in GNUnet 0.9.0 is controlled via the "-L" and "-l" options.
-Using "-L", a log level can be specified. With log level "ERROR" only
-serious errors are logged.
-The default log level is "WARNING" which causes anything of
-concern to be logged. Log level "INFO" can be used to log anything that
-might be interesting information whereas "DEBUG" can be used by
-developers to log debugging messages (but you need to run configure with
+Using @code{-L}, a log level can be specified. With log level
+@code{ERROR} only serious errors are logged.
+The default log level is @code{WARNING} which causes anything of
+concern to be logged.
+Log level @code{INFO} can be used to log anything that might be
+interesting information whereas
+@code{DEBUG} can be used by developers to log debugging messages
+(but you need to run @code{./configure} with
@code{--enable-logging=verbose} to get them compiled).
-The "-l" option is used to specify the log file.
+The @code{-l} option is used to specify the log file.
Since most GNUnet services are managed by @code{gnunet-arm}, using the
-"-l" or "-L" options directly is not possible.
-Instead, they can be specified using the "OPTIONS" configuration value in
-the respective section for the respective service.
-In order to enable logging globally without editing the "OPTIONS" values
-for each service, @code{gnunet-arm} supports a "GLOBAL_POSTFIX" option.
+@code{-l} or @code{-L} options directly is not possible.
+Instead, they can be specified using the @code{OPTIONS} configuration
+value in the respective section for the respective service.
+In order to enable logging globally without editing the @code{OPTIONS}
+values for each service, @command{gnunet-arm} supports a
+@code{GLOBAL_POSTFIX} option.
The value specified here is given as an extra option to all services for
-which the configuration does contain a service-specific "OPTIONS" field.
+which the configuration does contain a service-specific @code{OPTIONS}
+field.
-"GLOBAL_POSTFIX" can contain the special sequence "@{@}" which is replaced
-by the name of the service that is being started. Furthermore,
-@code{GLOBAL_POSTFIX} is special in that sequences starting with "$"
-anywhere in the string are expanded (according to options in "PATHS");
-this expansion otherwise is only happening for filenames and then the "$"
-must be the first character in the option. Both of these restrictions do
-not apply to "GLOBAL_POSTFIX".
-Note that specifying @code{%} anywhere in the "GLOBAL_POSTFIX" disables
-both of these features.
+@code{GLOBAL_POSTFIX} can contain the special sequence "@{@}" which
+is replaced by the name of the service that is being started.
+Furthermore, @code{GLOBAL_POSTFIX} is special in that sequences
+starting with "$" anywhere in the string are expanded (according
+to options in @code{PATHS}); this expansion otherwise is
+only happening for filenames and then the "$" must be the
+first character in the option. Both of these restrictions do
+not apply to @code{GLOBAL_POSTFIX}.
+Note that specifying @code{%} anywhere in the @code{GLOBAL_POSTFIX}
+disables both of these features.
-In summary, in order to get all services to log at level "INFO" to
-log-files called @code{SERVICENAME-logs}, the following global prefix
-should be used:
+In summary, in order to get all services to log at level
+@code{INFO} to log-files called @code{SERVICENAME-logs}, the
+following global prefix should be used:
@example
GLOBAL_POSTFIX = -l $SERVICEHOME/@{@}-logs -L INFO
@item transport-wlan
-There is a special article how to setup the WLAN plugin, so here only the
-settings. Just specify the interface to use:
+The next section describes how to setup the WLAN plugin,
+so here only the settings. Just specify the interface to use:
@example
[transport-wlan]
@node Configuring the wlan transport plugin
@subsection Configuring the wlan transport plugin
-
The wlan transport plugin enables GNUnet to send and to receive data on a
wlan interface.
It has not to be connected to a wlan network as long as sender and
receiver are on the same channel. This enables you to get connection to
-the GNUnet where no internet access is possible, for example while
-catastrophes or when censorship cuts you off the internet.
+GNUnet where no internet access is possible, for example during
+catastrophes or when censorship cuts you off from the internet.
@menu
@subsubsection Before starting GNUnet
Before starting GNUnet, you have to make sure that your wlan interface is
-in monitor mode. One way to put the wlan interface into monitor mode (if
-your interface name is wlan0) is by executing:
+in monitor mode.
+One way to put the wlan interface into monitor mode (if your interface
+name is wlan0) is by executing:
@example
sudo airmon-ng start wlan0
connected to. If no connection has been made since the start of the
computer, it is usually the first channel of the card.
Peers will only find each other and communicate if they are on the same
-channel. Channels must be set manually (i.e. using
-@code{iwconfig wlan0 channel 1}).
+channel. Channels must be set manually, i.e. using:
+@example
+iwconfig wlan0 channel 1
+@end example
@node Configuring HTTP(S) reverse proxy functionality using Apache or nginx
@subsection Configuring HTTP(S) reverse proxy functionality using Apache or nginx
And we want the webserver to accept GNUnet traffic under
@code{http://www.foo.org/bar/}. The required steps are described here:
-@strong{Configure your Apache2 HTTP webserver}
+@menu
+* Reverse Proxy - Configure your Apache2 HTTP webserver::
+* Reverse Proxy - Configure your Apache2 HTTPS webserver::
+* Reverse Proxy - Configure your nginx HTTPS webserver::
+* Reverse Proxy - Configure your nginx HTTP webserver::
+* Reverse Proxy - Configure your GNUnet peer::
+@end menu
+
+@node Reverse Proxy - Configure your Apache2 HTTP webserver
+@subsubsection Reverse Proxy - Configure your Apache2 HTTP webserver
First of all you need mod_proxy installed.
</Location>
@end example
-@noindent
-@strong{Configure your Apache2 HTTPS webserver}
+@node Reverse Proxy - Configure your Apache2 HTTPS webserver
+@subsubsection Reverse Proxy - Configure your Apache2 HTTPS webserver
We assume that you already have an HTTPS server running, if not please
-check how to configure a HTTPS host. An easy to use example is the
-@file{apache2/sites-available/default-ssl} example configuration file.
+check how to configure a HTTPS host. An uncomplicated to use example
+is the example configuration file for Apache2/HTTPD provided in
+@file{apache2/sites-available/default-ssl}.
In the respective HTTPS @code{server config},@code{virtual host} or
@code{directory} section add the following lines:
@noindent
More information about the apache mod_proxy configuration can be found
-here: @uref{http://httpd.apache.org/docs/2.2/mod/mod_proxy.html#proxypass}
-.
+in the Apache documentation@footnote{@uref{http://httpd.apache.org/docs/2.2/mod/mod_proxy.html#proxypass, http://httpd.apache.org/docs/2.2/mod/mod_proxy.html#proxypass}}
-@strong{Configure your nginx HTTPS webserver}
+@node Reverse Proxy - Configure your nginx HTTPS webserver
+@subsubsection Reverse Proxy - Configure your nginx HTTPS webserver
Since nginx does not support chunked encoding, you first of all have to
-install @code{chunkin}: @uref{http://wiki.nginx.org/HttpChunkinModule}.
+install the @code{chunkin} module@footnote{@uref{http://wiki.nginx.org/HttpChunkinModule, http://wiki.nginx.org/HttpChunkinModule}}
To enable chunkin add:
In the @code{server} section add:
@example
-location /bar/
-@{
+location /bar/ @{
proxy_pass http://gnunet.foo.org:1080/;
proxy_buffering off;
proxy_connect_timeout 5; # more than http_server
@}
@end example
-@noindent
-@strong{Configure your nginx HTTPS webserver}
+@node Reverse Proxy - Configure your nginx HTTP webserver
+@subsubsection Reverse Proxy - Configure your nginx HTTP webserver
Edit your webserver configuration. Edit @file{/etc/nginx/nginx.conf} or
the site-specific configuration file.
@}
@end example
-@noindent
-@strong{Configure your GNUnet peer}
+@node Reverse Proxy - Configure your GNUnet peer
+@subsubsection Reverse Proxy - Configure your GNUnet peer
To have your GNUnet peer announce the address, you have to specify the
@code{EXTERNAL_HOSTNAME} option in the @code{[transport-http_server]}
client can be asked.
To blacklist peers using the configuration you have to add a section to
-your@ configuration containing the peer id of the peer to blacklist and
+your configuration containing the peer id of the peer to blacklist and
the plugin@ if required.
-Examples:@
+Examples:
To blacklist connections to P565... on peer AG2P... using tcp add:
@c FIXME: This is too long and produces errors in the pdf.
@example
-[transport-blacklist AG2PHES1BARB9IJCPAMJTFPVJ5V3A72S3F2A8SBUB8DAQ2V0O3V8G6G2JU56FHGFOHMQVKBSQFV98TCGTC3RJ1NINP82G0RC00N1520]@
-P565723JO1C2HSN6J29TAQ22MN6CI8HTMUU55T0FUQG4CMDGGEQ8UCNBKUMB94GC8R9G4FB2SF9LDOBAJ6AMINBP4JHHDD6L7VD801G = tcp@
+[transport-blacklist AG2PHES1BARB9IJCPAMJTFPVJ5V3A72S3F2A8SBUB8DAQ2V0O3V8G6G2JU56FHGFOHMQVKBSQFV98TCGTC3RJ1NINP82G0RC00N1520]
+P565723JO1C2HSN6J29TAQ22MN6CI8HTMUU55T0FUQG4CMDGGEQ8UCNBKUMB94GC8R9G4FB2SF9LDOBAJ6AMINBP4JHHDD6L7VD801G = tcp
@end example
To blacklist connections to P565... on peer AG2P... using all plugins add:
@example
-[transport-blacklist-AG2PHES1BARB9IJCPAMJTFPVJ5V3A72S3F2A8SBUB8DAQ2V0O3V8G6G2JU56FHGFOHMQVKBSQFV98TCGTC3RJ1NINP82G0RC00N1520]@
-P565723JO1C2HSN6J29TAQ22MN6CI8HTMUU55T0FUQG4CMDGGEQ8UCNBKUMB94GC8R9G4FB2SF9LDOBAJ6AMINBP4JHHDD6L7VD801G =@
+[transport-blacklist-AG2PHES1BARB9IJCPAMJTFPVJ5V3A72S3F2A8SBUB8DAQ2V0O3V8G6G2JU56FHGFOHMQVKBSQFV98TCGTC3RJ1NINP82G0RC00N1520]
+P565723JO1C2HSN6J29TAQ22MN6CI8HTMUU55T0FUQG4CMDGGEQ8UCNBKUMB94GC8R9G4FB2SF9LDOBAJ6AMINBP4JHHDD6L7VD801G =
@end example
-You can also add a blacklist client usign the blacklist api. On a
+You can also add a blacklist client usign the blacklist API. On a
blacklist check, blacklisting first checks internally if the peer is
blacklisted and if not, it asks the blacklisting clients. Clients are
asked if it is OK to connect to a peer ID, the plugin is omitted.
@node Configuration of the HTTP and HTTPS transport plugins
@subsection Configuration of the HTTP and HTTPS transport plugins
-The client part of the http and https transport plugins can be configured
+The client parts of the http and https transport plugins can be configured
to use a proxy to connect to the hostlist server. This functionality can
be configured in the configuration file directly or using the
gnunet-setup tool.
-The both the HTTP and HTTPS clients support the following proxy types at
+Both the HTTP and HTTPS clients support the following proxy types at
the moment:
@itemize @bullet
in the configuration in plain text.
To configure these options directly in the configuration, you can
-configure the following settings in the [transport-http_client] and
-[transport-https_client] section of the configuration:
+configure the following settings in the @code{[transport-http_client]}
+and @code{[transport-https_client]} section of the configuration:
@example
# Type of proxy server,
* GNS Proxy Setup::
* Setup of the GNS CA::
* Testing the GNS setup::
-* Automatic Shortening in the GNU Name System::
@end menu
First of all, GNS needs to be integrated with the operating system. Most
of this section is about the operating system level integration.
-Additionally, each individual user who wants to use the system must also
-initialize his GNS zones. This can be done by running (after starting
-GNUnet)
-
-@example
-$ gnunet-gns-import.sh
-@end example
-
-@noindent
-after the local GNUnet peer has been started. Note that the namestore (in
-particular the namestore database backend) should not be reconfigured
-afterwards (as records are not automatically migrated between backends).
-
The remainder of this chapter will detail the various methods for
configuring the use of GNS with your operating system.
@subsubsection Configuring the GNS nsswitch plugin
The Name Service Switch (NSS) is a facility in Unix-like operating systems
+@footnote{More accurate: NSS is a functionality of the GNU C Library}
that provides a variety of sources for common configuration databases and
name resolution mechanisms.
-A system administrator usually configures the operating system's name
-services using the file @file{/etc/nsswitch.conf}.
+A superuser (system administrator) usually configures the
+operating system's name services using the file
+@file{/etc/nsswitch.conf}.
GNS provides a NSS plugin to integrate GNS name resolution with the
operating system's name resolution process.
Name resolution is controlled by the @emph{hosts} section in the NSS
configuration. By default this section first performs a lookup in the
-/etc/hosts file and then in DNS. The nsswitch file should contain a line
-similar to:
+@file{/etc/hosts} file and then in DNS.
+The nsswitch file should contain a line similar to:
@example
hosts: files dns [NOTFOUND=return] mdns4_minimal mdns4
CA certificate to generate @code{*.gnu} client certificates on the fly.
Note that the proxy uses libcurl. Make sure your version of libcurl uses
-GnuTLS and NOT OpenSSL. The proxy will not work with libcurl compiled
+GnuTLS and NOT OpenSSL. The proxy will @b{not} work with libcurl compiled
against OpenSSL.
+You can check the configuration your libcurl was build with by
+running:
+
+@example
+curl --version
+@end example
+
+the output will look like this (without the linebreaks):
+
+@example
+gnurl --version
+curl 7.56.0 (x86_64-unknown-linux-gnu) libcurl/7.56.0 \
+GnuTLS/3.5.13 zlib/1.2.11 libidn2/2.0.4
+Release-Date: 2017-10-08
+Protocols: http https
+Features: AsynchDNS IDN IPv6 Largefile NTLM SSL libz \
+TLS-SRP UnixSockets HTTPS-proxy
+@end example
+
@node Testing the GNS setup
@subsubsection Testing the GNS setup
the SSL functionality of the proxy:
@example
-$ gnunet-namestore -a -e "1 d" -n "homepage" -t A -V 131.159.74.67
-$ gnunet-namestore -a -e "1 d" -n "homepage" -t LEHO -V "gnunet.org"
+$ gnunet-identity -C test
+$ gnunet-namestore -a -e "1 d" -n "homepage" \
+ -t A -V 131.159.74.67 -z test
+$ gnunet-namestore -a -e "1 d" -n "homepage" \
+ -t LEHO -V "gnunet.org" -z test
@end example
@noindent
@noindent
Configure your browser to use this SOCKSv5 proxy on port 7777 and visit
this link.
-If you use firefox you also have to go to about:config and set the key
+If you use @command{Firefox} (or one of its deriviates/forks such as
+Icecat) you also have to go to @code{about:config} and set the key
@code{network.proxy.socks_remote_dns} to @code{true}.
-When you visit @code{https://homepage.gnu/}, you should get to the
+When you visit @code{https://homepage.test/}, you should get to the
@code{https://gnunet.org/} frontpage and the browser (with the correctly
configured proxy) should give you a valid SSL certificate for
@code{homepage.gnu} and no warnings. It should look like this:
-@c insert image here gnunethpgns.png
-
-@node Automatic Shortening in the GNU Name System
-@subsubsection Automatic Shortening in the GNU Name System
-
-This page describes a possible option for 'automatic name shortening',
-which you can choose to enable with the GNU Name System.
-
-When GNS encounters a name for the first time, it can use the 'NICK'
-record of the originating zone to automatically generate a name for the
-zone. If automatic shortening is enabled, those auto-generated names will
-be placed (as private records) into your personal 'shorten' zone (to
-prevent confusion with manually selected names).
-Then, in the future, if the same name is encountered again, GNS will
-display the shortened name instead (the first time, the long name will
-still be used as shortening typically happens asynchronously as looking up
-the 'NICK' record takes some time). Using this feature can be a convenient
-way to avoid very long @code{.gnu} names; however, note that names from
-the shorten-zone are assigned on a first-come-first-serve basis and should
-not be trusted. Furthermore, if you enable this feature, you will no
-longer see the full delegation chain for zones once shortening has been
-applied.
+@c FIXME: Image does not exist, create it or save it from Drupal?
+@c @image{images/gnunethpgns.png,5in,, picture of homepage.gnu in Webbrowser}
+
@node Configuring the GNUnet VPN
@subsection Configuring the GNUnet VPN
Before configuring the GNUnet VPN, please make sure that system-wide DNS
interception is configured properly as described in the section on the
-GNUnet DNS setup.
-
-The default-options for the GNUnet VPN are usually sufficient to use
-GNUnet as a Layer 2 for your Internet connection. However, what you always
-have to specify is which IP protocol you want to tunnel: IPv4, IPv6 or
-both. Furthermore, if you tunnel both, you most likely should also tunnel
+GNUnet DNS setup. @pxref{Configuring the GNU Name System},
+if you haven't done so already.
+
+The default options for the GNUnet VPN are usually sufficient to use
+GNUnet as a Layer 2 for your Internet connection.
+However, what you always have to specify is which IP protocol you want
+to tunnel: IPv4, IPv6 or both.
+Furthermore, if you tunnel both, you most likely should also tunnel
all of your DNS requests.
You theoretically can tunnel "only" your DNS traffic, but that usually
makes little sense.
This is the IPv4 address the VPN interface will get. You should pick an
'private' IPv4 network that is not yet in use for you system. For example,
-if you use 10.0.0.1/255.255.0.0 already, you might use
-10.1.0.1/255.255.0.0.
-If you use 10.0.0.1/255.0.0.0 already, then you might use
-192.168.0.1/255.255.0.0.
+if you use @code{10.0.0.1/255.255.0.0} already, you might use
+@code{10.1.0.1/255.255.0.0}.
+If you use @code{10.0.0.1/255.0.0.0} already, then you might use
+@code{192.168.0.1/255.255.0.0}.
If your system is not in a private IP-network, using any of the above will
work fine.
-You should try to make the mask of the address big enough (255.255.0.0
-or, even better, 255.0.0.0) to allow more mappings of remote IP Addresses
-into this range.
-However, even a 255.255.255.0-mask will suffice for most users.
+You should try to make the mask of the address big enough
+(@code{255.255.0.0} or, even better, @code{255.0.0.0}) to allow more
+mappings of remote IP Addresses into this range.
+However, even a @code{255.255.255.0} mask will suffice for most users.
@node IPv6 address for interface
@subsubsection IPv6 address for interface
The IPv6 address the VPN interface will get. Here you can specify any
-non-link-local address (the address should not begin with "fe80:").
-A subnet Unique Local Unicast (fd00::/8-prefix) that you are currently
-not using would be a good choice.
+non-link-local address (the address should not begin with @code{fe80:}).
+A subnet Unique Local Unicast (@code{fd00::/8} prefix) that you are
+currently not using would be a good choice.
@node Configuring the GNUnet VPN DNS
@subsubsection Configuring the GNUnet VPN DNS
system-wide services.
Note that the normal user may run gnunet-setup, but the
configuration would be ineffective as the system-wide services will use
-@code{/etc/gnunet.conf} and ignore options set by individual users.
+@file{/etc/gnunet.conf} and ignore options set by individual users.
Again, each user should then start the peer using
-@code{gnunet-arm -s} --- and strongly consider adding logic to start
+@file{gnunet-arm -s} --- and strongly consider adding logic to start
the peer automatically to their crontab.
Afterwards, you should see two (or more, if you have more than one USER)
Furthermore, 'make install' will silently fail to set the DNS binaries to
be owned by group "gnunetdns" unless that group already exists (!).
An alternative name for the "gnunetdns" group can be specified using the
-"--with-gnunetdns=GRPNAME" configure option.
-
+@code{--with-gnunetdns=GRPNAME} configure option.
projects / oweals / gnunet.git / blobdiff