[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[GNUnet-SVN] [gnunet] branch master updated (8503c6fa2 -> 9417d4af8)
|
From: |
gnunet |
|
Subject: |
[GNUnet-SVN] [gnunet] branch master updated (8503c6fa2 -> 9417d4af8) |
|
Date: |
Wed, 13 Jun 2018 11:18:18 +0200 |
This is an automated email from the git hooks/post-receive script.
ng0 pushed a change to branch master
in repository gnunet.
from 8503c6fa2 rps profiler: cleaned debug output
new 6decfbd4c contrib: rename scripts/report.sh to
scripts/gnunet-bugreport and install it.
new a37d06cb3 extend the list of known package maintainers
new 52de9c044 Add GPL2 licensed openrc service file
new c99d62c68 gnunet-bugreport: GNUtls->GnuTLS
new afbd424f7 README rework part 1
new a4f268904 documentation: Remove installation
new 63775bc55 doc: stagging file 'FROM_SOURCE' with old repetive
instructions
new 037923980 guix-env.scm: Add python2-future.
new d8cba9f05 doc: create system specific folder and move files into it
new c70305038 README: Mention further reading material
new 9c6274c6a Fix the link to the preliminary documentation
new 0183db872 documentation: user + developer changes
new 01b37d9db doc: Add new files to Makefile.
new 1f7a2dd68 some changes and work in user handbook.
new 5c7f4f919 Merge branch 'master' of gnunet.org:gnunet
new e82af68d6 seems like mysql is currently broken in Guix
new 787d5e9e1 fix
new d3e476635 fix
new 9417d4af8 mariadb
The 19 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
AUTHORS | 9 +-
README | 255 +-
contrib/Makefile.am | 2 +-
contrib/scripts/documentation/gnunet-doc.scm | 66 +-
contrib/scripts/{report.sh => gnunet-bugreport} | 2 +-
contrib/services/openrc/gnunet.initd | 82 +
doc/Makefile.am | 3 +-
doc/documentation/Makefile.am | 1 -
doc/documentation/chapters/developer.texi | 384 +-
doc/documentation/chapters/installation.texi | 4149 --------------------
doc/documentation/chapters/user.texi | 1972 +++++++++-
doc/documentation/gnunet.texi | 33 +-
doc/system_specific/FROM_SOURCE | 1423 +++++++
.../outdated-and-old-installation-instructions.txt | 0
guix-env.scm | 3 +-
15 files changed, 4100 insertions(+), 4284 deletions(-)
rename contrib/scripts/{report.sh => gnunet-bugreport} (99%)
create mode 100644 contrib/services/openrc/gnunet.initd
delete mode 100644 doc/documentation/chapters/installation.texi
create mode 100644 doc/system_specific/FROM_SOURCE
rename doc/{ =>
system_specific}/outdated-and-old-installation-instructions.txt (100%)
diff --git a/AUTHORS b/AUTHORS
index ef7e2eb9d..718038ab8 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -113,12 +113,17 @@ GNU with Net : Christian Muellner <address@hidden>
AFS Face : Alex Jones <address@hidden>
new GNU in Net: Nicklas Larsson <address@hidden>
-Maintainers:
+Package Maintainers (current and previous):
FreeBSD : Kirill Ponomarew <address@hidden>
-Debian GNU/Linux: Daniel Baumann <address@hidden>
+Debian GNU/Linux: Bertrand Marc <address@hidden>
+ Daniel Baumann <address@hidden>
+ Arnaud Kyheng
+ Glenn McGrath <address@hidden>
+Nix: : viric, rahul
OpenWrt/LEDE : Daniel Golle <address@hidden>
OS X : Jussi Eloranta <address@hidden>
Gentoo : Carlo von lynX <psyc://loupsycedyglgamf.onion/~lynX>
+ Nils Gillmann <address@hidden>
If you have contributed and are not listed here, please
notify one of the maintainers in order to be added.
diff --git a/README b/README
index 61c54b4f4..dc0b4b8fb 100644
--- a/README
+++ b/README
@@ -22,7 +22,7 @@ in src/include/gnunet_util_lib.h to point to the source code
of your
fork!
Additional documentation about GNUnet can be found at
-https://gnunet.org/ and in the doc/ folder.
+https://gnunet.org/ and in the 'doc/' folder.
Dependencies:
@@ -30,6 +30,54 @@ Dependencies:
These are the direct dependencies for running GNUnet:
+- libmicrohttpd >= 0.9.42
+- libgcrypt >= 1.6
+- libgnurl >= 7.35.0 (recommended, available from
https://gnunet.org/gnurl)
+- libcurl >= 7.35.0 (alternative to libgnurl)
+- libunistring >= 0.9.2
+- gnutls >= 3.2.12 (highly recommended a gnutls linked
against libunbound)
+- libidn >= 1.0
+- libextractor >= 0.6.1 (highly recommended)
+- openssl >= 1.0 (binary, used to generate X.509
certificate)
+- libltdl >= 2.2 (part of GNU libtool)
+- sqlite >= 3.8 (default database, required)
+- mysql >= 5.1 (alternative to sqlite)
+- postgres >= 9.5 (alternative to sqlite)
+- Texinfo >= 5.2 [*1]
+- which (for the bootstrap script)
+- gettext
+- zlib
+- pkg-config
+
+
+These are the dependencies for GNUnet's testsuite:
+
+- Bash (optional (?), for some tests)
+- python >= 2.7 (optional, only python 2.7 is supported)
+- python-future >= 2.7 (optional, only python 2.7 is supported)
+
+
+These are the optional dependencies:
+
+- libopus >= 1.0.1 (optional, for experimental conversation
tool)
+- libpulse >= 2.0 (optional, for experimental conversation
tool)
+- libogg >= 1.3.0 (optional, for experimental conversation
tool)
+- libnss (optional, certtool binary (for convenient
installation of GNS proxy))
+- python-future (optional, for some testcases and
utilities)
+- python-zbar >= 0.10 (optional, for gnunet-qr)
+- TeX Live >= 2012 (optional, for gnunet-bcd[*])
+- libglpk >= 4.45 (optional, for experimental code)
+- perl5 (optional, for some utilities)
+- python >= 2.7 (optional, for gnunet-qr, only python 2.7
is supported)
+- bluez (optional, for bluetooth support)
+- miniupnpc
+- libpbc >= 0.5.14 (optional, for Attribute-Based Encryption
and Identity Provider functionality)
+- libgabe (optional, for Attribute-Based Encryption
and Identity Provider functionality,
+ from https://github.com/schanzen/libgabe)
+
+=======
+These are the direct dependencies for running GNUnet:
+
- libmicrohttpd >= 0.9.52
- libgcrypt >= 1.6
- libgnurl >= 7.35.0 (available from https://gnunet.org/gnurl)
@@ -51,53 +99,134 @@ These are the direct dependencies for running GNUnet:
- libglpk >= 4.45 (optional for experimental code)
Recommended autotools for compiling the git version are:
-- autoconf >= 2.59
-- automake >= 1.11.1
-- libtool >= 2.2
+
+- autoconf >= 2.59
+- automake >= 1.11.1
+- libtool >= 2.2
[*] Mandatory for compiling the info output of the documentation,
-a limited subset ('texlive-tiny' in Guix) is enough.
+ a limited subset ('texlive-tiny' in Guix) is enough.
+
+[*1] The default configuration is to build the info output of the
+ documentation, and therefore require texinfo. You can pass
+ '--disable-documentation' to the configure script to change this.
+
+Requirements
+============
-[*1] The default configuration is to build the info output of the
documentation,
-and therefore require texinfo. You can pass --disable-documentation to
-the configure script to change this.
+GNUnet's directed acyclic graph (DAG) will require around 0.74 GiB
+Diskspace, with GNUNet itself taking around 9.2 MiB reported by the
+build on GNU Guix.
How to install?
===============
-The fastest way is to use a binary package if it is available for your
-system. For a more detailed description, read the installation
-instructions on the webpage at https://gnunet.org/installation.
+
+binary packages
+~~~~~~~~~~~~~~~
+
+We recommend to use binary packages provided by your Operating System's
+package manager. GNUnet is reportedly available for at least:
+
+Gentoo (via the 'youbroketheinternet' overlay), GNU Guix, Nix,
+Debian, ALT Linux, Archlinux, Deepin, Devuan, Hyperbola, Kali Linux,
+LEDE/OpenWRT, Manjaro, Parabola, Pardus, Parrot, PureOS, Raspbian,
+Rosa, Trisquel, and Ubuntu.
+
+If GNUnet is available for your Operating System and it is missing,
+send us feedback so that we can add it to this list. Furthermore, if
+you are interested in packaging GNUnet for your Operating System,
+get in touch with us at address@hidden if you require
+help with this job.
+
+If you were using an Operating System with the apt package manager,
+GNUnet could be installed as simple as:
+
+$ apt-get install gnunet
+
Generic installation instructions are in the INSTALL file in this
directory.
+Scope of Operating System support
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+We actively support GNUnet on a broad range of Free Software Operating
+Systems.
+
+For proprietary Operating Systems, like for example Microsoft Windows
+or Apple OS X, we accept patches if they don't break anything for
+other Operating Systems.
+If you are implementing support for a proprietary Operating System,
+you should be aware that progress in our codebase could break
+functionality on your OS and cause unpredicted behavior we can
+not test. However, we do not break support on Operating Systems
+with malicious intent.
+Regressions which do occur on these Operating Systems are 3rd
+class issues and we expect users and developers of these
+Operating Systems to send proposed patches to fix regressions.
+
+For more information about our stand on some of the motivating
+points here, read the 'Philosophy' Chapter of our handbook.
+
+Building GNUnet from source
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+IMPORTANT: You can read further notes about compilation from source in
+the 'doc/FILENAME' document, which includes notes about specific
+requirements for operating systems aswell. If you are a package
+mantainer for an Operating System we invite you to add your notes if
+you feel it is necessary and can not be covered in your Operating
+System's documentation.
+
+
+Some Operating Systems currently require you to build GNUnet from
+source.
+If you are building GNUnet from source you are either interested
+in furthering its development (we have further notes for developer
+builds in our 'GNUnet Developer Handbook') or your Operating System
+simply lacks support for a binary package at the moment.
+Two prominent examples which currently lack cross-compilation
+support in GNUnet (and native binaries) are MS Windows and Apple macOS.
+For macOS we recommend you to do the build process via Homebrew and a
+recent XCode installation.
+Compilation for MS Windows can ...
+
Note that some functions of GNUnet require "root" access. GNUnet will
install (tiny) SUID binaries for those functions is you run "make
install" as root. If you do not, GNUnet will still work, but some
functionality will not be available (including certain forms of NAT
traversal).
-GNUnet requires the GNU MP library (http://www.gnu.org/software/gmp/)
-and libgcrypt (http://www.gnupg.org/). You can specify the path to
+GNUnet requires the GNU MP library (https://www.gnu.org/software/gmp/)
+and libgcrypt (https://www.gnupg.org/). You can specify the path to
libgcrypt by passing "--with-gcrypt=PATH" to configure. You will also
need either sqlite (http://www.sqlite.org/), MySQL
(http://www.mysql.org/) or PostGres (http://www.postgres.org/).
If you install from source, you need to install GNU libextractor first
-(download from http://www.gnu.org/software/libextractor/). We also
+(download from https://www.gnu.org/software/libextractor/). We also
recommend installing GNU libmicrohttpd (download from
-http://www.gnu.org/software/libmicrohttpd/). Then you can start the
-actual GNUnet compilation and installation process with:
+https://www.gnu.org/software/libmicrohttpd/). Furthermore we recommend
+libgnurl (from https://gnunet.org/gnurl).
+Then you can start the actual GNUnet compilation process with:
+
$ export GNUNET_PREFIX=/usr/local/lib # or other directory of your choice
# addgroup gnunetdns
# adduser --system --home "/var/lib/gnunet" --group gnunet --shell /bin/sh
# ./configure --prefix=$GNUNET_PREFIX/.. --with-extractor=$LE_PREFIX
$ make
+
+And finally install GNUnet with:
+
# make install
+
+Complete the process by either adjusting one of our example service files
+in 'contrib/services' or by running:
+
# sudo -u gnunet gnunet-arm -s
+
Note that running the 'configure' and 'make install' steps as
root (or with sudo) is required as some parts of the installation
require the creation of SUID binaries. The installation will
@@ -131,7 +260,7 @@ certain binaries that require additional priviledges will
not be
installed properly (and autonomous NAT traversal, WLAN, DNS/GNS and
the VPN will then not work).
-If you run 'configure' and 'make install' as root or use the SUDO
+If you run 'configure' and 'make install' as root or use the '--with-sudo'
option, GNUnet's build system will install "libnss_gns*" libraries to
"/lib/" regardless (!) of the $GNUNET_PREFIX you might have specified,
as those libraries must be in "/lib/". If you are packaging GNUnet
@@ -139,14 +268,14 @@ for binary distribution, this may cause your packaging
script to miss
those plugins, so you might need to do some additional manual work to
include those libraries in your binary package(s). Similarly, if you
want to use the GNUnet naming system and did NOT run GNUnet's 'make
-install' process with SUDO rights, the libraries will be installed to
+install' process with sudo rights, the libraries will be installed to
"$GNUNET_PREFIX" and you will have to move them to "/lib/"
manually.
Finally, if you are compiling the code from git, you have to
-run ". bootstrap" before ./configure. If you receive an error during
-the running of ". bootstrap" that looks like "macro `AM_PATH_GTK' not
-found in library", you may need to run aclocal by hand with the -I
+run "sh ./bootstrap" before running "./configure". If you receive an error
during
+the running of "sh ./bootstrap" that looks like "macro `AM_PATH_GTK'
+not found in library", you may need to run aclocal by hand with the -I
option, pointing to your aclocal m4 macros, i.e.
$ aclocal -I /usr/local/share/aclocal
@@ -165,7 +294,7 @@ configuration for the peer. gnunet-setup can be used to
configure and
test (!) the network settings, choose which applications should be run
and configure databases. Other options you might want to control
include system limitations (such as disk space consumption, bandwidth,
-etc.). The resulting configuration files are human-readable and can
+etc). The resulting configuration files are human-readable and can
theoretically be created or edited by hand.
gnunet-setup is a separate download and requires somewhat recent
@@ -181,10 +310,17 @@ configuration file should be located in
"~/.config/gnunet.conf" or its
location can be specified by giving the "-c" option to the respective
GNUnet application.
+For more information about the configuration (as well as usage) refer
+to the 'GNUnet User Handbook' chapter of the documentation, included
+in this software distribution.
+
Usage
=====
+For detailed usage notes, instructions and examples, refer to the
+included 'GNUnet User Handbook'.
+
First, you must obtain an initial list of GNUnet hosts. Knowing a
single peer is sufficient since after that GNUnet propagates
information about other peers. Note that the default configuration
@@ -210,9 +346,9 @@ UDP or WLAN will discover each other automatically (if they
are in the
vicinity of each other) using broadcasts (IPv4/WLAN) or multicasts
(IPv6).
-The local node is started using "gnunet-arm -s". GNUnet should run
-24/7 if you want to maximize your anonymity, as this makes partitioning
-attacks harder.
+The local node is started using "gnunet-arm -s". We recommend to run
+GNUnet 24/7 if you want to maximize your anonymity, as this makes
+partitioning attacks harder.
Once your peer is running, you should then be able to access GNUnet
using the shell:
@@ -229,42 +365,47 @@ together with a description. To publish files on GNUnet,
use the
"gnunet-publish" command.
-The GTK user interface is shipped separately. After downloading and
-installing gnunet-gtk, you can invoke the setup tool and the
-file-sharing GUI with:
+The GTK+ (or: Gimp Toolkit) user interface is shipped separately.
+After installing gnunet-gtk, you can invoke the setup tool and
+the file-sharing GUI with:
$ gnunet-setup
$ gnunet-fs-gtk
-For further documentation, see our webpage.
+For further documentation, see our webpage or the 'GNUnet User Handbook',
+included in this software distribution.
Hacking GNUnet
==============
-Contributions are welcome, please submit bugs to
-https://gnunet.org/bugs/. Please make sure to run contrib/report.sh
+Contributions are welcome. Please submit bugs you find to
+https://gnunet.org/bugs/.
+Please make sure to run the script "contrib/scripts/gnunet-bugreport"
and include the output with your bug reports. More about how to
report bugs can be found in the GNUnet FAQ on the webpage. Submit
-patches via E-Mail to address@hidden
+patches via E-Mail to address@hidden, formated with
+`git format-patch`.
-In order to run the unit tests with by hand (instead of using
-"make check"), you need to
-set an environment variable ("GNUNET_PREFIX") to the directory
-where GNUnet's libraries are installed.
-Also, before running any testcases, you must
-complete the installation first. Quick summary:
+In order to run the unit tests by hand (instead of using "make check"),
+you need to set the environment variable "GNUNET_PREFIX" to the
+directory where GNUnet's libraries are installed.
+Before running any testcases, you must complete the installation.
+
+Quick summary:
$ ./configure --prefix=$SOMEWHERE
$ make
$ make install
+$ export $GNUNET_PREFIX=$SOMEWHERE
$ make check
-Some of the testcases require python >= 2.6 (+ the python module "futures")
-and pexpect to be installed. If any testcases fail to pass on your system, run
-"contrib/scripts/report.sh" (in the repository) or "gnunet-bugreport"
-when you already have GNUnet installed and report the output together with
-information about the failing testcase to the Mantis bugtracking
+Some of the testcases require python >= 2.7, and the python modules
+"python-future" (http://python-future.org/) and "pexpect" to be installed.
+If any testcases fail to pass on your system, run
+"contrib/scripts/gnunet-bugreport" (in the repository) or "gnunet-bugreport"
+when you already have GNUnet installed and report its output together with
+information about the failing testcase(s) to the Mantis bugtracking
system at https://gnunet.org/bugs/.
@@ -304,6 +445,34 @@ throttled by ISPs that dislike P2P. Details for
configuring the
reverse proxy are documented on our website.
+Further Reading
+===============
+
+* Documentation
+
+ A preliminary rendering of the new GNUnet manual is deployed at
+
+ https://d.n0.is/pub/doc/gnunet/manual/
+
+ we plan to have a complete new gnunet.org up and running in 2019.
+ This website output exists as a convenience solution until then.
+
+* Academia / papers
+
+ In almost 20 years various people in our community have written and
+ collected a good number of papers which have been implemented in
+ GNUnet or projects around GNUnet.
+ There are currently 2 ways to get them:
+
+ * Using git:
+ git clone https://gnunet.org/git/bibliography.git
+ * Using Drupal:
+ https://gnunet.org/bibliography
+
+ The Drupal access will be replaced by a new interface to our
+ bibliography in 2019.
+
+
Stay tuned
==========
diff --git a/contrib/Makefile.am b/contrib/Makefile.am
index 56fcb9aea..27b1d01bc 100644
--- a/contrib/Makefile.am
+++ b/contrib/Makefile.am
@@ -32,7 +32,6 @@ dist_pkgdata_DATA = \
gns/gns-form.xslt \
branding/logo/gnunet-logo.pdf \
branding/logo/gnunet-logo-color.png \
- scripts/report.sh \
testing_hostkeys.ecc
if MINGW
@@ -126,6 +125,7 @@ install-data-local:
$(INSTALL_DATA) $$hello $(DESTDIR)$(pkghellodir)/ ; \
fi \
done
+ install scripts/gnunet-bugreport $(bindir)/gnunet-bugreport
dist-hook:
if test -d $(srcdir)/hellos; then \
diff --git a/contrib/scripts/documentation/gnunet-doc.scm
b/contrib/scripts/documentation/gnunet-doc.scm
index 4ae23b298..077efacad 100644
--- a/contrib/scripts/documentation/gnunet-doc.scm
+++ b/contrib/scripts/documentation/gnunet-doc.scm
@@ -76,17 +76,17 @@
(string-append (current-source-directory)
"/../../../"))
source-file?))))
- (package
+ (package
(name "gnunet-doc")
(version (string-append "0.10.1-" revision "." "dev"))
(source
(local-file ;;"../../.."
- ;;%source-dir
- ;;(string-append (getcwd) "/../../../")
- (string-append (getcwd)) ;drrty hack and this assumes one
static position FIXME!
- #:recursive? #t))
- ;;#:select? (git-predicate %source-dir)))
- ;;#:select? (force select?)))
+ ;;%source-dir
+ ;;(string-append (getcwd) "/../../../")
+ (string-append (getcwd)) ;drrty hack and this assumes one static
position FIXME!
+ #:recursive? #t))
+ ;;#:select? (git-predicate %source-dir)))
+ ;;#:select? (force select?)))
(build-system gnu-build-system)
(inputs
`(("glpk" ,glpk)
@@ -105,7 +105,7 @@
("pulseaudio" ,pulseaudio)
("sqlite" ,sqlite)
("postgresql" ,postgresql)
- ("mysql" ,mysql)
+ ("mysql" ,mariadb)
("zlib" ,zlib)
("perl" ,perl)
("python-2" ,python-2) ; tests and gnunet-qr
@@ -145,34 +145,34 @@
(chdir "doc/documentation")
;;(zero? (system* "make" "dev-build"))))
(zero? (system* "sh" "run-gendocs.sh"))))
- ;; (zero? (system* "make" "pdf"))
- ;; (zero? (system* "make" "html"))
- ;; (zero? (system* "make" "info"))))
- ;;(zero? (system* "make" "doc-all-give-me-the-noise"))))
+ ;; (zero? (system* "make" "pdf"))
+ ;; (zero? (system* "make" "html"))
+ ;; (zero? (system* "make" "info"))))
+ ;;(zero? (system* "make" "doc-all-give-me-the-noise"))))
(replace 'install
(lambda _
(zero? (system* "make" "doc-gendoc-install")))))))
- ;;(lambda* (#:key outputs #:allow-other-keys)
- ;; (let* ((out (assoc-ref outputs "out"))
- ;; (doc (string-append out "/share/doc/gnunet")))
- ;; (mkdir-p doc)
- ;; (copy-recursively "images"
- ;; (string-append doc
- ;; "/images"))
- ;; (mkdir-p (string-append doc "/gnunet"))
- ;; (install-file "gnunet.pdf" doc)
- ;; (install-file "gnunet.info" doc)
- ;; (install-file "gnunet.log" doc) ;TODO: Move to 'dev'
output?
- ;; (copy-recursively "gnunet"
- ;; (string-append doc
- ;; "/gnunet"))
- ;; (install-file "gnunet-c-tutorial.pdf" doc)
- ;; (install-file "gnunet-c-tutorial.info" doc)
- ;; (install-file "gnunet-c-tutorial.log" doc) ;TODO: Move to
'dev' output?
- ;; (copy-recursively "gnunet-c-tutorial"
- ;; (string-append doc
- ;; "/gnunet-c-tutorial")))
- ;; #t)))))
+ ;;(lambda* (#:key outputs #:allow-other-keys)
+ ;; (let* ((out (assoc-ref outputs "out"))
+ ;; (doc (string-append out "/share/doc/gnunet")))
+ ;; (mkdir-p doc)
+ ;; (copy-recursively "images"
+ ;; (string-append doc
+ ;; "/images"))
+ ;; (mkdir-p (string-append doc "/gnunet"))
+ ;; (install-file "gnunet.pdf" doc)
+ ;; (install-file "gnunet.info" doc)
+ ;; (install-file "gnunet.log" doc) ;TODO: Move to 'dev' output?
+ ;; (copy-recursively "gnunet"
+ ;; (string-append doc
+ ;; "/gnunet"))
+ ;; (install-file "gnunet-c-tutorial.pdf" doc)
+ ;; (install-file "gnunet-c-tutorial.info" doc)
+ ;; (install-file "gnunet-c-tutorial.log" doc) ;TODO: Move to 'dev'
output?
+ ;; (copy-recursively "gnunet-c-tutorial"
+ ;; (string-append doc
+ ;; "/gnunet-c-tutorial")))
+ ;; #t)))))
(synopsis "Documentation of GNUnet")
(description
"GNUnet documentation build")
diff --git a/contrib/scripts/report.sh b/contrib/scripts/gnunet-bugreport
similarity index 99%
rename from contrib/scripts/report.sh
rename to contrib/scripts/gnunet-bugreport
index 7fbb2f46c..f17cb7636 100755
--- a/contrib/scripts/report.sh
+++ b/contrib/scripts/gnunet-bugreport
@@ -233,7 +233,7 @@ gcc -o $TMPFILE $TMPFILE.c 2> /dev/null && $TMPFILE || echo
"Not found"
rm -f $TMPFILE $TMPFILE.bin
-echo -n "GNUtls : "
+echo -n "GnuTLS : "
TMPFILE=`mktemp /tmp/gnutls-version-testXXXXXX`
cat - >$TMPFILE.c <<EOF
#include <gnutls/gnutls.h>
diff --git a/contrib/services/openrc/gnunet.initd
b/contrib/services/openrc/gnunet.initd
new file mode 100644
index 000000000..c042e3de1
--- /dev/null
+++ b/contrib/services/openrc/gnunet.initd
@@ -0,0 +1,82 @@
+#!/sbin/openrc-run
+# Copyright 1999-2016 Gentoo Foundation
+# Distributed under the terms of the GNU General Public License v2
+
+if [ -d /run ] ; then
+ PIDFILE=${PIDFILE:-/run/gnunet/arm-service.pid}
+else
+ PIDFILE=${PIDFILE:-/var/run/gnunet/arm-service.pid}
+fi
+
+depend() {
+ # FIXME: refine?
+ need net
+}
+
+GNUNET_PATH="/usr"
+GNUNET_HOME="/var/lib/gnunet"
+SUID_ROOT_HELPERS="exit nat-server nat-client transport-bluetooth
transport-wlan vpn"
+
+chmodown_execbin() {
+ if [ -x $1 ]; then
+ if [ "$3" ]; then
+ chown $3 $1 2>/dev/null && chmod $2 $1
+ else
+ chmod $2 $1
+ fi
+ fi
+}
+
+checkconfig() {
+ if [ -n "$(find ${GNUNET_HOME}/.local/share/gnunet -maxdepth 1 -name
gnunet.conf -perm +0044)" ] ; then
+ eerror "${conf} must not be world or group readable. Try:"
+ eerror " chmod 600 ${conf}"
+ eerror " chown gnunet:gnunet ${conf}"
+ return 1
+ fi
+ mkdir -p ${GNUNET_HOME}/.cache/gnunet
+
+ # taken from dangole's lede config.. thx!
+ local libexec="${GNUNET_PATH}/lib/gnunet/libexec" # why
not /usr/libexec/gnunet ?
+ # not reliable enough:
+ #[ -e ${libexec}/.permfix ] && return
+ for helper in $SUID_ROOT_HELPERS; do
+ chmodown_execbin ${libexec}/gnunet-helper-$helper u+s
+ done
+ chmodown_execbin ${libexec}/gnunet-helper-dns 4750 root:gnunetdns
+ chmodown_execbin ${libexec}/gnunet-service-dns 2750 gnunet:gnunetdns
+ #touch ${libexec}/.permfix
+}
+
+start() {
+ checkconfig || return 1
+
+ local piddir=$(dirname ${PIDFILE})
+ if [ ! -d ${piddir} ] ; then
+ ebegin "Making ${piddir}"
+ mkdir -p ${piddir}
+ eend $?
+ ebegin "Changing permissions of ${piddir}"
+ chown gnunet:gnunet ${piddir}
+ eend $?
+ fi
+
+ ebegin "Starting ${SVCNAME}"
+ # shouldn't be necessary... but
+ start-stop-daemon --start --user gnunet --name gnunet --pidfile
${PIDFILE} \
+ --exec ${GNUNET_PATH}/lib/gnunet/libexec/gnunet-service-arm -- -d
+ # flags to be passed to the process appear after the double-dash
+ eend $?
+}
+
+stop() {
+ ebegin "Stopping ${SVCNAME}"
+ start-stop-daemon --stop --signal QUIT --pidfile ${PIDFILE}
+ sleep 1
+ killall -u gnunet
+ sleep 1
+ rm -rf /tmp/gnunet-gnunet-runtime >/dev/null 2>&1
+ rm -rf /tmp/gnunet-system-runtime >/dev/null 2>&1
+ eend $?
+}
+
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 1070974d1..f60bde084 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -7,4 +7,5 @@ if !DOCUMENTATION
endif
EXTRA_DIST = \
- outdated-and-old-installation-instructions.txt
+ system_specific/outdated-and-old-installation-instructions.txt \
+ system_specific/FROM_SOURCE
diff --git a/doc/documentation/Makefile.am b/doc/documentation/Makefile.am
index 0781b2fbb..12f40f147 100644
--- a/doc/documentation/Makefile.am
+++ b/doc/documentation/Makefile.am
@@ -113,7 +113,6 @@ info_TEXINFOS =
\
gnunet_TEXINFOS = \
chapters/developer.texi \
chapters/preface.texi \
- chapters/installation.texi \
chapters/philosophy.texi \
chapters/user.texi \
chapters/vocabulary.texi \
diff --git a/doc/documentation/chapters/developer.texi
b/doc/documentation/chapters/developer.texi
index 6a895ed11..d33072057 100644
--- a/doc/documentation/chapters/developer.texi
+++ b/doc/documentation/chapters/developer.texi
@@ -2,7 +2,7 @@
@node GNUnet Developer Handbook
@chapter GNUnet Developer Handbook
-This book is intended to be an introduction for programmers that want to
+0This book is intended to be an introduction for programmers that want to
extend the GNUnet framework. GNUnet is more than a simple peer-to-peer
application.
@@ -11,7 +11,7 @@ For developers, GNUnet is:
@itemize @bullet
@item developed by a community that believes in the GNU philosophy
@item Free Software (Free as in Freedom), licensed under the
-GNU General Public
address@hidden@uref{https://www.gnu.org/licenses/licenses.html#GPL,
https://www.gnu.org/licenses/licenses.html#GPL}}
+GNU Affero General Public
address@hidden@uref{https://www.gnu.org/licenses/licenses.html#AGPL,
https://www.gnu.org/licenses/licenses.html#AGPL}}
@item A set of standards, including coding conventions and
architectural rules
@item A set of layered protocols, both specifying the communication
@@ -40,6 +40,7 @@ new chapters, sections or insightful comments.
@menu
* Developer Introduction::
+* Internal dependencies::
* Code overview::
* System Architecture::
* Subsystem stability::
@@ -47,6 +48,7 @@ new chapters, sections or insightful comments.
* Build-system::
* Developing extensions for GNUnet using the gnunet-ext template::
* Writing testcases::
+* Building GNUnet and its dependencies::
* TESTING library::
* Performance regression analysis with Gauger::
* TESTBED Subsystem::
@@ -251,6 +253,77 @@ those that have a public website) which build on top of
the GNUnet
framework.
@c ***********************************************************************
address@hidden Internal dependencies
address@hidden 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
address@hidden -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.
+
+In terms of internal dependencies, a minimum file-sharing system consists
+of the following GNUnet processes (in order of dependency):
+
address@hidden @bullet
address@hidden gnunet-service-arm
address@hidden gnunet-service-resolver (required by all)
address@hidden gnunet-service-statistics (required by all)
address@hidden gnunet-service-peerinfo
address@hidden gnunet-service-transport (requires peerinfo)
address@hidden gnunet-service-core (requires transport)
address@hidden gnunet-daemon-hostlist (requires core)
address@hidden gnunet-daemon-topology (requires hostlist, peerinfo)
address@hidden gnunet-service-datastore
address@hidden gnunet-service-dht (requires core)
address@hidden gnunet-service-identity
address@hidden gnunet-service-fs (requires identity, mesh, dht, datastore, core)
address@hidden itemize
+
address@hidden
+A minimum VPN system consists of the following GNUnet processes (in
+order of dependency):
+
address@hidden @bullet
address@hidden gnunet-service-arm
address@hidden gnunet-service-resolver (required by all)
address@hidden gnunet-service-statistics (required by all)
address@hidden gnunet-service-peerinfo
address@hidden gnunet-service-transport (requires peerinfo)
address@hidden gnunet-service-core (requires transport)
address@hidden gnunet-daemon-hostlist (requires core)
address@hidden gnunet-service-dht (requires core)
address@hidden gnunet-service-mesh (requires dht, core)
address@hidden gnunet-service-dns (requires dht)
address@hidden gnunet-service-regex (requires dht)
address@hidden gnunet-service-vpn (requires regex, dns, mesh, dht)
address@hidden itemize
+
address@hidden
+A minimum GNS system consists of the following GNUnet processes (in
+order of dependency):
+
address@hidden @bullet
address@hidden gnunet-service-arm
address@hidden gnunet-service-resolver (required by all)
address@hidden gnunet-service-statistics (required by all)
address@hidden gnunet-service-peerinfo
address@hidden gnunet-service-transport (requires peerinfo)
address@hidden gnunet-service-core (requires transport)
address@hidden gnunet-daemon-hostlist (requires core)
address@hidden gnunet-service-dht (requires core)
address@hidden gnunet-service-mesh (requires dht, core)
address@hidden gnunet-service-dns (requires dht)
address@hidden gnunet-service-regex (requires dht)
address@hidden gnunet-service-vpn (requires regex, dns, mesh, dht)
address@hidden gnunet-service-identity
address@hidden gnunet-service-namestore (requires identity)
address@hidden gnunet-service-gns (requires vpn, dns, dht, namestore, identity)
address@hidden itemize
+
address@hidden
***********************************************************************
@node Code overview
@section Code overview
@@ -1089,6 +1162,313 @@ typically necessary to run @code{make install} before
running any
testcases. Thus the canonical command @code{make check install} has to be
changed to @code{make install check} for GNUnet.
address@hidden
***********************************************************************
address@hidden Building GNUnet
address@hidden Building GNUnet and its dependencies
address@hidden Building GNUnet and its dependencies
+
+In the following section we will outline how to build GNUnet and
+some of its dependencies. We will assume a fair amount of knowledge
+for building applications under UNIX-like systems. Furthermore we
+assume that the build environment is sane and that you are aware of
+any implications actions in this process could have.
+Instructions here can be seen as notes for developers (an extension to
+the 'HACKING' section in README) as well as package mantainers.
address@hidden should rely on the available binary packages.}
+We will use Debian as an example Operating System environment. Substitute
+accordingly with your own Ooperating System environment.
+
+For the full list of depenendencies, consult the appropriate, up-to-date
+section in the @file{README} file.
+
+First, we need to build or install (depending on your OS) the following
+packages. If you build them from source, build them in this exact order:
+
address@hidden
+libgpgerror, libgcrypt, libnettle, libunbound, GnuTLS (with libunbound
+support)
address@hidden example
+
+After we have build and installed those packages, we continue with
+packages closer to GNUnet in this step: libgnurl (our libcurl fork),
+GNU libmicrohttpd, and GNU libextractor. Again, if your package manager
+provides one of these packages, use the packages provided from it
+unless you have good reasons (package version too old, conflicts, etc).
+We advise against compiling widely used packages such as GnuTLS
+yourself if your OS provides a variant already unless you take care
+of maintenance of the packages then.
+
+In the optimistic case, this command will give you all the dependencies:
+
address@hidden
+sudo apt-get install libgnurl libmicrohttpd libextractor
address@hidden example
+
+From experience we know that at the very least libgnurl is not
+available in some environments. You could substitute libgnurl
+with libcurl, but we recommend to install libgnurl, as it gives
+you a predefined libcurl with the small set GNUnet requires. In
+the past namespaces of libcurl and libgnurl were shared, which
+caused problems when you wanted to integrate both of them in one
+Operating System. This has been resolved, and they can be installed
+side by side now.
+
address@hidden libgnurl
address@hidden compiling libgnurl
+GNUnet and some of its function depend on a limited subset of cURL/libcurl.
+Rather than trying to enforce a certain configuration on the world, we
+opted to maintain a microfork of it that ensures we can link against the
+right set of features. We called this specialized set of libcurl
+``libgnurl''. It is fully ABI compatible with libcurl and currently used
+by GNUnet and some of its dependencies.
+
+We download libgnurl and its digital signature from the GNU fileserver,
+assuming @env{TMPDIR} address@hidden might be @file{/tmp}, @env{TMPDIR},
@env{TMP} or any other location. For consistency we assume @env{TMPDIR} points
to @file{/tmp} for the remainder of this section.}
+
address@hidden
+cd \$TMPDIR
+wget https://ftp.gnu.org/gnu/gnunet/gnurl-7.60.0.tar.Z
+wget https://ftp.gnu.org/gnu/gnunet/gnurl-7.60.0.tar.Z.sig
address@hidden example
+
+Next, verify the digital signature of the file:
+
address@hidden
+gpg --verify gnurl-7.60.0.tar.Z.sig
address@hidden example
+
+If gpg fails, you might try with @command{gpg2} on your OS. If the error
+states that ``the key can not be found'' or it is unknown, you have to
+retrieve the key (A88C8ADD129828D7EAC02E52E22F9BBFEE348588) from a
+keyserver first:
+
address@hidden
+gpg --keyserver pgp.mit.edu --recv-keys
A88C8ADD129828D7EAC02E52E22F9BBFEE348588
address@hidden example
+
+and rerun the verification command.
+
+libgnurl will require the following packages to be present at runtime:
+gnutls (with DANE support / libunbound), libidn, zlib and at compile time:
+libtool, groff, perl, pkg-config, and python 2.7.
+
+Once you have verified that all the required packages are present on your
+system, we can proceed to compile libgnurl:
+
address@hidden
+tar -xvf gnurl-7.60.0.tar.Z
+cd gnurl-7.60.0
+sh configure --disable-ntlm-wb
+make
+make -C tests test
+sudo make install
address@hidden example
+
+After you've compiled and installed libgnurl, we can proceed to building
+GNUnet.
+
+
+
+
+First, in addition to the GNUnet sources you might require downloading the
+latest version of various dependencies, depending on how recent the
+software versions in your distribution of GNU/Linux are.
+Most distributions do not include sufficiently recent versions of these
+dependencies.
+Thus, a typically installation on a "modern" GNU/Linux distribution
+requires you to install the following dependencies (ideally in this
+order):
+
address@hidden @bullet
address@hidden libgpgerror and libgcrypt
address@hidden libnettle and libunbound (possibly from distribution), GnuTLS
address@hidden libgnurl (read the README)
address@hidden GNU libmicrohttpd
address@hidden GNU libextractor
address@hidden itemize
+
+Make sure to first install the various mandatory and optional
+dependencies including development headers from your distribution.
+
+Other dependencies that you should strongly consider to install is a
+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 @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 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 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!).
+
+Before proceeding further, please double-check the dependency list.
+Note that in addition to satisfying the dependencies, you might have to
+make sure that development headers for the various libraries are also
+installed.
+There maybe files for other distributions, or you might be able to find
+equivalent packages for your distribution.
+
+While it is possible to build and install GNUnet without having root
+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 the GNU/Linux distributions Debian and Ubuntu,
+type:
+
address@hidden
+sudo adduser --system --home /var/lib/gnunet --group \
+--disabled-password gnunet
+sudo addgroup --system gnunetdns
address@hidden example
+
address@hidden
+On other Unixes and GNU systems, this should have the same effect:
+
address@hidden
+sudo useradd --system --groups gnunet --home-dir /var/lib/gnunet
+sudo addgroup --system gnunetdns
address@hidden example
+
+Now compile and install GNUnet using:
+
address@hidden
+tar xvf address@hidden
+cd address@hidden
+./configure --with-sudo=sudo --with-nssdir=/lib
+make
+sudo make install
address@hidden example
+
+If you want to be able to enable DEBUG-level log messages, add
address@hidden to the end of the
address@hidden/configure} command.
address@hidden log messages are in English only and
+should only be useful for developers (or for filing
+really detailed bug reports).
+
address@hidden
+Next, edit the file @file{/etc/gnunet.conf} to contain the following:
+
address@hidden
+[arm]
+SYSTEM_ONLY = YES
+USER_ONLY = NO
address@hidden example
+
address@hidden
+You may need to update your @code{ld.so} cache to include
+files installed in @file{/usr/local/lib}:
+
address@hidden
+# ldconfig
address@hidden example
+
address@hidden
+Then, switch from user @code{root} to user @code{gnunet} to start
+the peer:
+
address@hidden
+# su -s /bin/sh - gnunet
+$ gnunet-arm -c /etc/gnunet.conf -s
address@hidden example
+
+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:
+
address@hidden
+@@reboot /usr/local/bin/gnunet-arm -c /etc/gnunet.conf -s
address@hidden example
+
address@hidden
+This will only start the system-wide GNUnet services.
+Type @command{exit} to get back your root shell.
+Now, you need to configure the per-user part. For each
+user that should get access to GNUnet on the system, run
+(replace alice with your username):
+
address@hidden
+sudo adduser alice gnunet
address@hidden example
+
address@hidden
+to allow them to access the system-wide GNUnet services. Then, each
+user should create a configuration file @file{~/.config/gnunet.conf}
+with the lines:
+
address@hidden
+[arm]
+SYSTEM_ONLY = NO
+USER_ONLY = YES
+DEFAULTSERVICES = gns
address@hidden example
+
address@hidden
+and start the per-user services using
+
address@hidden
+$ gnunet-arm -c ~/.config/gnunet.conf -s
address@hidden example
+
address@hidden
+Again, adding a @code{crontab} entry to autostart the peer is advised:
+
address@hidden
+@@reboot /usr/local/bin/gnunet-arm -c $HOME/.config/gnunet.conf -s
address@hidden example
+
address@hidden
+Note that some GNUnet services (such as SOCKS5 proxies) may need a
+system-wide TCP port for each user.
+For those services, systems with more than one user may require each user
+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 (GNS) certificate authority. This is done by running:
+
address@hidden
+$ gnunet-gns-proxy-setup-ca
address@hidden example
+
address@hidden
+The first generates the default zones, wheras the second setups the GNS
+Certificate Authority with the user's browser. Now, to activate GNS in the
+normal DNS resolution process, you need to edit your
address@hidden/etc/nsswitch.conf} where you should find a line like this:
+
address@hidden
+hosts: files mdns4_minimal [NOTFOUND=return] dns mdns4
address@hidden example
+
address@hidden
+The exact details may differ a bit, which is fine. Add the text
address@hidden"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 "\":
+
address@hidden
+hosts: files gns [NOTFOUND=return] mdns4_minimal \
+[NOTFOUND=return] dns mdns4
address@hidden example
+
address@hidden 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.
+
+
address@hidden
**********************************************************************
@cindex TESTING library
@node TESTING library
@section TESTING library
diff --git a/doc/documentation/chapters/installation.texi
b/doc/documentation/chapters/installation.texi
deleted file mode 100644
index 665f980be..000000000
--- a/doc/documentation/chapters/installation.texi
+++ /dev/null
@@ -1,4149 +0,0 @@
address@hidden GNUnet Installation Handbook
address@hidden GNUnet Installation Handbook
-
-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.
-
-Note: This manual is far from complete, and we welcome contributions, be
-it in the form of new chapters or insightful comments.
-
address@hidden
-* 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::
-* Build instructions for macOS::
address@hidden * Build instructions for OpenBSD 6.2::
-* Outdated build instructions for previous revisions::
address@hidden * Portable GNUnet::
-* The graphical configuration interface::
-* How to start and stop a GNUnet peer::
address@hidden menu
-
address@hidden Dependencies
address@hidden Dependencies
address@hidden %**end of header
-
-This section lists the various known dependencies for
-GNUnet @value{EDITION}.
-Suggestions for missing dependencies or wrong version numbers are welcome.
-
address@hidden
-* External dependencies::
-* Optional dependencies::
-* Internal dependencies::
address@hidden menu
-
address@hidden External dependencies
address@hidden External dependencies
address@hidden %**end of header
-
-These packages must be installed before a typical GNUnet installation
-can be performed:
-
address@hidden @bullet
address@hidden autoconf
address@hidden automake
address@hidden pkg-config
address@hidden libltdl
address@hidden gstreamer
address@hidden gst-plugins-base
address@hidden perl
address@hidden python (only 2.7 supported)@footnote{tests and gnunet-qr}
address@hidden jansson
address@hidden nss
address@hidden glib
address@hidden gmp
address@hidden bluez
address@hidden miniupnpc
address@hidden gettext
address@hidden which
address@hidden texinfo @geq{} 5.2
address@hidden GNU libmicrohttpd @geq{} 0.9.30 @footnote{We recommend to build
it
-with a GnuTLS version that was configured with libunbound}
address@hidden GNU libextractor @geq{} 1.0
address@hidden GNU libtool @geq{} 2.2
address@hidden GNU libunistring @geq{} 0.9.1.1
address@hidden GNU libidn @geq{} 1.0.0
address@hidden @uref{https://gnupg.org/software/libgcrypt/, GNU libgcrypt}
@geq{}
address@hidden://gnupg.org/ftp/gcrypt/libgcrypt/, 1.6.0}
address@hidden @uref{https://gnutls.org/, GnuTLS} @geq{} 3.2.7
address@hidden recommend to compile with libunbound for DANE support;
-GnuTLS also requires GNU nettle 2.7 (update: GnuTLS 3.2.7 appears NOT
-to work against GNU nettle > 2.7, due to some API updatings done by
-nettle. Thus it should be compiled against nettle 2.7
-and, in case you get some error on the reference to `rpl_strerror' being
-undefined, follow the instructions on
address@hidden://lists.gnupg.org/pipermail/gnutls-devel/2013-November/006588.html,
this}
-post (and the link inside it)).}
address@hidden @uref{https://gnunet.org/gnurl, gnURL} libgnurl @geq{} 7.34.0
address@hidden be compiled after @code{GnuTLS}}
address@hidden libglpk @geq{} 4.45
address@hidden @uref{http://www.openssl.org/, OpenSSL} @geq{} 1.0
address@hidden TeX Live @geq{} 2012, optional (for gnunet-bcd)
address@hidden Texinfo @geq{} 5.2 (for documentation)
address@hidden libsqlite @geq{} 3.8.0 @footnote{(note that the code will
-compile and often work with lower version numbers, but you may get subtle
-bugs with respect to quota management in certain rare cases);
-alternatively, MySQL or Postgres can also be installed, but those
-databases will require more complex configurations (not
-recommended for first-time users)}
address@hidden zlib
address@hidden itemize
-
address@hidden Optional dependencies
address@hidden Optional dependencies
-
-These applications must be installed for various experimental or otherwise
-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}):
-
address@hidden @bullet
address@hidden libpulse @geq{} 2.0,
-optional (for @command{gnunet-conversation})
address@hidden libopus @geq{} 1.0.1,
-optional (for @command{gnunet-conversation})
address@hidden libogg @geq{} 1.3.0,
-optional (for @command{gnunet-conversation})
address@hidden libnss contained @command{certool} binary,
-optional for convenient installation of
-the GNS proxy.
address@hidden python-zbar @geq{} 0.10,
-optional (for @command{gnunet-qr})
address@hidden Gtk+ @geq{} 3.0,
-optional (for @command{gnunet-gtk})
address@hidden libgladeui (must match Gtk+ version),
-optional (for @command{gnunet-gtk})
address@hidden libqrencode @geq{} 3.0,
-optional (for @command{gnunet-namestore-gtk})
address@hidden libpbc @geq{} 0.5.14, optional for Attribute-Based Encryption
and Identity Provider functionality
address@hidden libgabe (https://github.com/schanzen/libgabe), optional for
Attribute-Based Encryption and Identity Provider functionality
address@hidden itemize
-
address@hidden Internal dependencies
address@hidden 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
address@hidden -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.
-
-In terms of internal dependencies, a minimum file-sharing system consists
-of the following GNUnet processes (in order of dependency):
-
address@hidden @bullet
address@hidden gnunet-service-arm
address@hidden gnunet-service-resolver (required by all)
address@hidden gnunet-service-statistics (required by all)
address@hidden gnunet-service-peerinfo
address@hidden gnunet-service-transport (requires peerinfo)
address@hidden gnunet-service-core (requires transport)
address@hidden gnunet-daemon-hostlist (requires core)
address@hidden gnunet-daemon-topology (requires hostlist, peerinfo)
address@hidden gnunet-service-datastore
address@hidden gnunet-service-dht (requires core)
address@hidden gnunet-service-identity
address@hidden gnunet-service-fs (requires identity, mesh, dht, datastore, core)
address@hidden itemize
-
address@hidden
-A minimum VPN system consists of the following GNUnet processes (in
-order of dependency):
-
address@hidden @bullet
address@hidden gnunet-service-arm
address@hidden gnunet-service-resolver (required by all)
address@hidden gnunet-service-statistics (required by all)
address@hidden gnunet-service-peerinfo
address@hidden gnunet-service-transport (requires peerinfo)
address@hidden gnunet-service-core (requires transport)
address@hidden gnunet-daemon-hostlist (requires core)
address@hidden gnunet-service-dht (requires core)
address@hidden gnunet-service-mesh (requires dht, core)
address@hidden gnunet-service-dns (requires dht)
address@hidden gnunet-service-regex (requires dht)
address@hidden gnunet-service-vpn (requires regex, dns, mesh, dht)
address@hidden itemize
-
address@hidden
-A minimum GNS system consists of the following GNUnet processes (in
-order of dependency):
-
address@hidden @bullet
address@hidden gnunet-service-arm
address@hidden gnunet-service-resolver (required by all)
address@hidden gnunet-service-statistics (required by all)
address@hidden gnunet-service-peerinfo
address@hidden gnunet-service-transport (requires peerinfo)
address@hidden gnunet-service-core (requires transport)
address@hidden gnunet-daemon-hostlist (requires core)
address@hidden gnunet-service-dht (requires core)
address@hidden gnunet-service-mesh (requires dht, core)
address@hidden gnunet-service-dns (requires dht)
address@hidden gnunet-service-regex (requires dht)
address@hidden gnunet-service-vpn (requires regex, dns, mesh, dht)
address@hidden gnunet-service-identity
address@hidden gnunet-service-namestore (requires identity)
address@hidden gnunet-service-gns (requires vpn, dns, dht, namestore, identity)
address@hidden itemize
-
address@hidden Pre-installation notes
address@hidden Pre-installation notes
-
-Please note that in the code instructions for the installation,
address@hidden indicates commands run as privileged root user and
address@hidden shows commands run as unprivileged ("normal") system user.
-
-
address@hidden Generic installation instructions
address@hidden Generic installation instructions
-
-First, in addition to the GNUnet sources you might require downloading the
-latest version of various dependencies, depending on how recent the
-software versions in your distribution of GNU/Linux are.
-Most distributions do not include sufficiently recent versions of these
-dependencies.
-Thus, a typically installation on a "modern" GNU/Linux distribution
-requires you to install the following dependencies (ideally in this
-order):
-
address@hidden @bullet
address@hidden libgpgerror and libgcrypt
address@hidden libnettle and libunbound (possibly from distribution), GnuTLS
address@hidden libgnurl (read the README)
address@hidden GNU libmicrohttpd
address@hidden GNU libextractor
address@hidden itemize
-
-Make sure to first install the various mandatory and optional
-dependencies including development headers from your distribution.
-
-Other dependencies that you should strongly consider to install is a
-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 @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
address@hidden 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 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!).
-
-Before proceeding further, please double-check the dependency list.
-Note that in addition to satisfying the dependencies, you might have to
-make sure that development headers for the various libraries are also
-installed.
-There maybe files for other distributions, or you might be able to find
-equivalent packages for your distribution.
-
-While it is possible to build and install GNUnet without having root
-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 the GNU/Linux distributions Debian and Ubuntu,
-type:
-
address@hidden
-# adduser --system --home /var/lib/gnunet --group \
---disabled-password gnunet
-# addgroup --system gnunetdns
address@hidden example
-
address@hidden
-On other Unixes and GNU systems, this should have the same effect:
-
address@hidden
-# useradd --system --groups gnunet --home-dir /var/lib/gnunet
-# addgroup --system gnunetdns
address@hidden example
-
-Now compile and install GNUnet using:
-
address@hidden
-$ tar xvf address@hidden
-$ cd address@hidden
-$ ./configure --with-sudo=sudo --with-nssdir=/lib
-$ make
-$ sudo make install
address@hidden example
-
-If you want to be able to enable DEBUG-level log messages, add
address@hidden to the end of the
address@hidden/configure} command.
address@hidden 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 @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):
-
address@hidden
-$ tar xvf address@hidden
-$ cd address@hidden
-$ ./configure --with-gnunet=/usr/local/
-$ make
-$ sudo make install
-$ cd ..
-# just to be safe run this:
-$ sudo ldconfig
address@hidden example
-
address@hidden
-Next, edit the file @file{/etc/gnunet.conf} to contain the following:
-
address@hidden
-[arm]
-SYSTEM_ONLY = YES
-USER_ONLY = NO
address@hidden example
-
address@hidden
-You may need to update your @code{ld.so} cache to include
-files installed in @file{/usr/local/lib}:
-
address@hidden
-# ldconfig
address@hidden example
-
address@hidden
-Then, switch from user @code{root} to user @code{gnunet} to start
-the peer:
-
address@hidden
-# su -s /bin/sh - gnunet
-$ gnunet-arm -c /etc/gnunet.conf -s
address@hidden example
-
-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:
-
address@hidden
-@@reboot /usr/local/bin/gnunet-arm -c /etc/gnunet.conf -s
address@hidden example
-
address@hidden
-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 that should get access to GNUnet on the system, run:
-
address@hidden
-# adduser $USER gnunet
address@hidden example
-
address@hidden
-to allow them to access the system-wide GNUnet services. Then, each
-user should create a configuration file @file{~/.config/gnunet.conf}
-with the lines:
-
address@hidden
-[arm]
-SYSTEM_ONLY = NO
-USER_ONLY = YES
-DEFAULTSERVICES = gns
address@hidden example
-
address@hidden
-and start the per-user services using
-
address@hidden
-$ gnunet-arm -c ~/.config/gnunet.conf -s
address@hidden example
-
address@hidden
-Again, adding a @code{crontab} entry to autostart the peer is advised:
-
address@hidden
-@@reboot /usr/local/bin/gnunet-arm -c $HOME/.config/gnunet.conf -s
address@hidden example
-
address@hidden
-Note that some GNUnet services (such as SOCKS5 proxies) may need a
-system-wide TCP port for each user.
-For those services, systems with more than one user may require each user
-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 (GNS) certificate authority. This is done by running:
-
address@hidden
-$ gnunet-gns-proxy-setup-ca
address@hidden example
-
address@hidden
-The first generates the default zones, wheras the second setups the GNS
-Certificate Authority with the user's browser. Now, to activate GNS in the
-normal DNS resolution process, you need to edit your
address@hidden/etc/nsswitch.conf} where you should find a line like this:
-
address@hidden
-hosts: files mdns4_minimal [NOTFOUND=return] dns mdns4
address@hidden example
-
address@hidden
-The exact details may differ a bit, which is fine. Add the text
address@hidden"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 "\":
-
address@hidden
-hosts: files gns [NOTFOUND=return] mdns4_minimal \
-[NOTFOUND=return] dns mdns4
address@hidden example
-
address@hidden 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.
-
address@hidden Build instructions for Ubuntu 12.04 using Git
address@hidden Build instructions for Ubuntu 12.04 using Git
-
address@hidden
-* Install the required build tools::
-* Install libgcrypt 1.6 and libgpg-error::
-* Install gnutls with DANE support::
-* Install libgnurl::
-* Install libmicrohttpd from Git::
-* Install libextractor from Git::
-* Install GNUnet dependencies::
-* Build GNUnet::
-* Install the GNUnet-gtk user interface from Git::
address@hidden menu
-
address@hidden Install the required build tools
address@hidden Install the required build tools
-
-First, make sure Git is installed on your system:
-
address@hidden
-$ sudo apt-get install git
address@hidden example
-
-Install the essential buildtools:
-
address@hidden
-$ sudo apt-get install automake autopoint autoconf libtool
address@hidden example
-
address@hidden Install libgcrypt 1.6 and libgpg-error
address@hidden Install libgcrypt 1.6 and libgpg-error
-
address@hidden source installation - libgpg-error}
-
address@hidden Install gnutls with DANE support
address@hidden Install gnutls with DANE support
-
address@hidden @bullet
address@hidden @ref{generic source installation - nettle}
address@hidden @ref{generic source installation - ldns}
address@hidden @ref{generic source installation - libunbound/unbound}
address@hidden @ref{generic source installation - gnutls}
address@hidden @ref{generic source installation - libgcrypt}
address@hidden itemize
-
address@hidden Install libgnurl
address@hidden Install libgnurl
-
-Follow the @ref{generic source installation - libgnurl}.
-
address@hidden Install libmicrohttpd from Git
address@hidden Install libmicrohttpd from Git
-
address@hidden
-$ git clone https://gnunet.org/git/libmicrohttpd
-$ cd libmicrohttpd/
-$ ./bootstrap
-$ ./configure
-$ sudo make install ; cd ..
address@hidden example
-
address@hidden Install libextractor from Git
address@hidden Install libextractor from Git
-
-Install libextractor dependencies:
-
address@hidden
-$ sudo apt-get install zlib1g-dev libgsf-1-dev libmpeg2-4-dev \
- libpoppler-dev libvorbis-dev libexiv2-dev libjpeg-dev \
- libtiff-dev libgif-dev libvorbis-dev libflac-dev libsmf-dev \
- g++
address@hidden example
-
-Build libextractor:
-
address@hidden
-$ git clone https://gnunet.org/git/libextractor
-$ cd libextractor
-$ ./bootstrap
-$ ./configure
-$ sudo make install ; cd ..
address@hidden example
-
address@hidden Install GNUnet dependencies
address@hidden Install GNUnet dependencies
-
address@hidden
-$ sudo apt-get install libidn11-dev libunistring-dev libglpk-dev \
- libpulse-dev libbluetooth-dev libsqlite-dev
address@hidden example
-
-Install libopus:
-
address@hidden
-$ wget http://downloads.xiph.org/releases/opus/opus-1.1.tar.gz
-$ tar xf opus-1.1.tar.gz
-$ cd opus-1.1/
-$ ./configure
-$ sudo make install ; cd ..
address@hidden example
-
-Choose one or more database backends:
-
-SQLite3:
address@hidden
-$ sudo apt-get install libsqlite3-dev
address@hidden example
-MySQL:
address@hidden
-$ sudo apt-get install libmysqlclient-dev
address@hidden example
-PostgreSQL:
address@hidden
-$ sudo apt-get install libpq-dev postgresql
address@hidden example
-
-
-
address@hidden Build GNUnet
address@hidden Build GNUnet
-
-
-
address@hidden
-* Configuring the installation path::
-* Configuring the system::
-* Installing components requiring sudo permission::
-* Build::
address@hidden menu
-
address@hidden Configuring the installation path
address@hidden Configuring the installation path
-
-You can specify the location of the GNUnet installation by setting the
-prefix when calling the configure script with @code{--prefix=DIRECTORY}
-
address@hidden
-$ export PATH=$PATH:DIRECTORY/bin
address@hidden example
-
address@hidden Configuring the system
address@hidden Configuring the system
-
-Please make sure NOW that you have created a user and group 'gnunet'
-and additionally a group 'gnunetdns':
-
address@hidden
-$ sudo addgroup gnunet
-$ sudo addgroup gnunetdns
-$ sudo adduser gnunet
address@hidden example
-
-Each GNUnet user should be added to the 'gnunet' group (may
-require fresh login to come into effect):
-
address@hidden
-$ sudo useradd -G gnunet
address@hidden example
-
address@hidden Installing components requiring sudo permission
address@hidden Installing components requiring sudo permission
-
-Some components, like the nss plugin required for GNS, may require root
-permissions. To allow these few components to be installed use:
-
address@hidden
-$ ./configure --with-sudo
address@hidden example
-
address@hidden Build
address@hidden Build
-
address@hidden
-$ git clone https://gnunet.org/git/gnunet/
-$ cd gnunet/
-$ ./bootstrap
address@hidden example
-
-Use the required configure call including the optional installation prefix
address@hidden or the sudo permissions:
-
address@hidden
-$ ./configure [ --with-sudo | --with-prefix=PREFIX ]
address@hidden example
-
address@hidden
-$ make; sudo make install
address@hidden example
-
-After installing it, you need to create an empty configuration file:
-
address@hidden
-mkdir ~/.gnunet; touch ~/.gnunet/gnunet.conf
address@hidden example
-
-And finally you can start GNUnet with:
-
address@hidden
-$ gnunet-arm -s
address@hidden example
-
address@hidden Install the GNUnet-gtk user interface from Git
address@hidden Install the GNUnet-gtk user interface from Git
-
-
-Install depencies:
-
address@hidden
-$ sudo apt-get install libgtk-3-dev libunique-3.0-dev libgladeui-dev \
- libqrencode-dev
address@hidden example
-
-Build GNUnet (with an optional prefix) and execute:
-
address@hidden
-$ git clone https://gnunet.org/git/gnunet-gtk/
-$ cd gnunet-gtk/
-$ ./bootstrap
-$ ./configure [--prefix=PREFIX] --with-gnunet=DIRECTORY
-$ make; sudo make install
address@hidden example
-
address@hidden Build instructions for software builds from source
address@hidden 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).
-
address@hidden
-* 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::
address@hidden menu
-
address@hidden generic source installation - nettle
address@hidden generic source installation - nettle
-
address@hidden
-$ 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 ..
address@hidden example
-
address@hidden generic source installation - ldns
address@hidden generic source installation - ldns
-
address@hidden
-$ 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 ..
address@hidden example
-
address@hidden generic source installation - libunbound/unbound
address@hidden generic source installation - libunbound/unbound
-
address@hidden
-$ 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 ..
address@hidden example
-
address@hidden generic source installation - libav
address@hidden generic source installation - libav
-
address@hidden
-$ wget https://libav.org/releases/libav-9.10.tar.xz
-$ cd libav-0.9 ; ./configure --enable-shared;
-$ make; sudo make install; cd ..
address@hidden example
-
address@hidden generic source installation - libextractor
address@hidden generic source installation - libextractor
-
address@hidden
-$ 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 ..
address@hidden example
-
address@hidden generic source installation - libgpg-error
address@hidden generic source installation - libgpg-error
-
address@hidden
-$ 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 ..
address@hidden example
-
address@hidden generic source installation - libgcrypt
address@hidden generic source installation - libgcrypt
address@hidden
-$ 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 ..
address@hidden example
-
address@hidden generic source installation - gnutls
address@hidden generic source installation - gnutls
-
address@hidden
-$ 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
address@hidden example
-
address@hidden
-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:
-
address@hidden
-$ ./configure --enable-libdane
address@hidden example
-
address@hidden
-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.
-
address@hidden
-$ ./configure
-$ make ; sudo make install ; cd ..
address@hidden example
-
address@hidden generic source installation - libmicrohttpd
address@hidden generic source installation - libmicrohttpd
-
address@hidden
-$ 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 ..
address@hidden example
-
address@hidden generic source installation - libgnurl
address@hidden generic source installation - libgnurl
-
-Example installation of libgnurl version 7.57.0 from source.
-
address@hidden
-$ 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
address@hidden example
-
address@hidden
-If that command fails because you do not have the required public key,
-then run this command to import it:
-
address@hidden
-$ gpg --keyserver pgp.mit.edu --recv-keys
A88C8ADD129828D7EAC02E52E22F9BBFEE348588
address@hidden example
-
address@hidden
-and rerun the gpg --verify command.
-
address@hidden
-$ tar xvf gnurl-7.57.0.tar.xz
-$ cd gnurl-7.57.0
-$ ./configure --disable-ntlm-wb
-$ make ; sudo make install; cd ..
address@hidden example
-
-You have now build and installed libgnurl from source.
-
address@hidden
-* Fixing libgnurl build issues::
address@hidden menu
-
address@hidden Fixing libgnurl build issues
address@hidden Fixing libgnurl build issues
-
address@hidden FIXME: Obviously this subsection should be evaluated and
address@hidden if still necessary moved into gnURL itself (README) or
address@hidden 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
address@hidden script:
-
address@hidden
-$ 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.
address@hidden example
-
address@hidden
-Solution:
-
-Before running the @command{configure} script, set:
-
address@hidden
-CFLAGS="-I. -I$BUILD_ROOT/include"
address@hidden example
-
address@hidden Build Instructions for Microsoft Windows Platforms
address@hidden Build Instructions for Microsoft Windows Platforms
-
address@hidden
-* Introduction to building on MS Windows::
-* Requirements::
-* Dependencies & Initial Setup::
-* GNUnet Installation::
-* Adjusting Windows for running and testing GNUnet::
-* Building the GNUnet Installer::
-* Using GNUnet with Netbeans on Windows::
address@hidden menu
-
address@hidden Introduction to building on MS Windows
address@hidden Introduction to building on MS Windows
-
-
-This document is a guide to building GNUnet and its dependencies on
-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.
-
address@hidden Requirements
address@hidden Requirements
-
-The Howto is based upon a @strong{Windows Server 2008 32bit}
address@hidden, @strong{sbuild} and thus a
address@hidden://www.mingw.org/wiki/MSYS, MSYS+MinGW}
-(W32-GCC-Compiler-Suite + Unix-like Userland) installation. sbuild
-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 these instructions,
-GNUnet @strong{requires} a Windows @strong{Server} 2003 or
-newer for full feature support.
-Windows Vista and later will also work, but
address@hidden version can not run a VPN-Exit-Node} as the NAT
-features have been removed as of Windows Vista.
-
address@hidden TODO: We should document Windows 10!
address@hidden It seems like the situation hasn't changed with W10
-
address@hidden Dependencies & Initial Setup
address@hidden Dependencies & Initial Setup
-
-
address@hidden @bullet
-
address@hidden
-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 is currently incompatible.
-
address@hidden
-Install your favorite @uref{http://code.google.com/p/tortoisegit/, git} &
address@hidden://tortoisesvn.net/, subversion}-clients.
-
address@hidden
-You will also need some archive-manager like
address@hidden://www.7-zip.org/, 7zip}.
-
address@hidden
-Pull a copy of sbuild to a directory of your choice, which will be used
-in the remainder of this guide. For now, we will use
address@hidden:\gnunet\sbuild\}
-
address@hidden
-in @file{sbuild\src\mingw\mingw32-buildall.sh}, comment out the packages
address@hidden and @strong{gnunet-gtk-svn}, as we don't want sbuild
-to compile/install those for us.
-
address@hidden
-Follow LRN's sbuild installation instructions.-
address@hidden itemize
-
-Please note that sbuild may (or will most likely) fail during
-installation, thus you really HAVE to @strong{check the logfiles} created
-during the installation process.
-Certain packages may fail to build initially due to missing dependencies,
-thus you may have to
address@hidden those with binary-versions initially}. Later on once
-dependencies are satisfied you can re-build the newer package versions.
-
address@hidden is normal that you may have to repeat this step multiple times
-and there is no uniform way to fix all compile-time issues, as the
-build-process of many of the dependencies installed are rather unstable
-on win32 and certain releases may not even compile at all.}
-
-Most dependencies for GNUnet have been set up by sbuild, thus we now
-should add the @file{bin/} directories in your new msys and mingw
-installations to PATH. You will want to create a backup of your finished
-msys-environment by now.
-
address@hidden GNUnet Installation
address@hidden GNUnet Installation
-
-First, we need to launch our msys-shell, you can do this via
-
address@hidden:\gnunet\sbuild\msys\msys.bat}
-
-You might wish to take a look at this file and adjust some
-login-parameters to your msys environment.
-
-Also, sbuild added two pointpoints to your msys-environment, though those
-might remain invisible:
-
address@hidden @bullet
-
address@hidden
-/mingw, which will mount your mingw-directory from sbuild/mingw and the
-other one is
-
address@hidden
-/src which contains all the installation sources sbuild just compiled.
address@hidden itemize
-
-Check out the current GNUnet sources (git HEAD) from the
-GNUnet repository "gnunet.git", we will do this in your home directory:
-
address@hidden clone https://gnunet.org/git/gnunet/ ~/gnunet}
-
-Now, we will first need to bootstrap the checked out installation and then
-configure it accordingly.
-
address@hidden
-cd ~/gnunet
-./bootstrap
-STRIP=true CPPFLAGS="-DUSE_IPV6=1 -DW32_VEH" CFLAGS="$CFLAGS -g -O2" \
-./configure --prefix=/ --docdir=/share/doc/gnunet \
---with-libiconv-prefix=/mingw --with-libintl-prefix=/mingw \
---with-libcurl=/mingw --with-extractor=/mingw --with-sqlite=/mingw \
---with-microhttpd=/mingw --with-plibc=/mingw --enable-benchmarks \
---enable-expensivetests --enable-experimental --with-qrencode=/mingw \
---enable-silent-rules --enable-experimental 2>&1 | tee -a ./configure.log
address@hidden example
-
-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
-the /mingw subdirectory, so remember to prefix library locations with
-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
-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,
-so you may fetch yourself a coffee or some Mate now...
-
address@hidden
-make ; make install
address@hidden example
-
address@hidden Adjusting Windows for running and testing GNUnet
address@hidden Adjusting Windows for running and testing GNUnet
-
-Assuming the build succeeded and you
address@hidden 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 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).
-
address@hidden Building the GNUnet Installer
address@hidden Building the GNUnet Installer
-
-The GNUnet installer is made with
address@hidden://nsis.sourceforge.net/, NSIS}.
-The installer script is located in @file{contrib\win} in the
-GNUnet source tree.
-
address@hidden Using GNUnet with Netbeans on Windows
address@hidden Using GNUnet with Netbeans on Windows
-
-TODO
-
address@hidden Build instructions for Debian 7.5
address@hidden Build instructions for Debian 7.5
-
-
-These are the installation instructions for Debian 7.5. They were tested
-using a minimal, fresh Debian 7.5 AMD64 installation without non-free
-software (no contrib or non-free).
-By "minimal", we mean that during installation, we did not select any
-desktop environment, servers or system utilities during the "tasksel"
-step. Note that the packages and the dependencies that we will install
-during this chapter take about 1.5 GB of disk space.
-Combined with GNUnet and space for objects during compilation, you should
-not even attempt this unless you have about 2.5 GB free after the minimal
-Debian installation.
-Using these instructions to build a VM image is likely to require a
-minimum of 4-5 GB for the VM (as you will likely also want a desktop
-manager).
-
-GNUnet's security model assumes that your @file{/home} directory is
-encrypted. Thus, if possible, you should encrypt your home partition
-(or per-user home directory).
-
-Naturally, the exact details of the starting state for your installation
-should not matter much. For example, if you selected any of those
-installation groups you might simply already have some of the necessary
-packages installed.
-We did this for testing, as this way we are less likely to forget to
-mention a required package.
-Note that we will not install a desktop environment, but of course you
-will need to install one to use GNUnet's graphical user interfaces.
-Thus, it is suggested that you simply install the desktop environment of
-your choice before beginning with the instructions.
-
-
-
address@hidden
-* Update::
-* Stable? Hah!::
-* Update again::
-* Installing packages::
-* Installing dependencies from source::
-* Installing GNUnet from source::
-* But wait there is more!::
address@hidden menu
-
address@hidden Update
address@hidden Update
-
-After any installation, you should begin by running
-
address@hidden
-# apt-get update ; apt-get upgrade
address@hidden example
-
-to ensure that all of your packages are up-to-date. Note that the "#" is
-used to indicate that you need to type in this command as "root"
-(or prefix with "sudo"), whereas "$" is used to indicate typing in a
-command as a normal user.
-
address@hidden Stable? Hah!
address@hidden Stable? Hah!
-
-Yes, we said we start with a Debian 7.5 "stable" system. However, to
-reduce the amount of compilation by hand, we will begin by allowing the
-installation of packages from the testing and unstable distributions as
-well.
-We will stick to "stable" packages where possible, but some packages will
-be taken from the other distributions.
-Start by modifying @file{/etc/apt/sources.list} to contain the
-following (possibly adjusted to point to your mirror of choice):
-
address@hidden
-# These were there before:
-deb http://ftp.de.debian.org/debian/ wheezy main
-deb-src http://ftp.de.debian.org/debian/ wheezy main
-deb http://security.debian.org/ wheezy/updates main
-deb-src http://security.debian.org/ wheezy/updates main
-deb http://ftp.de.debian.org/debian/ wheezy-updates main
-deb-src http://ftp.de.debian.org/debian/ wheezy-updates main
-
-# Add these lines (feel free to adjust the mirror):
-deb http://ftp.de.debian.org/debian/ testing main
-deb http://ftp.de.debian.org/debian/ unstable main
address@hidden example
-
-The next step is to create/edit your @file{/etc/apt/preferences}
-file to look like this:
-
address@hidden
-Package: *
-Pin: release a=stable,n=wheezy
-Pin-Priority: 700
-
-Package: *
-Pin: release o=Debian,a=testing
-Pin-Priority: 650
-
-Package: *
-Pin: release o=Debian,a=unstable
-Pin-Priority: 600
address@hidden example
-
-You can read more about Apt Preferences here and here.
-Note that other pinnings are likely to also work for GNUnet, the key
-thing is that you need some packages from unstable (as shown below).
-However, as unstable is unlikely to be comprehensive (missing packages)
-or might be problematic (crashing packages), you probably want others
-from stable and/or testing.
-
address@hidden Update again
address@hidden Update again
-
-Now, run again@
-
address@hidden
-# apt-get update@
-# apt-get upgrade@
address@hidden example
-
-to ensure that all your new distribution indices are downloaded, and
-that your pinning is correct: the upgrade step should cause no changes
-at all.
-
address@hidden Installing packages
address@hidden Installing packages
-
-We begin by installing a few Debian packages from stable:@
-
address@hidden
-# 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 libexiv2-dev libflac-dev libgif-dev libglib2.0-dev \
- libgtk-3-dev libmagic-dev libjpeg8-dev libmpeg2-4-dev libmp4v2-dev \
- librpm-dev libsmf-dev libtidy-dev libtiff5-dev libvorbis-dev \
- libogg-dev zlib1g-dev g++ gettext libgsf-1-dev libunbound-dev \
- libqrencode-dev libgladeui-dev nasm texlive-latex-extra \
- libunique-3.0-dev gawk miniupnpc libfuse-dev libbluetooth-dev
address@hidden example
-
-After that, we install a few more packages from unstable:@
-
address@hidden
-# apt-get install -t unstable nettle-dev libgstreamer1.0-dev \
- gstreamer1.0-plugins-base gstreamer1.0-plugins-good \
- libgstreamer-plugins-base1.0-dev
address@hidden example
-
address@hidden Installing dependencies from source
address@hidden Installing dependencies from source
-
-Next, we need to install a few dependencies from source.
-You might want to do this as a "normal" user and only run the
address@hidden 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.
-
-For these steps, follow the instructions given in the
-installation from source instruction in this order:
-
address@hidden @bullet
address@hidden @ref{generic source installation - libav}
address@hidden @ref{generic source installation - libextractor}
address@hidden @ref{generic source installation - libgpg-error}
address@hidden @ref{generic source installation - libgcrypt}
address@hidden @ref{generic source installation - gnutls}
address@hidden @ref{generic source installation - libmicrohttpd}
address@hidden @ref{generic source installation - libgnurl}
address@hidden itemize
-
address@hidden Installing GNUnet from source
address@hidden Installing GNUnet from source
-
-
-For this, simply follow the generic installation instructions from
-here.
-
address@hidden But wait there is more!
address@hidden But wait there is more!
-
-So far, we installed all of the packages and dependencies required to
-ensure that all of GNUnet would be built.
-However, while for example the plugins to interact with the MySQL or
-Postgres databases have been created, we did not actually install or
-configure those databases. Thus, you will need to install
-and configure those databases or stick with the default Sqlite database.
-Sqlite is usually fine for most applications, but MySQL can offer better
-performance and Postgres better resillience.
-
-
address@hidden Installing GNUnet from Git on Ubuntu 14.4
address@hidden Installing GNUnet from Git on Ubuntu 14.4
-
address@hidden the required build tools:}
-
address@hidden
-$ sudo apt-get install git automake autopoint autoconf
address@hidden example
-
address@hidden the required dependencies}
-
address@hidden
-$ sudo apt-get install libltdl-dev libgpg-error-dev libidn11-dev \
- libunistring-dev libglpk-dev libbluetooth-dev libextractor-dev \
- libmicrohttpd-dev libgnutls28-dev
address@hidden example
-
address@hidden one or more database backends}
-
address@hidden @bullet
-
address@hidden SQLite3:
-
address@hidden
-$ sudo apt-get install libsqlite3-dev
address@hidden example
-
address@hidden MySQL:
-
address@hidden
-$ sudo apt-get install libmysqlclient-dev
address@hidden example
-
address@hidden PostgreSQL:
-
address@hidden
-$ sudo apt-get install libpq-dev postgresql
address@hidden example
-
address@hidden itemize
-
address@hidden the optional dependencies for gnunet-conversation:}
-
address@hidden
-$ sudo apt-get install gstreamer1.0 libpulse-dev libopus-dev
address@hidden example
-
address@hidden the libgrypt 1.6.1:}
-
address@hidden @bullet
-
address@hidden For Ubuntu 14.04:
-
address@hidden
-$ sudo apt-get install libgcrypt20-dev
address@hidden example
-
address@hidden For Ubuntu older 14.04:
-
address@hidden
-$ wget ftp://ftp.gnupg.org/gcrypt/libgcrypt/libgcrypt-1.6.1.tar.bz2
-$ tar xf libgcrypt-1.6.1.tar.bz2
-$ cd libgcrypt-1.6.1
-$ ./configure
-$ sudo make install
-$ cd ..
address@hidden example
-
address@hidden itemize
-
address@hidden libgnurl}
-
address@hidden
-$ 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 ..
address@hidden example
-
address@hidden GNUnet}
-
address@hidden
-$ git clone https://gnunet.org/git/gnunet/
-$ cd gnunet/
-$ ./bootstrap
address@hidden example
-
-If you want to:
-
address@hidden @bullet
-
address@hidden Install to a different directory:
-
address@hidden
---prefix=PREFIX
address@hidden example
-
address@hidden
-Have sudo permission, but do not want to compile as root:
-
address@hidden
---with-sudo
address@hidden example
-
address@hidden
-Want debug message enabled:
-
address@hidden
---enable-logging=verbose
address@hidden example
-
address@hidden itemize
-
-
address@hidden
-$ ./configure [ --with-sudo | --prefix=PREFIX | --enable-logging=verbose]
-$ make; sudo make install
address@hidden example
-
-After installing it, you need to create an empty configuration file:
-
address@hidden
-touch ~/.config/gnunet.conf
address@hidden example
-
-And finally you can start GNUnet with
-
address@hidden
-$ gnunet-arm -s
address@hidden example
-
address@hidden Build instructions for Debian 8
address@hidden Build instructions for Debian 8
address@hidden 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
-contrib or non-free). During installation, I only selected "lxde" for the
-desktop environment.
-Note that the packages and the dependencies that we will install during
-this chapter take about 1.5 GB of disk space. Combined with GNUnet and
-space for objects during compilation, you should not even attempt this
-unless you have about 2.5 GB free after the Debian installation.
-Using these instructions to build a VM image is likely to require a
-minimum of 4-5 GB for the VM (as you will likely also want a desktop
-manager).
-
-GNUnet's security model assumes that your @code{/home} directory is
-encrypted.
-Thus, if possible, you should encrypt your entire disk, or at least just
-your home partition (or per-user home directory).
-
-Naturally, the exact details of the starting state for your installation
-should not matter much.
-For example, if you selected any of those installation groups you might
-simply already have some of the necessary packages installed. Thus, it is
-suggested that you simply install the desktop environment of your choice
-before beginning with the instructions.
-
-
address@hidden
-* Update Debian::
-* Installing Debian Packages::
-* Installing Dependencies from Source2::
-* Installing GNUnet from Source2::
-* But wait (again) there is more!::
address@hidden menu
-
address@hidden Update Debian
address@hidden Update Debian
-
-After any installation, you should begin by running
-
address@hidden
-# apt-get update
-# apt-get upgrade
address@hidden example
-
-to ensure that all of your packages are up-to-date. Note that the "#" is
-used to indicate that you need to type in this command as "root" (or
-prefix with "sudo"), whereas "$" is used to indicate typing in a command
-as a normal user.
-
address@hidden Installing Debian Packages
address@hidden Installing Debian Packages
-
-We begin by installing a few Debian packages from stable:
-
address@hidden
-# 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 \
-libtidy-dev libvorbis-dev libogg-dev zlib1g-dev g++ gettext \
-libgsf-1-dev libunbound-dev libqrencode-dev libgladeui-dev nasm \
-texlive-latex-extra libunique-3.0-dev gawk miniupnpc libfuse-dev \
-libbluetooth-dev gstreamer1.0-plugins-base gstreamer1.0-plugins-good \
-libgstreamer-plugins-base1.0-dev nettle-dev libextractor-dev \
-libgcrypt20-dev libmicrohttpd-dev
address@hidden example
-
address@hidden Installing Dependencies from Source2
address@hidden Installing Dependencies from Source2
-
-Yes, we said we start with a Debian 8 "stable" system, but because Debian
-linked GnuTLS without support for DANE, we need to compile a few things,
-in addition to GNUnet, still by hand. Yes, you can run GNUnet using the
-respective Debian packages, but then you will not get DANE support.
-
-Next, we need to install a few dependencies from source. You might want
-to do this as a "normal" user and only run the @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:
-
address@hidden
-$ wget ftp://ftp.gnutls.org/gcrypt/gnutls/v3.3/gnutls-3.3.12.tar.xz
-$ tar xvf gnutls-3.3.12.tar.xz
-$ cd gnutls-3.3.12 ; ./configure ; make ; sudo make install ; cd ..
address@hidden example
-
-For the installation and compilation of libgnurl/gnURL refer to
-the generic installation section,
address@hidden source installation - libgnurl}.
-
address@hidden Installing GNUnet from Source2
address@hidden Installing GNUnet from Source2
-
-For this, simply follow the generic installation instructions from@
-here.
-
address@hidden But wait (again) there is more!
address@hidden But wait (again) there is more!
-
-So far, we installed all of the packages and dependencies required to
-ensure that all of GNUnet would be built. However, while for example the
-plugins to interact with the MySQL or Postgres databases have been
-created, we did not actually install or configure those databases.
-Thus, you will need to install and configure those databases or stick
-with the default Sqlite database. Sqlite is usually fine for most
-applications, but MySQL can offer better performance and Postgres better
-resillience.
-
address@hidden Build instructions for macOS
address@hidden Build instructions for macOS
address@hidden FIXME: I -> we
-
-These are the installation guidelines for macOS.
-They were tested on macOS High Sierra.
-
address@hidden
-* Installing dependencies::
-* Compile from Source::
address@hidden menu
-
address@hidden Installing dependencies
address@hidden Installing dependencies
-
-First, install XCode in the newest version.
-See https://developer.apple.com/xcode/.
-
-Install Homebrew (https://brew.sh) and then install the dependencies listed
above.
-If a dependency does not exists in brew, you need to compile it from source.
-
address@hidden
-# brew install <dependency>
address@hidden example
-
address@hidden Compile from Source
address@hidden Compile from Source
-
-Before you start building GNUnet, you need to setup your environment.
-This means that you have to make sure the proper tools are used in the build
process.
-For example, after installing texinfo you need to make sure the new texinfo is
actually used:
-
address@hidden
-# echo 'export PATH="/usr/local/opt/texinfo/bin:$PATH"' >> ~/.bash_profile
address@hidden example
-
-Note: brew tells you the appropriate command when executing
-
address@hidden
-# brew info texinfo
address@hidden example
-
-This may also be necessary for the gettext package.
-
-Before you start compiling, you need to make sure gcc is used and not the
clang compile of your macOS system.
-On my system, gcc was actually ``gcc-7'' and gcc pointed to the clang compiler.
-
address@hidden
-# export CC=gcc-7
address@hidden example
-
-After this the standard compile instructions apply.
-
address@hidden @node Build instructions for OpenBSD 6.2
address@hidden @section Build instructions for OpenBSD 6.2
-
address@hidden Outdated build instructions for previous revisions
address@hidden Outdated build instructions for previous revisions
-
-This chapter contains a collection of outdated, older installation guides.
-They are mostly intended to serve as a starting point for writing
-up-to-date instructions and should not be expected to work for
-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 tree of GNUnet.
-
-This file covers old instructions which no longer receive security
-updates or any kind of support.
-
address@hidden
-* Installing GNUnet 0.10.1 on Ubuntu 14.04::
-* Building GLPK for MinGW::
-* GUI build instructions for Ubuntu 12.04 using Subversion::
address@hidden * Installation with gnunet-update::
-* Instructions for Microsoft Windows Platforms (Old)::
address@hidden menu
-
-
address@hidden Installing GNUnet 0.10.1 on Ubuntu 14.04
address@hidden Installing GNUnet 0.10.1 on Ubuntu 14.04
-
-Install the required dependencies:
-
address@hidden
-$ sudo apt-get install libltdl-dev libgpg-error-dev libidn11-dev \
- libunistring-dev libglpk-dev libbluetooth-dev libextractor-dev \
- libmicrohttpd-dev libgnutls28-dev
address@hidden example
-
-Choose one or more database backends:
-
address@hidden @bullet
-
address@hidden SQLite3
-
address@hidden
- $ sudo apt-get install libsqlite3-dev@
address@hidden example
-
address@hidden MySQL
-
address@hidden
-$ sudo apt-get install libmysqlclient-dev@
address@hidden example
-
address@hidden PostgreSQL
-
address@hidden
- $ sudo apt-get install libpq-dev postgresql@
address@hidden example
-
address@hidden itemize
-
-Install the optional dependencies for gnunet-conversation:
-
address@hidden
- $ sudo apt-get install gstreamer1.0 libpulse-dev libopus-dev
address@hidden example
-
-Install libgcrypt 1.6:
-
address@hidden @bullet
-
address@hidden For Ubuntu 14.04:
-
address@hidden
-$ sudo apt-get install libgcrypt20-dev
address@hidden example
-
address@hidden For Ubuntu older than 14.04:
-
address@hidden
-wget ftp://ftp.gnupg.org/gcrypt/libgcrypt/libgcrypt-1.6.1.tar.bz2
-$ tar xf libgcrypt-1.6.1.tar.bz2
-$ cd libgcrypt-1.6.1
-$ ./configure
-$ sudo make install
-$ cd ..
address@hidden example
address@hidden itemize
-
-Install libgnurl:
-
address@hidden source installation - libgnurl}.
-
-Install GNUnet:
-
address@hidden
-$ wget http://ftpmirror.gnu.org/gnunet/gnunet-0.10.1.tar.gz
-$ tar xf gnunet-0.10.1.tar.gz
-$ cd gnunet-0.10.1
address@hidden example
-
-If you want to:
-
address@hidden @bullet
-
address@hidden
-Install to a different directory:
-
address@hidden
---prefix=PREFIX
address@hidden example
-
address@hidden
-Have sudo permission, but do not want to compile as root:
-
address@hidden
---with-sudo
address@hidden example
-
address@hidden
-Want debug message enabled:
-
address@hidden
---enable-logging=verbose
address@hidden example
-
address@hidden itemize
-
address@hidden
-$ ./configure [ --with-sudo | --prefix=PREFIX | --enable-logging=verbose]
-$ make; sudo make install
address@hidden example
-
-After installing it, you need to create an empty configuration file:
-
address@hidden
-touch ~/.config/gnunet.conf
address@hidden example
-
-And finally you can start GNUnet with
-
address@hidden
-$ gnunet-arm -s
address@hidden example
-
address@hidden Building GLPK for MinGW
address@hidden Building GLPK for MinGW
-
-GNUnet now requires the GNU Linear Programming Kit (GLPK).
-Since there's is no package you can install with @code{mingw-get} you
-have to compile it from source:
-
address@hidden @bullet
-
address@hidden Download the latest version from
address@hidden://ftp.gnu.org/gnu/glpk/}
-
address@hidden Unzip the downloaded source tarball using your favourite
-unzipper application In the MSYS shell
-
address@hidden change to the respective directory
-
address@hidden Configure glpk for "i686-pc-mingw32":
-
address@hidden
-./configure '--build=i686-pc-mingw32'
address@hidden example
-
address@hidden run
-
address@hidden
-make install check
address@hidden example
-
address@hidden itemize
-
-MinGW does not automatically detect the correct buildtype so you have to
-specify it manually.
-
-
address@hidden GUI build instructions for Ubuntu 12.04 using Subversion
address@hidden GUI build instructions for Ubuntu 12.04 using Subversion
-
-After installing GNUnet you can continue installing the GNUnet GUI tools:
-
-First, install the required dependencies:
-
address@hidden
-$ sudo apt-get install libgladeui-dev libqrencode-dev
address@hidden 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
-
address@hidden @bullet
-
address@hidden set the environmental variable permanently to:
-
address@hidden
-LD_LIBRARY_PATH=$GNUNET_PREFIX
address@hidden example
-
address@hidden or add @code{$GNUNET_PREFIX} to @file{/etc/ld.so.conf}
-
address@hidden itemize
-
-Now you can checkout and compile the GNUnet GUI tools:
-
address@hidden
-$ git clone https://gnunet.org/git/gnunet-gtk
-$ cd gnunet-gtk
-$ ./bootstrap
-$ ./configure --prefix=$GNUNET_PREFIX/.. --with-gnunet=$GNUNET_PREFIX/..
-$ make install
address@hidden example
-
address@hidden @node Installation with gnunet-update
address@hidden @subsection Installation with gnunet-update
-
address@hidden gnunet-update project is an effort to introduce updates to GNUnet
address@hidden installations. An interesting to-be-implemented-feature of
gnunet-update
address@hidden is that these updates are propagated through GNUnet's
peer-to-peer
address@hidden network. More information about gnunet-update can be found at
address@hidden @c FIXME: Use correct cgit URL
address@hidden
@uref{https://gnunet.org/git/gnunet-update.git/tree/plain/README}.
-
address@hidden While the project is still under development, we have
implemented the
address@hidden following features which we believe may be helpful for users and
we
address@hidden would like them to be tested:
-
address@hidden @itemize @bullet
-
address@hidden @item
address@hidden Packaging GNUnet installation along with its run-time
dependencies into
address@hidden update packages
-
address@hidden @item
address@hidden Installing update packages into compatible hosts
-
address@hidden @item
address@hidden Updating an existing installation (which had been installed by
address@hidden gnunet-update) to a newer one
-
address@hidden @end itemize
-
address@hidden The above said features of gnunet-update are currently available
for
address@hidden testing on GNU/Linux systems.
-
address@hidden The following is a guide to help you get started with
gnunet-update.
address@hidden It shows you how to install the testing binary packages of GNUnet
address@hidden 0.9.1 we have at @uref{https://gnunet.org/install/}.
-
address@hidden gnunet-update needs the following dependencies:
-
address@hidden @itemize @bullet
address@hidden @item
address@hidden python @geq{} 2.6
-
address@hidden @item
address@hidden gnupg
-
address@hidden @item
address@hidden python-gpgme
address@hidden @end itemize
-
-
address@hidden Checkout gnunet-update:
-
address@hidden @c FIXME: git!
address@hidden @example
address@hidden $ svn checkout -r24905 https://gnunet.org/svn/gnunet-update@
address@hidden @end example
-
address@hidden For security reasons, all packages released for gnunet-update
from us are
address@hidden signed with the key at @uref{https://gnunet.org/install/key.txt}.
address@hidden You would need to import this key into your gpg key ring.
address@hidden gnunet-update uses this key to verify the integrity of the
packages it
address@hidden installs:
-
address@hidden @example
address@hidden $ gpg --recv-keys 7C613D78@
address@hidden @end example
-
address@hidden Download the packages relevant to your architecture (currently I
have
address@hidden access to GNU/Linux machines on x86_64 and i686, so only two for
now,
address@hidden hopefully more later) from https://gnunet.org/install/.
-
address@hidden To install the downloaded package into the directory /foo:
-
address@hidden @example
address@hidden gnunet-update/bin/gnunet-update install downloaded/package /foo
address@hidden @end example
-
address@hidden The installer reports the directories into which shared
libraries and
address@hidden dependencies have been installed. You may need to add the
reported shared
address@hidden library installation paths to LD_LIBRARY_PATH before you start
running any
address@hidden installed binaries.
-
address@hidden Please report bugs at https://gnunet.org/bugs/ under the project
address@hidden 'gnunet-update'.
-
address@hidden Instructions for Microsoft Windows Platforms (Old)
address@hidden Instructions for Microsoft Windows Platforms (Old)
-
-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.
-
-The Windows build uses a UNIX emulator for Windows,
address@hidden://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 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.
-
address@hidden
-* Hardware and OS requirements::
-* Software installation::
-* Building libextractor and GNUnet::
-* Installer::
-* Source::
address@hidden menu
-
address@hidden Hardware and OS requirements
address@hidden Hardware and OS requirements
-
address@hidden @bullet
-
address@hidden Pentium II or equivalent processor, @geq{} 350 MHz
-
address@hidden 128 MB RAM
-
address@hidden 600 MB free disk space
-
address@hidden Windows 2000 or Windows XP are recommended
-
address@hidden itemize
-
address@hidden Software installation
address@hidden Software installation
-
address@hidden @bullet
-
address@hidden
address@hidden software}@
-
-The software packages GNUnet depends on are usually compressed using UNIX
-tools like @command{tar}, @command{gzip}, @command{xzip} and
address@hidden
-If you do not already have an utility that is able to extract such
-archives, get @uref{http://www.7-zip.org/, 7-Zip}.
-
address@hidden
address@hidden environment}@
-
-The MinGW project provides the compiler toolchain that is used to build
-GNUnet.
-Get the following packages from the
address@hidden://sourceforge.net/projects/mingw/files/, MinGW} project:
-
address@hidden @bullet
-
address@hidden GCC core
address@hidden GCC g++
address@hidden MSYS
address@hidden MSYS Developer Tool Kit (msysDTK)
address@hidden MSYS Developer Tool Kit - msys-autoconf (bin)
address@hidden MSYS Developer Tool Kit - msys-automake (bin)
address@hidden MinGW Runtime
address@hidden MinGW Utilities
address@hidden Windows API
address@hidden Binutils
address@hidden make
address@hidden pdcurses
address@hidden GDB (snapshot)
address@hidden itemize
-
address@hidden @bullet
-
-
address@hidden 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}.
-
address@hidden Install MinGW runtime, utilities and GCC to a subdirectory
-(to @file{c:\mingw\mingw}, for example)
-
address@hidden Install the Development Kit to the MSYS directory
-(@file{c:\mingw})
-
address@hidden Create a batch file bash.bat in your MSYS directory with
-the files:
-
address@hidden
-bin\sh.exe --login
address@hidden example
-
-This batch file opens a shell which is used to invoke the build
-processes.
-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.
-
address@hidden
-Start @command{bash.sh} and rename
address@hidden:\mingw\mingw\lib\libstdc++.la} to avoid problems:
-
address@hidden
-mv /usr/mingw/lib/libstdc++.la /usr/mingw/lib/libstdc++.la.broken
address@hidden example
-
address@hidden
-Unpack the Windows API to the MinGW directory (@file{c:\mingw\mingw\}) and
-remove the declaration of DATADIR from
-(@file{c:\mingw\mingw\include\objidl.h} (lines 55-58)
-
address@hidden
-Unpack autoconf, automake to the MSYS directory (@file{c:\mingw})
-
address@hidden
-Install all other packages to the MinGW directory (@file{c:\mingw\mingw\})
address@hidden itemize
-
-
address@hidden @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})
-
address@hidden @strong{Pthreads}@
-GNUnet uses the portable POSIX thread library for multi-threading:
-
address@hidden @bullet
-
address@hidden Save
address@hidden://sources.redhat.com/pub/pthreads-win32/dll-latest/lib/x86/libpthreadGC2.a,
libpthreadGC2.a}
-(x86) or
address@hidden://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}).
-
address@hidden Save
address@hidden://sources.redhat.com/pub/pthreads-win32/dll-latest/lib/x86/pthreadGC2.dll,
pthreadGC2.dll}
-(x86) or
address@hidden://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}).
-
address@hidden Download all header files from
address@hidden://sources.redhat.com/pub/pthreads-win32/dll-latest/include/,
include/}
-to the @file{include} directory (@file{c:\mingw\mingw\include}).
address@hidden itemize
-
-
address@hidden @strong{GNU MP}@
-GNUnet uses the GNU Multiple Precision library for special cryptographic
-operations. Get the GMP binary package from the
address@hidden://sourceforge.net/projects/mingwrep/, MinGW repository} and
-unpack it to the MinGW directory (@file{c:\mingw\mingw})
-
address@hidden @strong{GNU Gettext}@
-GNU gettext is used to provide national language support.
-Get the prebuilt package from hereand unpack it to the MinGW
-directory (@file{c:\mingw\mingw})
-
address@hidden @strong{GNU iconv}@
-GNU Libiconv is used for character encoding conversion.
-Get the prebuilt package from here and unpack it to the MinGW
-directory (@file{c:\mingw\mingw}).
-
address@hidden @strong{SQLite}@
-GNUnet uses the SQLite database to store data.
-Get the prebuilt binary from here and unpack it to your MinGW directory.
-
address@hidden @strong{MySQL}@
-As an alternative to SQLite, GNUnet also supports MySQL.
-
address@hidden @bullet
-
address@hidden Get the binary installer from the
address@hidden://dev.mysql.com/downloads/mysql/4.1.html#Windows, MySQL project}
-(version 4.1), install it and follow the instructions in
address@hidden
-
address@hidden Create a temporary build directory (@file{c:\mysql})
-
address@hidden Copy the directories @file{include\} and @file{lib\} from the
-MySQL directory to the new directory
-
address@hidden Get the patches from
address@hidden://bugs.mysql.com/bug.php?id=8906&files=1, Bug #8906} and
address@hidden://bugs.mysql.com/bug.php?id=8872&files=1, Bug #8872} (the
-latter is only required for MySQL
-
address@hidden
-patch -p 0
address@hidden example
-
address@hidden Move @file{lib\opt\libmysql.dll} to @file{lib\libmysql.dll}
-
address@hidden Change to @file{lib\} and create an import library:
-
address@hidden
-dlltool --input-def ../include/libmySQL.def \
---dllname libmysql.dll \
---output-lib libmysqlclient.a -k
address@hidden example
-
address@hidden Copy include\* to include\mysql\
-
address@hidden Pass @code{--with-mysql=/c/mysql} to
address@hidden/configure} and copy @file{libmysql.dll}
-to your PATH or GNUnet's @file{bin} directory
address@hidden itemize
-
-
address@hidden @strong{GTK+}@
address@hidden and @command{libextractor} depend on GTK.
-Get the the binary and developer packages of @command{atk},
address@hidden, @command{gtk}, @command{iconv},
address@hidden, @command{pango} from
address@hidden://ftp.gtk.org/pub/gtk/v2.6/win32, gtk.org} and unpack them
-to the MinGW directory (@file{c:\mingw\mingw}).
address@hidden FIXME: The URL below for pkg-config seems wrong.
-Get @uref{http://www.gtk.org/download/win32.php, pkg-config} and
address@hidden and unpack them to the MinGW directory
-(@file{c:\mingw\mingw}).
-Here is an all-in-one package for the
address@hidden://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!
-
address@hidden @strong{Glade}@
address@hidden and @command{gnunet-setup} were created using
-this interface builder
-
address@hidden @bullet
-
address@hidden Get the Glade and libglade (-bin and -devel) packages
-(without GTK!) from
address@hidden://gladewin32.sourceforge.net/, GladeWin32} and unpack them to
-the MinGW directory (@file{c:\mingw\mingw}).
-
address@hidden Get @command{libxml} from here and unpack it to the MinGW
-directory (@file{c:\mingw\mingw}).
address@hidden itemize
-
address@hidden FIXME: URLs
address@hidden @strong{zLib}@
address@hidden 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}).
-
address@hidden @strong{Bzip2}@
address@hidden also requires @command{Bzip2} to
-decompress some file formats.
-Get the Bzip2 (binary and developer package) from
address@hidden://gnuwin32.sourceforge.net/packages/bzip2.htm, GnuWin32} and
-unpack it to the MinGW directory (@file{c:\mingw\mingw}).
-
address@hidden @strong{Libgcrypt}@
address@hidden 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
-(@file{c:\mingw\mingw}). Currently libgcrypt @geq{} 1.4.2 is required to
-compile GNUnet.
-
address@hidden @strong{PlibC}@
-PlibC emulates Unix functions under Windows. Get PlibC from here and
-unpack it to the MinGW directory (c:\mingw\mingw)
-
address@hidden @strong{OGG Vorbis}@
address@hidden Vorbis} is used to extract meta-data from @file{.ogg} files.
-Get the packages
address@hidden://www.gnunet.org/libextractor/download/win/libogg-1.1.4.zip,
libogg}
-and
address@hidden://www.gnunet.org/libextractor/download/win/libvorbis-1.2.3.zip,
libvorbis}
-from the
address@hidden://ftp.gnu.org/gnu/libextractor/libextractor-w32-1.0.0.zip,
libextractor win32 build}
-and unpack them to the MinGW directory (c:\mingw\mingw).
-
address@hidden @strong{Exiv2}@
-(lib)Exiv2 is used to extract meta-data from files with Exiv2 meta-data.
-Download
address@hidden://www.gnunet.org/libextractor/download/win/exiv2-0.18.2.zip,
Exiv2}
-and unpack it to the MSYS directory (c:\mingw).
address@hidden itemize
-
address@hidden Building libextractor and GNUnet
address@hidden Building libextractor and GNUnet
-
-Before you compile @command{libextractor} or @command{GNUnet},
-be sure to set @code{PKG_CONFIG_PATH}:
-
address@hidden
-export PKG_CONFIG_PATH=/mingw/lib/pkgconfig
address@hidden example
-
address@hidden
address@hidden Installation Handbook}, for basic instructions on building
address@hidden 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}:
-
address@hidden
-export CFLAGS='-O2 -march=pentium -fomit-frame-pointer'
-./configure --prefix=$HOME --with-extractor=$HOME
address@hidden example
-
address@hidden Installer
address@hidden Installer
-
-The GNUnet installer is made with
address@hidden://nsis.sourceforge.net/, NSIS}. The installer script is
-located in @file{contrib\win} in the GNUnet source tree.
-
address@hidden Source
address@hidden Source
-
address@hidden FIXME: URL
-The sources of all dependencies are available here.
-
address@hidden @node Portable GNUnet
address@hidden @section Portable GNUnet
-
address@hidden Quick instructions on how to use the most recent GNUnet on most
GNU/Linux
address@hidden distributions
-
address@hidden Currently this has only been tested on Ubuntu 12.04, 12.10,
13.04, Debian
address@hidden and CentOS 6, but it should work on almost any GNU/Linux
distribution.
address@hidden More in-detail information can be found in the handbook.
-
address@hidden Note 2017-10: Currently this section assumes the old SVN repo of
GNUnet
address@hidden which no longer exists.
-
address@hidden @menu
address@hidden * Prerequisites::
address@hidden * Download & set up gnunet-update::
address@hidden * Install GNUnet::
address@hidden @end menu
-
address@hidden @node Prerequisites
address@hidden @subsection Prerequisites
-
address@hidden Open a terminal and paste this line into it to install all
required tools
address@hidden needed:
-
address@hidden @example
address@hidden sudo apt-get install python-gpgme subversion
address@hidden @end example
-
address@hidden @node Download & set up gnunet-update
address@hidden @subsection Download & set up gnunet-update
-
address@hidden The following command will download a working version of
gnunet-update
address@hidden with the subversion tool and import the public key which is
needed for
address@hidden authentication:
-
address@hidden @example
address@hidden svn checkout -r24905 https://gnunet.org/svn/gnunet-update
~/gnunet-update
address@hidden cd ~/gnunet-update
address@hidden gpg --keyserver "hkp://keys.gnupg.net" --recv-keys 7C613D78
address@hidden @end example
-
address@hidden @node Install GNUnet
address@hidden @subsection Install GNUnet
-
address@hidden Download and install GNUnet binaries which can be found here and
set
address@hidden library paths:
-
address@hidden @example
address@hidden wget -P /tmp
https://gnunet.org/install/packs/gnunet-0.9.4-`uname -m`.tgz
address@hidden ./bin/gnunet-update install /tmp/gnunet-0.9*.tgz ~
address@hidden echo "PATH address@hidden@}:$HOME/bin" >> ~/.pam_environment
address@hidden echo -e "address@hidden@}/address@hidden@}/lib/gnunet-deps" |
sudo tee \
address@hidden /etc/ld.so.conf.d/gnunet.conf > /dev/null
address@hidden sudo ldconfig
address@hidden @end example
-
address@hidden You may need to re-login once after executing these last commands
-
address@hidden That's it, GNUnet is installed in your home directory now.
GNUnet can be
address@hidden configured and afterwards started by executing:
-
address@hidden @example
address@hidden gnunet-arm -s
address@hidden @end example
-
address@hidden The graphical configuration interface
address@hidden The graphical configuration interface
-
-If you also would like to use @command{gnunet-gtk} and
address@hidden (highly recommended for beginners), do:
-
address@hidden
-wget -P /tmp \
-https://gnunet.org/install/packs/gnunet-0.9.4-gtk-0.9.4-`uname -m`.tgz
-sh ~/gnunet-update/bin/gnunet-update install /tmp/gnunet-*gtk*.tgz ~
-sudo ldconfig
address@hidden example
-
-Now you can run @command{gnunet-setup} for easy configuration of your
-GNUnet peer.
-
address@hidden
-* Configuring your peer::
-* Configuring the Friend-to-Friend (F2F) mode::
-* Configuring the hostlist to bootstrap::
-* Configuration of the HOSTLIST proxy settings::
-* Configuring your peer to provide a hostlist ::
-* Configuring the datastore::
-* Configuring the MySQL database::
-* Reasons for using MySQL::
-* Reasons for not using MySQL::
-* Setup Instructions::
-* Testing::
-* Performance Tuning::
-* Setup for running Testcases::
-* Configuring the Postgres database::
-* Reasons to use Postgres::
-* Reasons not to use Postgres::
-* Manual setup instructions::
-* Testing the setup manually::
-* Configuring the datacache::
-* Configuring the file-sharing service::
-* Configuring logging::
-* Configuring the transport service and plugins::
-* Configuring the wlan transport plugin::
-* Configuring HTTP(S) reverse proxy functionality using Apache or nginx::
-* Blacklisting peers::
-* Configuration of the HTTP and HTTPS transport plugins::
-* Configuring the GNU Name System::
-* Configuring the GNUnet VPN::
-* Bandwidth Configuration::
-* Configuring NAT::
-* Peer configuration for distributions::
address@hidden menu
-
address@hidden Configuring your peer
address@hidden Configuring your peer
-
-This chapter will describe the various configuration options in GNUnet.
-
-The easiest way to configure your peer is to use the
address@hidden tool.
address@hidden 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 @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
-as it requires a more in-depth understanding of the configuration files
-and internal dependencies of GNUnet.
-
address@hidden Configuring the Friend-to-Friend (F2F) mode
address@hidden Configuring the Friend-to-Friend (F2F) mode
-
-GNUnet knows three basic modes of operation:
address@hidden @bullet
address@hidden In standard "peer-to-peer" mode,
-your peer will connect to any peer.
address@hidden In the pure "friend-to-friend"
-mode, your peer will ONLY connect to peers from a list of friends
-specified in the configuration.
address@hidden Finally, in mixed mode,
-GNUnet will only connect to arbitrary peers if it
-has at least a specified number of connections to friends.
address@hidden itemize
-
-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
-
address@hidden
-$ gnunet-peerinfo -sq
address@hidden example
-
address@hidden
-The resulting output of this command needs to be added to your
address@hidden 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 @file{friends} file in the
address@hidden option of the "topology" section.
-
-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
address@hidden to zero and @code{FRIENDS_ONLY} to NO.
-This is the default.
-
address@hidden Configuring the hostlist to bootstrap
address@hidden Configuring the hostlist to bootstrap
-
-After installing the software you need to get connected to the GNUnet
-network. The configuration file included in your download is already
-configured to connect you to the GNUnet network.
-In this section the relevant configuration settings are explained.
-
-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".
-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 the @code{[hostlist]}-section in your
-configuration file. You have to set the argument @command{-b} in the
-options line:
-
address@hidden
-[hostlist]
-OPTIONS = -b
address@hidden example
-
-Additionally you have to specify which server you want to use.
-The default bootstrapping server is
-"@uref{http://v10.gnunet.org/hostlist, http://v10.gnunet.org/hostlist}";.
-[^] To set the server you have to edit the line "SERVERS" in the hostlist
-section. To use the default server you should set the lines to
-
address@hidden
-SERVERS = http://v10.gnunet.org/hostlist [^]
address@hidden example
-
address@hidden
-To use bootstrapping your configuration file should include these lines:
-
address@hidden
-[hostlist]
-OPTIONS = -b
-SERVERS = http://v10.gnunet.org/hostlist [^]
address@hidden example
-
address@hidden
-Besides using bootstrap servers you can configure your GNUnet peer to
-recieve hostlist advertisements.
-Peers offering hostlists to other peers can send advertisement messages
-to peers that connect to them. If you configure your peer to receive these
-messages, your peer can download these lists and connect to the peers
-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 @command{-e}
-switch to the @code{OPTIONS} line in the hostlist section:
-
address@hidden
-[hostlist]
-OPTIONS = -b -e
address@hidden example
-
address@hidden
-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:
-
address@hidden
-HOSTLISTFILE = hostlists.file
address@hidden example
-
address@hidden
-Best practice is to activate both bootstrapping and hostlist learning.
-So your configuration file should include these lines:
-
address@hidden
-[hostlist]
-OPTIONS = -b -e
-HTTPPORT = 8080
-SERVERS = http://v10.gnunet.org/hostlist [^]
-HOSTLISTFILE = $SERVICEHOME/hostlists.file
address@hidden example
-
address@hidden Configuration of the HOSTLIST proxy settings
address@hidden Configuration of the HOSTLIST proxy settings
-
-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 @command{gnunet-setup} tool.
-
-The hostlist client supports the following proxy types at the moment:
-
address@hidden @bullet
address@hidden HTTP and HTTP 1.0 only proxy
address@hidden SOCKS 4/4a/5/5 with hostname
address@hidden itemize
-
-In addition authentication at the proxy with username and password can be
-configured.
-
-To configure proxy support for the hostlist client in the
address@hidden 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 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 provide these options directly in the configuration, you can
-enter the following settings in the @code{[hostlist]} section of
-the configuration:
-
address@hidden
-# Type of proxy server,
-# Valid values: HTTP, HTTP_1_0, SOCKS4, SOCKS5, SOCKS4A, SOCKS5_HOSTNAME
-# Default: HTTP
-# PROXY_TYPE = HTTP
-
-# Hostname or IP of proxy server
-# PROXY =
-# User name for proxy server
-# PROXY_USERNAME =
-# User password for proxy server
-# PROXY_PASSWORD =
address@hidden example
-
address@hidden Configuring your peer to provide a hostlist
address@hidden Configuring your peer to provide a hostlist
-
-If you operate a peer permanently connected to GNUnet you can configure
-your peer to act as a hostlist server, providing other peers the list of
-peers known to him.
-
-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 libgnurl (or libcurl)
-and microhttpd support.
-How you build your peer with these options can be found here:
address@hidden installation instructions}.
-
-To configure your peer to act as a bootstrap server you have to add the
address@hidden 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:
-
address@hidden
-[hostlist]
-HTTPPORT = 12980
-OPTIONS = -p
address@hidden example
-
address@hidden
-If your peer acts as a bootstrap server other peers should know about
-that. You can advertise the hostlist your are providing to other peers.
-Peers connecting to your peer will get a message containing an
-advertisement for your hostlist and the URL where it can be downloaded.
-If this peer is in learning mode, it will test the hostlist and, in the
-case it can obtain the list successfully, it will save it for
-bootstrapping.
-
-To activate hostlist advertisement on your peer, you have to set the
-following lines in your configuration file:
-
address@hidden
-[hostlist]
-EXTERNAL_DNS_NAME = example.org
-HTTPPORT = 12981
-OPTIONS = -p -a
address@hidden example
-
address@hidden
-With this configuration your peer will a act as a bootstrap server and
-advertise this hostlist to other peers connecting to it.
-The URL used to download the list will be
address@hidden@uref{http://example.org:12981/, http://example.org:12981/}}.
-
-Please notice:
-
address@hidden @bullet
address@hidden 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!
address@hidden Advertising without providing a hostlist does not make sense and
-will not work.
address@hidden itemize
-
address@hidden Configuring the datastore
address@hidden Configuring the datastore
-
-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 @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
-so. Currently, you have the choice between sqLite, MySQL and Postgres.
-
address@hidden Configuring the MySQL database
address@hidden Configuring the MySQL database
-
-This section describes how to setup the MySQL database for GNUnet.
-
-Note that the mysql plugin does NOT work with mysql before 4.1 since we
-need prepared statements.
-We are generally testing the code against MySQL 5.1 at this point.
-
address@hidden Reasons for using MySQL
address@hidden Reasons for using MySQL
-
address@hidden @bullet
-
address@hidden 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).
-
address@hidden Its often possible to recover the mysql database from internal
-inconsistencies. Some of the other databases do not support repair.
address@hidden itemize
-
address@hidden Reasons for not using MySQL
address@hidden Reasons for not using MySQL
-
address@hidden @bullet
address@hidden Memory usage (likely not an issue if you have more than 1 GB)
address@hidden Complex manual setup
address@hidden itemize
-
address@hidden Setup Instructions
address@hidden Setup Instructions
-
address@hidden @bullet
-
address@hidden In @file{gnunet.conf} set in section @code{DATASTORE} the value
for
address@hidden to @code{mysql}.
-
address@hidden Access mysql as root:
-
address@hidden
-$ mysql -u root -p
address@hidden example
-
address@hidden
-and issue the following commands, replacing $USER with the username
-that will be running @command{gnunet-arm} (so typically "gnunet"):
-
address@hidden
-CREATE DATABASE gnunet;
-GRANT select,insert,update,delete,create,alter,drop,create \
-temporary tables ON gnunet.* TO $USER@@localhost;
-SET PASSWORD FOR $USER@@localhost=PASSWORD('$the_password_you_like');
-FLUSH PRIVILEGES;
address@hidden example
-
address@hidden
-In the $HOME directory of $USER, create a @file{.my.cnf} file with the
-following lines
-
address@hidden
-[client]
-user=$USER
-password=$the_password_you_like
address@hidden example
-
address@hidden itemize
-
-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.
-
address@hidden Testing
address@hidden Testing
-
-You should briefly try if the database connection works. First, login
-as $USER. Then use:
-
address@hidden
-$ mysql -u $USER
-mysql> use gnunet;
address@hidden example
-
address@hidden
-If you get the message
-
address@hidden
-Database changed
address@hidden example
-
address@hidden
-it probably works.
-
-If you get
-
address@hidden
-ERROR 2002: Can't connect to local MySQL server
-through socket '/tmp/mysql.sock' (2)
address@hidden example
-
address@hidden
-it may be resolvable by
-
address@hidden
-ln -s /var/run/mysqld/mysqld.sock /tmp/mysql.sock
address@hidden example
-
address@hidden
-so there may be some additional trouble depending on your mysql setup.
-
address@hidden Performance Tuning
address@hidden Performance Tuning
-
-For GNUnet, you probably want to set the option
-
address@hidden
-innodb_flush_log_at_trx_commit = 0
address@hidden example
-
address@hidden
-for a rather dramatic boost in MySQL performance. However, this reduces
-the "safety" of your database as with this options you may loose
-transactions during a power outage.
-While this is totally harmless for GNUnet, the option applies to all
-applications using MySQL. So you should set it if (and only if) GNUnet is
-the only application on your system using MySQL.
-
address@hidden Setup for running Testcases
address@hidden Setup for running Testcases
-
-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 (@command{make check}).
-
address@hidden Configuring the Postgres database
address@hidden Configuring the Postgres database
-
-This text describes how to setup the Postgres database for GNUnet.
-
-This Postgres plugin was developed for Postgres 8.3 but might work for
-earlier versions as well.
-
address@hidden Reasons to use Postgres
address@hidden Reasons to use Postgres
-
address@hidden @bullet
address@hidden Easier to setup than MySQL
address@hidden Real database
address@hidden itemize
-
address@hidden Reasons not to use Postgres
address@hidden Reasons not to use Postgres
-
address@hidden @bullet
address@hidden Quite slow
address@hidden Still some manual setup required
address@hidden itemize
-
address@hidden Manual setup instructions
address@hidden Manual setup instructions
-
address@hidden @bullet
address@hidden In @file{gnunet.conf} set in section @code{DATASTORE} the value
for
address@hidden to @code{postgres}.
address@hidden Access Postgres to create a user:
-
address@hidden @asis
address@hidden with Postgres 8.x, use:
-
address@hidden
-# su - postgres
-$ createuser
address@hidden example
-
address@hidden
-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.
-
address@hidden with Postgres 9.x, use:
-
address@hidden
-# su - postgres
-$ createuser -d $GNUNET_USER
address@hidden example
-
address@hidden
-where $GNUNET_USER is the name of the user running GNUnet.
-
address@hidden table
-
-
address@hidden
-As that user (so typically as user "gnunet"), create a database (or two):
-
address@hidden
-$ createdb gnunet
-# this way you can run "make check"
-$ createdb gnunetcheck
address@hidden example
-
address@hidden itemize
-
-Now you should be able to start @code{gnunet-arm}.
-
address@hidden Testing the setup manually
address@hidden Testing the setup manually
-
-You may want to try if the database connection works. First, again login
-as the user who will run @command{gnunet-arm}. Then use:
-
address@hidden
-$ psql gnunet # or gnunetcheck
-gnunet=> \dt
address@hidden example
-
address@hidden
-If, after you have started @command{gnunet-arm} at least once, you get
-a @code{gn090} table here, it probably works.
-
address@hidden Configuring the datacache
address@hidden Configuring the datacache
address@hidden %**end of header
-
-The datacache is what GNUnet uses for storing temporary data. This data is
-expected to be wiped completely each time GNUnet is restarted (or the
-system is rebooted).
-
-You need to specify how many bytes GNUnet is allowed to use for the
-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.
-
address@hidden Configuring the file-sharing service
address@hidden Configuring the file-sharing service
-
-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 @code{AUTOSTART} option in
-section @code{[fs]} to "YES". Alternatively, you can run
-
address@hidden
-$ gnunet-arm -i fs
address@hidden example
-
address@hidden
-to start the file-sharing service by hand.
-
-Except for configuring the database and the datacache the only important
-option for file-sharing is content migration.
-
-Content migration allows your peer to cache content from other peers as
-well as send out content stored on your system without explicit requests.
-This content replication has positive and negative impacts on both system
-performance and privacy.
-
-FIXME: discuss the trade-offs. Here is some older text about it...
-
-Setting this option to YES allows gnunetd to migrate data to the local
-machine. Setting this option to YES is highly recommended for efficiency.
-Its also the default. If you set this value to YES, GNUnet will store
-content on your machine that you cannot decrypt.
-While this may protect you from liability if the judge is sane, it may
-not (IANAL). If you put illegal content on your machine yourself, setting
-this option to YES will probably increase your chances to get away with it
-since you can plausibly deny that you inserted the content.
-Note that in either case, your anonymity would have to be broken first
-(which may be possible depending on the size of the GNUnet network and the
-strength of the adversary).
-
address@hidden Configuring logging
address@hidden Configuring logging
-
-Logging in GNUnet 0.9.0 is controlled via the "-L" and "-l" options.
-Using @code{-L}, a log level can be specified. With log level
address@hidden 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
address@hidden can be used by developers to log debugging messages
-(but you need to run @code{./configure} with
address@hidden to get them compiled).
-The @code{-l} option is used to specify the log file.
-
-Since most GNUnet services are managed by @code{gnunet-arm}, using the
address@hidden 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
address@hidden option.
-The value specified here is given as an extra option to all services for
-which the configuration does contain a service-specific @code{OPTIONS}
-field.
-
address@hidden can contain the special sequence "@address@hidden" 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
address@hidden to log-files called @code{SERVICENAME-logs}, the
-following global prefix should be used:
-
address@hidden
-GLOBAL_POSTFIX = -l $SERVICEHOME/@address@hidden -L INFO
address@hidden example
-
address@hidden Configuring the transport service and plugins
address@hidden Configuring the transport service and plugins
-
-The transport service in GNUnet is responsible to maintain basic
-connectivity to other peers.
-Besides initiating and keeping connections alive it is also responsible
-for address validation.
-
-The GNUnet transport supports more than one transport protocol.
-These protocols are configured together with the transport service.
-
-The configuration section for the transport service itself is quite
-similar to all the other services
-
address@hidden
-AUTOSTART = YES
-@@UNIXONLY@@ PORT = 2091
-HOSTNAME = localhost
-HOME = $SERVICEHOME
-CONFIG = $DEFAULTCONFIG
-BINARY = gnunet-service-transport
-#PREFIX = valgrind
-NEIGHBOUR_LIMIT = 50
-ACCEPT_FROM = 127.0.0.1;
-ACCEPT_FROM6 = ::1;
-PLUGINS = tcp udp
-UNIXPATH = /tmp/gnunet-service-transport.sock
address@hidden example
-
-Different are the settings for the plugins to load @code{PLUGINS}.
-The first setting specifies which transport plugins to load.
-
address@hidden @bullet
address@hidden transport-unix
-A plugin for local only communication with UNIX domain sockets. Used for
-testing and available on unix systems only. Just set the port
-
address@hidden
-[transport-unix]
-PORT = 22086
-TESTING_IGNORE_KEYS = ACCEPT_FROM;
address@hidden example
-
address@hidden transport-tcp
-A plugin for communication with TCP. Set port to 0 for client mode with
-outbound only connections
-
address@hidden
-[transport-tcp]
-# Use 0 to ONLY advertise as a peer behind NAT (no port binding)
-PORT = 2086
-ADVERTISED_PORT = 2086
-TESTING_IGNORE_KEYS = ACCEPT_FROM;
-# Maximum number of open TCP connections allowed
-MAX_CONNECTIONS = 128
address@hidden example
-
address@hidden transport-udp
-A plugin for communication with UDP. Supports peer discovery using
-broadcasts.
-
address@hidden
-[transport-udp]
-PORT = 2086
-BROADCAST = YES
-BROADCAST_INTERVAL = 30 s
-MAX_BPS = 1000000
-TESTING_IGNORE_KEYS = ACCEPT_FROM;
address@hidden example
-
address@hidden transport-http
-HTTP and HTTPS support is split in two part: a client plugin initiating
-outbound connections and a server part accepting connections from the
-client. The client plugin just takes the maximum number of connections as
-an argument.
-
address@hidden
-[transport-http_client]
-MAX_CONNECTIONS = 128
-TESTING_IGNORE_KEYS = ACCEPT_FROM;
address@hidden example
-
address@hidden
-[transport-https_client]
-MAX_CONNECTIONS = 128
-TESTING_IGNORE_KEYS = ACCEPT_FROM;
address@hidden example
-
address@hidden
-The server has a port configured and the maximum nunber of connections.
-The HTTPS part has two files with the certificate key and the certificate
-file.
-
-The server plugin supports reverse proxies, so a external hostname can be
-set using the @code{EXTERNAL_HOSTNAME} setting.
-The webserver under this address should forward the request to the peer
-and the configure port.
-
address@hidden
-[transport-http_server]
-EXTERNAL_HOSTNAME = fulcrum.net.in.tum.de/gnunet
-PORT = 1080
-MAX_CONNECTIONS = 128
-TESTING_IGNORE_KEYS = ACCEPT_FROM;
address@hidden example
-
address@hidden
-[transport-https_server]
-PORT = 4433
-CRYPTO_INIT = NORMAL
-KEY_FILE = https.key
-CERT_FILE = https.cert
-MAX_CONNECTIONS = 128
-TESTING_IGNORE_KEYS = ACCEPT_FROM;
address@hidden example
-
address@hidden transport-wlan
-
-The next section describes how to setup the WLAN plugin,
-so here only the settings. Just specify the interface to use:
-
address@hidden
-[transport-wlan]
-# Name of the interface in monitor mode (typically monX)
-INTERFACE = mon0
-# Real hardware, no testing
-TESTMODE = 0
-TESTING_IGNORE_KEYS = ACCEPT_FROM;
address@hidden example
address@hidden itemize
-
address@hidden Configuring the wlan transport plugin
address@hidden 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
-GNUnet where no internet access is possible, for example during
-catastrophes or when censorship cuts you off from the internet.
-
-
address@hidden
-* Requirements for the WLAN plugin::
-* Configuration::
-* Before starting GNUnet::
-* Limitations and known bugs::
address@hidden menu
-
-
address@hidden Requirements for the WLAN plugin
address@hidden Requirements for the WLAN plugin
-
address@hidden @bullet
-
address@hidden wlan network card with monitor support and packet injection
-(see @uref{http://www.aircrack-ng.org/, aircrack-ng.org})
-
address@hidden Linux kernel with mac80211 stack, introduced in 2.6.22, tested
with
-2.6.35 and 2.6.38
-
address@hidden Wlantools to create the a monitor interface, tested with
airmon-ng
-of the aircrack-ng package
address@hidden itemize
-
address@hidden Configuration
address@hidden Configuration
-
-There are the following options for the wlan plugin (they should be like
-this in your default config file, you only need to adjust them if the
-values are incorrect for your system)
-
address@hidden
-# section for the wlan transport plugin
-[transport-wlan]
-# interface to use, more information in the
-# "Before starting GNUnet" section of the handbook.
-INTERFACE = mon0
-# testmode for developers:
-# 0 use wlan interface,
-#1 or 2 use loopback driver for tests 1 = server, 2 = client
-TESTMODE = 0
address@hidden example
-
address@hidden Before starting GNUnet
address@hidden 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:
-
address@hidden
-sudo airmon-ng start wlan0
address@hidden example
-
address@hidden
-Here is an example what the result should look like:
-
address@hidden
-Interface Chipset Driver
-wlan0 Intel 4965 a/b/g/n iwl4965 - [phy0]
-(monitor mode enabled on mon0)
address@hidden example
-
address@hidden
-The monitor interface is mon0 is the one that you have to put into the
-configuration file.
-
address@hidden Limitations and known bugs
address@hidden Limitations and known bugs
-
-Wlan speed is at the maximum of 1 Mbit/s because support for choosing the
-wlan speed with packet injection was removed in newer kernels.
-Please pester the kernel developers about fixing this.
-
-The interface channel depends on the wlan network that the card is
-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:
-
address@hidden
-iwconfig wlan0 channel 1
address@hidden example
-
address@hidden Configuring HTTP(S) reverse proxy functionality using Apache or
nginx
address@hidden Configuring HTTP(S) reverse proxy functionality using Apache or
nginx
-
-The HTTP plugin supports data transfer using reverse proxies. A reverse
-proxy forwards the HTTP request he receives with a certain URL to another
-webserver, here a GNUnet peer.
-
-So if you have a running Apache or nginx webserver you can configure it to
-be a GNUnet reverse proxy. Especially if you have a well-known webiste
-this improves censorship resistance since it looks as normal surfing
-behaviour.
-
-To do so, you have to do two things:
-
address@hidden @bullet
address@hidden Configure your webserver to forward the GNUnet HTTP traffic
address@hidden Configure your GNUnet peer to announce the respective address
address@hidden itemize
-
-As an example we want to use GNUnet peer running:
-
address@hidden @bullet
-
address@hidden HTTP server plugin on @code{gnunet.foo.org:1080}
-
address@hidden HTTPS server plugin on @code{gnunet.foo.org:4433}
-
address@hidden A apache or nginx webserver on
address@hidden://www.foo.org/, http://www.foo.org:80/}
-
address@hidden A apache or nginx webserver on https://www.foo.org:443/
address@hidden itemize
-
-And we want the webserver to accept GNUnet traffic under
address@hidden://www.foo.org/bar/}. The required steps are described here:
-
address@hidden
-* 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::
address@hidden menu
-
address@hidden Reverse Proxy - Configure your Apache2 HTTP webserver
address@hidden Reverse Proxy - Configure your Apache2 HTTP webserver
-
-First of all you need mod_proxy installed.
-
-Edit your webserver configuration. Edit
address@hidden/etc/apache2/apache2.conf} or the site-specific configuration
file.
-
-In the respective @code{server config},@code{virtual host} or
address@hidden section add the following lines:
-
address@hidden
-ProxyTimeout 300
-ProxyRequests Off
-<Location /bar/ >
-ProxyPass http://gnunet.foo.org:1080/
-ProxyPassReverse http://gnunet.foo.org:1080/
-</Location>
address@hidden example
-
address@hidden Reverse Proxy - Configure your Apache2 HTTPS webserver
address@hidden 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 uncomplicated to use example
-is the example configuration file for Apache2/HTTPD provided in
address@hidden/sites-available/default-ssl}.
-
-In the respective HTTPS @code{server config},@code{virtual host} or
address@hidden section add the following lines:
-
address@hidden
-SSLProxyEngine On
-ProxyTimeout 300
-ProxyRequests Off
-<Location /bar/ >
-ProxyPass https://gnunet.foo.org:4433/
-ProxyPassReverse https://gnunet.foo.org:4433/
-</Location>
address@hidden example
-
address@hidden
-More information about the apache mod_proxy configuration can be found
-in the Apache
address@hidden@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}}
-
address@hidden Reverse Proxy - Configure your nginx HTTPS webserver
address@hidden Reverse Proxy - Configure your nginx HTTPS webserver
-
-Since nginx does not support chunked encoding, you first of all have to
-install the @code{chunkin}
address@hidden@uref{http://wiki.nginx.org/HttpChunkinModule,
http://wiki.nginx.org/HttpChunkinModule}}
-
-To enable chunkin add:
-
address@hidden
-chunkin on;
-error_page 411 = @@my_411_error;
-location @@my_411_error @{
-chunkin_resume;
address@hidden
address@hidden example
-
address@hidden
-Edit your webserver configuration. Edit @file{/etc/nginx/nginx.conf} or
-the site-specific configuration file.
-
-In the @code{server} section add:
-
address@hidden
-location /bar/ @{
-proxy_pass http://gnunet.foo.org:1080/;
-proxy_buffering off;
-proxy_connect_timeout 5; # more than http_server
-proxy_read_timeout 350; # 60 default, 300s is GNUnet's idle timeout
-proxy_http_version 1.1; # 1.0 default
-proxy_next_upstream error timeout invalid_header http_500 http_503 http_502
http_504;
address@hidden
address@hidden example
-
address@hidden Reverse Proxy - Configure your nginx HTTP webserver
address@hidden Reverse Proxy - Configure your nginx HTTP webserver
-
-Edit your webserver configuration. Edit @file{/etc/nginx/nginx.conf} or
-the site-specific configuration file.
-
-In the @code{server} section add:
-
address@hidden
-ssl_session_timeout 6m;
-location /bar/
address@hidden
-proxy_pass https://gnunet.foo.org:4433/;
-proxy_buffering off;
-proxy_connect_timeout 5; # more than http_server
-proxy_read_timeout 350; # 60 default, 300s is GNUnet's idle timeout
-proxy_http_version 1.1; # 1.0 default
-proxy_next_upstream error timeout invalid_header http_500 http_503 http_502
http_504;
address@hidden
address@hidden example
-
address@hidden Reverse Proxy - Configure your GNUnet peer
address@hidden Reverse Proxy - Configure your GNUnet peer
-
-To have your GNUnet peer announce the address, you have to specify the
address@hidden option in the @code{[transport-http_server]}
-section:
-
address@hidden
-[transport-http_server]
-EXTERNAL_HOSTNAME = http://www.foo.org/bar/
address@hidden example
-
address@hidden
-and/or @code{[transport-https_server]} section:
-
address@hidden
-[transport-https_server]
-EXTERNAL_HOSTNAME = https://www.foo.org/bar/
address@hidden example
-
address@hidden
-Now restart your webserver and your peer...
-
address@hidden Blacklisting peers
address@hidden Blacklisting peers
-
-Transport service supports to deny connecting to a specific peer of to a
-specific peer with a specific transport plugin using te blacklisting
-component of transport service. With@ blacklisting it is possible to deny
-connections to specific peers of@ to use a specific plugin to a specific
-peer. Peers can be blacklisted using@ the configuration or a blacklist
-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
-the plugin@ if required.
-
-Examples:
-
-To blacklist connections to P565... on peer AG2P... using tcp add:
-
address@hidden FIXME: This is too long and produces errors in the pdf.
address@hidden
-[transport-blacklist
AG2PHES1BARB9IJCPAMJTFPVJ5V3A72S3F2A8SBUB8DAQ2V0O3V8G6G2JU56FHGFOHMQVKBSQFV98TCGTC3RJ1NINP82G0RC00N1520]
-P565723JO1C2HSN6J29TAQ22MN6CI8HTMUU55T0FUQG4CMDGGEQ8UCNBKUMB94GC8R9G4FB2SF9LDOBAJ6AMINBP4JHHDD6L7VD801G
= tcp
address@hidden example
-
-To blacklist connections to P565... on peer AG2P... using all plugins add:
-
address@hidden
-[transport-blacklist-AG2PHES1BARB9IJCPAMJTFPVJ5V3A72S3F2A8SBUB8DAQ2V0O3V8G6G2JU56FHGFOHMQVKBSQFV98TCGTC3RJ1NINP82G0RC00N1520]
-P565723JO1C2HSN6J29TAQ22MN6CI8HTMUU55T0FUQG4CMDGGEQ8UCNBKUMB94GC8R9G4FB2SF9LDOBAJ6AMINBP4JHHDD6L7VD801G
=
address@hidden example
-
-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.
-
-On blacklist check for (peer, plugin)
address@hidden @bullet
address@hidden Do we have a local blacklist entry for this peer and this
plugin?@
address@hidden YES: disallow connection@
address@hidden Do we have a local blacklist entry for this peer and all
plugins?@
address@hidden YES: disallow connection@
address@hidden Does one of the clients disallow?@
address@hidden YES: disallow connection
address@hidden itemize
-
address@hidden Configuration of the HTTP and HTTPS transport plugins
address@hidden Configuration of the HTTP and HTTPS transport plugins
-
-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.
-
-Both the HTTP and HTTPS clients support the following proxy types at
-the moment:
-
address@hidden @bullet
address@hidden HTTP 1.1 proxy
address@hidden SOCKS 4/4a/5/5 with hostname
address@hidden itemize
-
-In addition authentication at the proxy with username and password can be
-configured.
-
-To configure proxy support for the clients in the gnunet-setup tool,
-select the "transport" tab and activate the respective plugin. Now you
-can 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.
-
-To configure these options directly in the configuration, you can
-configure the following settings in the @code{[transport-http_client]}
-and @code{[transport-https_client]} section of the configuration:
-
address@hidden
-# Type of proxy server,
-# Valid values: HTTP, SOCKS4, SOCKS5, SOCKS4A, SOCKS5_HOSTNAME
-# Default: HTTP
-# PROXY_TYPE = HTTP
-
-# Hostname or IP of proxy server
-# PROXY =
-# User name for proxy server
-# PROXY_USERNAME =
-# User password for proxy server
-# PROXY_PASSWORD =
address@hidden example
-
address@hidden Configuring the GNU Name System
address@hidden Configuring the GNU Name System
-
address@hidden
-* Configuring system-wide DNS interception::
-* Configuring the GNS nsswitch plugin::
-* Configuring GNS on W32::
-* GNS Proxy Setup::
-* Setup of the GNS CA::
-* Testing the GNS setup::
address@hidden menu
-
-
address@hidden Configuring system-wide DNS interception
address@hidden Configuring system-wide DNS interception
-
-Before you install GNUnet, make sure you have a user and group 'gnunet'
-as well as an empty group 'gnunetdns'.
-
-When using GNUnet with system-wide DNS interception, it is absolutely
-necessary for all GNUnet service processes to be started by
address@hidden as user and group 'gnunet'. You also need to be
-sure to run @code{make install} as root (or use the @code{sudo} option to
-configure) to grant GNUnet sufficient privileges.
-
-With this setup, all that is required for enabling system-wide DNS
-interception is for some GNUnet component (VPN or GNS) to request it.
-The @code{gnunet-service-dns} will then start helper programs that will
-make the necessary changes to your firewall (@code{iptables}) rules.
-
-Note that this will NOT work if your system sends out DNS traffic to a
-link-local IPv6 address, as in this case GNUnet can intercept the traffic,
-but not inject the responses from the link-local IPv6 address. Hence you
-cannot use system-wide DNS interception in conjunction with link-local
-IPv6-based DNS servers. If such a DNS server is used, it will bypass
-GNUnet's DNS traffic interception.
-
-Using the GNU Name System (GNS) requires two different configuration
-steps.
-First of all, GNS needs to be integrated with the operating system. Most
-of this section is about the operating system level integration.
-
-The remainder of this chapter will detail the various methods for
-configuring the use of GNS with your operating system.
-
-At this point in time you have different options depending on your OS:
-
address@hidden @asis
-
address@hidden Use the gnunet-gns-proxy This approach works for all operating
-systems and is likely the easiest. However, it enables GNS only for
-browsers, not for other applications that might be using DNS, such as SSH.
-Still, using the proxy is required for using HTTP with GNS and is thus
-recommended for all users. To do this, you simply have to run the
address@hidden script as the user who will run the
-browser (this will create a GNS certificate authority (CA) on your system
-and import its key into your browser), then start @code{gnunet-gns-proxy}
-and inform your browser to use the Socks5 proxy which
address@hidden makes available by default on port 7777.
address@hidden Use a nsswitch plugin (recommended on GNU systems)
-This approach has the advantage of offering fully personalized resolution
-even on multi-user systems. A potential disadvantage is that some
-applications might be able to bypass GNS.
address@hidden Use a W32 resolver plugin (recommended on W32)
-This is currently the only option on W32 systems.
address@hidden Use system-wide DNS packet interception
-This approach is recommended for the GNUnet VPN. It can be used to handle
-GNS at the same time; however, if you only use this method, you will only
-get one root zone per machine (not so great for multi-user systems).
address@hidden table
-
-You can combine system-wide DNS packet interception with the nsswitch
-plugin.
-The setup of the system-wide DNS interception is described here. All of
-the other GNS-specific configuration steps are described in the following
-sections.
-
address@hidden Configuring the GNS nsswitch plugin
address@hidden Configuring the GNS nsswitch plugin
-
-The Name Service Switch (NSS) is a facility in Unix-like operating systems
address@hidden 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 superuser (system administrator) usually configures the
-operating system's name services using the file
address@hidden/etc/nsswitch.conf}.
-
-GNS provides a NSS plugin to integrate GNS name resolution with the
-operating system's name resolution process.
-To use the GNS NSS plugin you have to either
-
address@hidden @bullet
address@hidden install GNUnet as root or
address@hidden compile GNUnet with the @code{--with-sudo=yes} switch.
address@hidden itemize
-
-Name resolution is controlled by the @emph{hosts} section in the NSS
-configuration. By default this section first performs a lookup in the
address@hidden/etc/hosts} file and then in DNS.
-The nsswitch file should contain a line similar to:
-
address@hidden
-hosts: files dns [NOTFOUND=return] mdns4_minimal mdns4
address@hidden example
-
address@hidden
-Here the GNS NSS plugin can be added to perform a GNS lookup before
-performing a DNS lookup.
-The GNS NSS plugin has to be added to the "hosts" section in
address@hidden/etc/nsswitch.conf} file before DNS related plugins:
-
address@hidden
-...
-hosts: files gns [NOTFOUND=return] dns mdns4_minimal mdns4
-...
address@hidden example
-
address@hidden
-The @code{NOTFOUND=return} will ensure that if a @code{.gnu} name is not
-found in GNS it will not be queried in DNS.
-
address@hidden Configuring GNS on W32
address@hidden Configuring GNS on W32
-
-This document is a guide to configuring GNU Name System on W32-compatible
-platforms.
-
-After GNUnet is installed, run the w32nsp-install tool:
-
address@hidden
-w32nsp-install.exe libw32nsp-0.dll
address@hidden example
-
address@hidden
-('0' is the library version of W32 NSP; it might increase in the future,
-change the invocation accordingly).
-
-This will install GNS namespace provider into the system and allow other
-applications to resolve names that end in '@strong{gnu}'
-and '@strong{zkey}'. Note that namespace provider requires
-gnunet-gns-helper-service-w32 to be running, as well as gns service
-itself (and its usual dependencies).
-
-Namespace provider is hardcoded to connect to @strong{127.0.0.1:5353},
-and this is where gnunet-gns-helper-service-w32 should be listening to
-(and is configured to listen to by default).
-
-To uninstall the provider, run:
-
address@hidden
-w32nsp-uninstall.exe
address@hidden example
-
address@hidden
-(uses provider GUID to uninstall it, does not need a dll name).
-
-Note that while MSDN claims that other applications will only be able to
-use the new namespace provider after re-starting, in reality they might
-stat to use it without that. Conversely, they might stop using the
-provider after it's been uninstalled, even if they were not re-started.
-W32 will not permit namespace provider library to be deleted or
-overwritten while the provider is installed, and while there is at least
-one process still using it (even after it was uninstalled).
-
address@hidden GNS Proxy Setup
address@hidden GNS Proxy Setup
-
-When using the GNU Name System (GNS) to browse the WWW, there are several
-issues that can be solved by adding the GNS Proxy to your setup:
-
address@hidden @bullet
-
address@hidden If the target website does not support GNS, it might assume that
it
-is operating under some name in the legacy DNS system (such as
-example.com). It may then attempt to set cookies for that domain, and the
-web server might expect a @code{Host: example.com} header in the request
-from your browser.
-However, your browser might be using @code{example.gnu} for the
address@hidden header and might only accept (and send) cookies for
address@hidden The GNS Proxy will perform the necessary translations
-of the hostnames for cookies and HTTP headers (using the LEHO record for
-the target domain as the desired substitute).
-
address@hidden If using HTTPS, the target site might include an SSL certificate
-which is either only valid for the LEHO domain or might match a TLSA
-record in GNS. However, your browser would expect a valid certificate for
address@hidden, not for some legacy domain name. The proxy will
-validate the certificate (either against LEHO or TLSA) and then
-on-the-fly produce a valid certificate for the exchange, signed by your
-own CA. Assuming you installed the CA of your proxy in your browser's
-certificate authority list, your browser will then trust the
-HTTPS/SSL/TLS connection, as the hostname mismatch is hidden by the proxy.
-
address@hidden Finally, the proxy will in the future indicate to the server
that it
-speaks GNS, which will enable server operators to deliver GNS-enabled web
-sites to your browser (and continue to deliver legacy links to legacy
-browsers)
address@hidden itemize
-
address@hidden Setup of the GNS CA
address@hidden Setup of the GNS CA
-
-First you need to create a CA certificate that the proxy can use.
-To do so use the provided script gnunet-gns-proxy-ca:
-
address@hidden
-$ gnunet-gns-proxy-setup-ca
address@hidden example
-
address@hidden
-This will create a personal certification authority for you and add this
-authority to the firefox and chrome database. The proxy will use the this
-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 @b{not} work with libcurl compiled
-against OpenSSL.
-
-You can check the configuration your libcurl was build with by
-running:
-
address@hidden
-curl --version
address@hidden example
-
-the output will look like this (without the linebreaks):
-
address@hidden
-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
address@hidden example
-
address@hidden Testing the GNS setup
address@hidden Testing the GNS setup
-
-Now for testing purposes we can create some records in our zone to test
-the SSL functionality of the proxy:
-
address@hidden
-$ 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
address@hidden example
-
address@hidden
-At this point we can start the proxy. Simply execute
-
address@hidden
-$ gnunet-gns-proxy
address@hidden example
-
address@hidden
-Configure your browser to use this SOCKSv5 proxy on port 7777 and visit
-this link.
-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
address@hidden to @code{true}.
-
-When you visit @code{https://homepage.test/}, you should get to the
address@hidden://gnunet.org/} frontpage and the browser (with the correctly
-configured proxy) should give you a valid SSL certificate for
address@hidden and no warnings. It should look like this:
-
address@hidden FIXME: Image does not exist, create it or save it from Drupal?
address@hidden @image{images/gnunethpgns.png,5in,, picture of homepage.gnu in
Webbrowser}
-
-
address@hidden Configuring the GNUnet VPN
address@hidden Configuring the GNUnet VPN
-
address@hidden
-* IPv4 address for interface::
-* IPv6 address for interface::
-* Configuring the GNUnet VPN DNS::
-* Configuring the GNUnet VPN Exit Service::
-* IP Address of external DNS resolver::
-* IPv4 address for Exit interface::
-* IPv6 address for Exit interface::
address@hidden menu
-
-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. @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.
-
-The other options as shown on the gnunet-setup tool are:
-
address@hidden IPv4 address for interface
address@hidden IPv4 address for interface
-
-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 @code{10.0.0.1/255.255.0.0} already, you might use
address@hidden/255.255.0.0}.
-If you use @code{10.0.0.1/255.0.0.0} already, then you might use
address@hidden/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
-(@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.
-
address@hidden IPv6 address for interface
address@hidden 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 @code{fe80:}).
-A subnet Unique Local Unicast (@code{fd00::/8} prefix) that you are
-currently not using would be a good choice.
-
address@hidden Configuring the GNUnet VPN DNS
address@hidden Configuring the GNUnet VPN DNS
-
-To resolve names for remote nodes, activate the DNS exit option.
-
address@hidden Configuring the GNUnet VPN Exit Service
address@hidden Configuring the GNUnet VPN Exit Service
-
-If you want to allow other users to share your Internet connection (yes,
-this may be dangerous, just as running a Tor exit node) or want to
-provide access to services on your host (this should be less dangerous,
-as long as those services are secure), you have to enable the GNUnet exit
-daemon.
-
-You then get to specify which exit functions you want to provide. By
-enabling the exit daemon, you will always automatically provide exit
-functions for manually configured local services (this component of the
-system is under
-development and not documented further at this time). As for those
-services you explicitly specify the target IP address and port, there is
-no significant security risk in doing so.
-
-Furthermore, you can serve as a DNS, IPv4 or IPv6 exit to the Internet.
-Being a DNS exit is usually pretty harmless. However, enabling IPv4 or
-IPv6-exit without further precautions may enable adversaries to access
-your local network, send spam, attack other systems from your Internet
-connection and to other mischief that will appear to come from your
-machine. This may or may not get you into legal trouble.
-If you want to allow IPv4 or IPv6-exit functionality, you should strongly
-consider adding additional firewall rules manually to protect your local
-network and to restrict outgoing TCP traffic (i.e. by not allowing access
-to port 25). While we plan to improve exit-filtering in the future,
-you're currently on your own here.
-Essentially, be prepared for any kind of IP-traffic to exit the respective
-TUN interface (and GNUnet will enable IP-forwarding and NAT for the
-interface automatically).
-
-Additional configuration options of the exit as shown by the gnunet-setup
-tool are:
-
address@hidden IP Address of external DNS resolver
address@hidden IP Address of external DNS resolver
-
-If DNS traffic is to exit your machine, it will be send to this DNS
-resolver. You can specify an IPv4 or IPv6 address.
-
address@hidden IPv4 address for Exit interface
address@hidden IPv4 address for Exit interface
-
-This is the IPv4 address the Interface will get. Make the mask of the
-address big enough (255.255.0.0 or, even better, 255.0.0.0) to allow more
-mappings of IP addresses into this range. As for the VPN interface, any
-unused, private IPv4 address range will do.
-
address@hidden IPv6 address for Exit interface
address@hidden IPv6 address for Exit interface
-
-The public IPv6 address the interface will get. If your kernel is not a
-very recent kernel and you are willing to manually enable IPv6-NAT, the
-IPv6 address you specify here must be a globally routed IPv6 address of
-your host.
-
-Suppose your host has the address @code{2001:4ca0::1234/64}, then
-using @code{2001:4ca0::1:0/112} would be fine (keep the first 64 bits,
-then change at least one bit in the range before the bitmask, in the
-example above we changed bit 111 from 0 to 1).
-
-You may also have to configure your router to route traffic for the entire
-subnet (@code{2001:4ca0::1:0/112} for example) through your computer (this
-should be automatic with IPv6, but obviously anything can be
-disabled).
-
address@hidden Bandwidth Configuration
address@hidden Bandwidth Configuration
-
-You can specify how many bandwidth GNUnet is allowed to use to receive
-and send data. This is important for users with limited bandwidth or
-traffic volume.
-
address@hidden Configuring NAT
address@hidden Configuring NAT
-
-Most hosts today do not have a normal global IP address but instead are
-behind a router performing Network Address Translation (NAT) which assigns
-each host in the local network a private IP address.
-As a result, these machines cannot trivially receive inbound connections
-from the Internet. GNUnet supports NAT traversal to enable these machines
-to receive incoming connections from other peers despite their
-limitations.
-
-In an ideal world, you can press the "Attempt automatic configuration"
-button in gnunet-setup to automatically configure your peer correctly.
-Alternatively, your distribution might have already triggered this
-automatic configuration during the installation process.
-However, automatic configuration can fail to determine the optimal
-settings, resulting in your peer either not receiving as many connections
-as possible, or in the worst case it not connecting to the network at all.
-
-To manually configure the peer, you need to know a few things about your
-network setup. First, determine if you are behind a NAT in the first
-place.
-This is always the case if your IP address starts with "10.*" or
-"192.168.*". Next, if you have control over your NAT router, you may
-choose to manually configure it to allow GNUnet traffic to your host.
-If you have configured your NAT to forward traffic on ports 2086 (and
-possibly 1080) to your host, you can check the "NAT ports have been opened
-manually" option, which corresponds to the "PUNCHED_NAT" option in the
-configuration file. If you did not punch your NAT box, it may still be
-configured to support UPnP, which allows GNUnet to automatically
-configure it. In that case, you need to install the "upnpc" command,
-enable UPnP (or PMP) on your NAT box and set the "Enable NAT traversal
-via UPnP or PMP" option (corresponding to "ENABLE_UPNP" in the
-configuration file).
-
-Some NAT boxes can be traversed using the autonomous NAT traversal method.
-This requires certain GNUnet components to be installed with "SUID"
-prividledges on your system (so if you're installing on a system you do
-not have administrative rights to, this will not work).
-If you installed as 'root', you can enable autonomous NAT traversal by
-checking the "Enable NAT traversal using ICMP method".
-The ICMP method requires a way to determine your NAT's external (global)
-IP address. This can be done using either UPnP, DynDNS, or by manual
-configuration. If you have a DynDNS name or know your external IP address,
-you should enter that name under "External (public) IPv4 address" (which
-corresponds to the "EXTERNAL_ADDRESS" option in the configuration file).
-If you leave the option empty, GNUnet will try to determine your external
-IP address automatically (which may fail, in which case autonomous
-NAT traversal will then not work).
-
-Finally, if you yourself are not behind NAT but want to be able to
-connect to NATed peers using autonomous NAT traversal, you need to check
-the "Enable connecting to NATed peers using ICMP method" box.
-
-
address@hidden Peer configuration for distributions
address@hidden Peer configuration for distributions
-
-The "GNUNET_DATA_HOME" in "[path]" in @file{/etc/gnunet.conf} should be
-manually set to "/var/lib/gnunet/data/" as the default
-"~/.local/share/gnunet/" is probably not that appropriate in this case.
-Similarly, distributions may consider pointing "GNUNET_RUNTIME_DIR" to
-"/var/run/gnunet/" and "GNUNET_HOME" to "/var/lib/gnunet/". Also, should a
-distribution decide to override system defaults, all of these changes
-should be done in a custom @file{/etc/gnunet.conf} and not in the files
-in the @file{config.d/} directory.
-
-Given the proposed access permissions, the "gnunet-setup" tool must be
-run as use "gnunet" (and with option "-c /etc/gnunet.conf" so that it
-modifies the system configuration). As always, gnunet-setup should be run
-after the GNUnet peer was stopped using "gnunet-arm -e". Distributions
-might want to include a wrapper for gnunet-setup that allows the
-desktop-user to "sudo" (i.e. using gtksudo) to the "gnunet" user account
-and then runs "gnunet-arm -e", "gnunet-setup" and "gnunet-arm -s" in
-sequence.
-
address@hidden How to start and stop a GNUnet peer
address@hidden How to start and stop a GNUnet peer
-
-This section describes how to start a GNUnet peer. It assumes that you
-have already compiled and installed GNUnet and its' dependencies.
-Before you start a GNUnet peer, you may want to create a configuration
-file using gnunet-setup (but you do not have to).
-Sane defaults should exist in your
address@hidden/share/gnunet/config.d/} directory, so in practice
-you could simply start without any configuration. If you want to
-configure your peer later, you need to stop it before invoking the
address@hidden tool to customize further and to test your
-configuration (@code{gnunet-setup} has build-in test functions).
-
-The most important option you might have to still set by hand is in
-[PATHS]. Here, you use the option "GNUNET_HOME" to specify the path where
-GNUnet should store its data.
-It defaults to @code{$HOME/}, which again should work for most users.
-Make sure that the directory specified as GNUNET_HOME is writable to
-the user that you will use to run GNUnet (note that you can run frontends
-using other users, GNUNET_HOME must only be accessible to the user used to
-run the background processes).
-
-You will also need to make one central decision: should all of GNUnet be
-run under your normal UID, or do you want distinguish between system-wide
-(user-independent) GNUnet services and personal GNUnet services. The
-multi-user setup is slightly more complicated, but also more secure and
-generally recommended.
-
address@hidden
-* The Single-User Setup::
-* The Multi-User Setup::
-* Killing GNUnet services::
-* Access Control for GNUnet::
address@hidden menu
-
address@hidden The Single-User Setup
address@hidden The Single-User Setup
-
-For the single-user setup, you do not need to do anything special and can
-just start the GNUnet background processes using @code{gnunet-arm}.
-By default, GNUnet looks in @file{~/.config/gnunet.conf} for a
-configuration (or @code{$XDG_CONFIG_HOME/gnunet.conf} if@
address@hidden is defined). If your configuration lives
-elsewhere, you need to pass the @code{-c FILENAME} option to all GNUnet
-commands.
-
-Assuming the configuration file is called @file{~/.config/gnunet.conf},
-you start your peer using the @code{gnunet-arm} command (say as user
address@hidden) using:
-
address@hidden
-gnunet-arm -c ~/.config/gnunet.conf -s
address@hidden example
-
address@hidden
-The "-s" option here is for "start". The command should return almost
-instantly. If you want to stop GNUnet, you can use:
-
address@hidden
-gnunet-arm -c ~/.config/gnunet.conf -e
address@hidden example
-
address@hidden
-The "-e" option here is for "end".
-
-Note that this will only start the basic peer, no actual applications
-will be available.
-If you want to start the file-sharing service, use (after starting
-GNUnet):
-
address@hidden
-gnunet-arm -c ~/.config/gnunet.conf -i fs
address@hidden example
-
address@hidden
-The "-i fs" option here is for "initialize" the "fs" (file-sharing)
-application. You can also selectively kill only file-sharing support using
-
address@hidden
-gnunet-arm -c ~/.config/gnunet.conf -k fs
address@hidden example
-
address@hidden
-Assuming that you want certain services (like file-sharing) to be always
-automatically started whenever you start GNUnet, you can activate them by
-setting "FORCESTART=YES" in the respective section of the configuration
-file (for example, "[fs]"). Then GNUnet with file-sharing support would
-be started whenever you@ enter:
-
address@hidden
-gnunet-arm -c ~/.config/gnunet.conf -s
address@hidden example
-
address@hidden
-Alternatively, you can combine the two options:
-
address@hidden
-gnunet-arm -c ~/.config/gnunet.conf -s -i fs
address@hidden example
-
address@hidden
-Using @code{gnunet-arm} is also the preferred method for initializing
-GNUnet from @code{init}.
-
-Finally, you should edit your @code{crontab} (using the @code{crontab}
-command) and insert a line@
-
address@hidden
-@@reboot gnunet-arm -c ~/.config/gnunet.conf -s
address@hidden example
-
-to automatically start your peer whenever your system boots.
-
address@hidden The Multi-User Setup
address@hidden The Multi-User Setup
-
-This requires you to create a user @code{gnunet} and an additional group
address@hidden, prior to running @code{make install} during
-installation.
-Then, you create a configuration file @file{/etc/gnunet.conf} which should
-contain the lines:@
-
address@hidden
-[arm]
-SYSTEM_ONLY = YES
-USER_ONLY = NO
address@hidden example
-
address@hidden
-Then, perform the same steps to run GNUnet as in the per-user
-configuration, except as user @code{gnunet} (including the
address@hidden installation).
-You may also want to run @code{gnunet-setup} to configure your peer
-(databases, etc.).
-Make sure to pass @code{-c /etc/gnunet.conf} to all commands. If you
-run @code{gnunet-setup} as user @code{gnunet}, you might need to change
-permissions on @file{/etc/gnunet.conf} so that the @code{gnunet} user can
-write to the file (during setup).
-
-Afterwards, you need to perform another setup step for each normal user
-account from which you want to access GNUnet. First, grant the normal user
-(@code{$USER}) permission to the group gnunet:
-
address@hidden
-# adduser $USER gnunet
address@hidden example
-
address@hidden
-Then, create a configuration file in @file{~/.config/gnunet.conf} for the
-$USER with the lines:
-
address@hidden
-[arm]
-SYSTEM_ONLY = NO
-USER_ONLY = YES
address@hidden example
-
address@hidden
-This will ensure that @code{gnunet-arm} when started by the normal user
-will only run services that are per-user, and otherwise rely on the
-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
address@hidden/etc/gnunet.conf} and ignore options set by individual users.
-
-Again, each user should then start the peer using
address@hidden -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)
address@hidden processes running in your system.
-
address@hidden Killing GNUnet services
address@hidden Killing GNUnet services
-
-It is not necessary to stop GNUnet services explicitly when shutting
-down your computer.
-
-It should be noted that manually killing "most" of the
address@hidden processes is generally not a successful method for
-stopping a peer (since @code{gnunet-service-arm} will instantly restart
-them). The best way to explicitly stop a peer is using
address@hidden -e}; note that the per-user services may need to be
-terminated before the system-wide services will terminate normally.
-
address@hidden Access Control for GNUnet
address@hidden Access Control for GNUnet
-
-This chapter documents how we plan to make access control work within the
-GNUnet system for a typical peer. It should be read as a best-practice
-installation guide for advanced users and builders of binary
-distributions. The recommendations in this guide apply to POSIX-systems
-with full support for UNIX domain sockets only.
-
-Note that this is an advanced topic. The discussion presumes a very good
-understanding of users, groups and file permissions. Normal users on
-hosts with just a single user can just install GNUnet under their own
-account (and possibly allow the installer to use SUDO to grant additional
-permissions for special GNUnet tools that need additional rights).
-The discussion below largely applies to installations where multiple users
-share a system and to installations where the best possible security is
-paramount.
-
-A typical GNUnet system consists of components that fall into four
-categories:
-
address@hidden @asis
-
address@hidden User interfaces
-User interfaces are not security sensitive and are supposed to be run and
-used by normal system users.
-The GTK GUIs and most command-line programs fall into this category.
-Some command-line tools (like gnunet-transport) should be excluded as they
-offer low-level access that normal users should not need.
address@hidden System services and support tools
-System services should always run and offer services that can then be
-accessed by the normal users.
-System services do not require special permissions, but as they are not
-specific to a particular user, they probably should not run as a
-particular user. Also, there should typically only be one GNUnet peer per
-host. System services include the gnunet-service and gnunet-daemon
-programs; support tools include command-line programs such as gnunet-arm.
address@hidden Priviledged helpers
-Some GNUnet components require root rights to open raw sockets or perform
-other special operations. These gnunet-helper binaries are typically
-installed SUID and run from services or daemons.
address@hidden Critical services
-Some GNUnet services (such as the DNS service) can manipulate the service
-in deep and possibly highly security sensitive ways. For example, the DNS
-service can be used to intercept and alter any DNS query originating from
-the local machine. Access to the APIs of these critical services and their
-priviledged helpers must be tightly controlled.
address@hidden table
-
address@hidden FIXME: The titles of these chapters are too long in the index.
-
address@hidden
-* Recommendation - Disable access to services via TCP::
-* Recommendation - Run most services as system user "gnunet"::
-* Recommendation - Control access to services using group "gnunet"::
-* Recommendation - Limit access to certain SUID binaries by group "gnunet"::
-* Recommendation - Limit access to critical gnunet-helper-dns to group
"gnunetdns"::
-* Differences between "make install" and these recommendations::
address@hidden menu
-
address@hidden Recommendation - Disable access to services via TCP
address@hidden Recommendation - Disable access to services via TCP
-
-GNUnet services allow two types of access: via TCP socket or via UNIX
-domain socket.
-If the service is available via TCP, access control can only be
-implemented by restricting connections to a particular range of IP
-addresses.
-This is acceptable for non-critical services that are supposed to be
-available to all users on the local system or local network.
-However, as TCP is generally less efficient and it is rarely the case
-that a single GNUnet peer is supposed to serve an entire local network,
-the default configuration should disable TCP access to all GNUnet
-services on systems with support for UNIX domain sockets.
-As of GNUnet 0.9.2, configuration files with TCP access disabled should be
-generated by default. Users can re-enable TCP access to particular
-services simply by specifying a non-zero port number in the section of
-the respective service.
-
-
address@hidden Recommendation - Run most services as system user "gnunet"
address@hidden Recommendation - Run most services as system user "gnunet"
-
-GNUnet's main services should be run as a separate user "gnunet" in a
-special group "gnunet".
-The user "gnunet" should start the peer using "gnunet-arm -s" during
-system startup. The home directory for this user should be
address@hidden/var/lib/gnunet} and the configuration file should be
address@hidden/etc/gnunet.conf}.
-Only the @code{gnunet} user should have the right to access
address@hidden/var/lib/gnunet} (@emph{mode: 700}).
-
address@hidden Recommendation - Control access to services using group "gnunet"
address@hidden Recommendation - Control access to services using group "gnunet"
-
-Users that should be allowed to use the GNUnet peer should be added to the
-group "gnunet". Using GNUnet's access control mechanism for UNIX domain
-sockets, those services that are considered useful to ordinary users
-should be made available by setting "UNIX_MATCH_GID=YES" for those
-services.
-Again, as shipped, GNUnet provides reasonable defaults.
-Permissions to access the transport and core subsystems might additionally
-be granted without necessarily causing security concerns.
-Some services, such as DNS, must NOT be made accessible to the "gnunet"
-group (and should thus only be accessible to the "gnunet" user and
-services running with this UID).
-
address@hidden Recommendation - Limit access to certain SUID binaries by group
"gnunet"
address@hidden Recommendation - Limit access to certain SUID binaries by group
"gnunet"
-
-Most of GNUnet's SUID binaries should be safe even if executed by normal
-users. However, it is possible to reduce the risk a little bit more by
-making these binaries owned by the group "gnunet" and restricting their
-execution to user of the group "gnunet" as well (4750).
-
address@hidden Recommendation - Limit access to critical gnunet-helper-dns to
group "gnunetdns"
address@hidden Recommendation - Limit access to critical gnunet-helper-dns to
group "gnunetdns"
-
-A special group "gnunetdns" should be created for controlling access to
-the "gnunet-helper-dns".
-The binary should then be owned by root and be in group "gnunetdns" and
-be installed SUID and only be group-executable (2750).
address@hidden that the group "gnunetdns" should have no users in it at all,
-ever.}
-The "gnunet-service-dns" program should be executed by user "gnunet" (via
-gnunet-service-arm) with the binary owned by the user "root" and the group
-"gnunetdns" and be SGID (2700). This way, @strong{only}
-"gnunet-service-dns" can change its group to "gnunetdns" and execute the
-helper, and the helper can then run as root (as per SUID).
-Access to the API offered by "gnunet-service-dns" is in turn restricted
-to the user "gnunet" (not the group!), which means that only
-"benign" services can manipulate DNS queries using "gnunet-service-dns".
-
address@hidden Differences between "make install" and these recommendations
address@hidden Differences between "make install" and these recommendations
-
-The current build system does not set all permissions automatically based
-on the recommendations above. In particular, it does not use the group
-"gnunet" at all (so setting gnunet-helpers other than the
-gnunet-helper-dns to be owned by group "gnunet" must be done manually).
-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
address@hidden configure option.
diff --git a/doc/documentation/chapters/user.texi
b/doc/documentation/chapters/user.texi
index e5ebf5371..422619f84 100644
--- a/doc/documentation/chapters/user.texi
+++ b/doc/documentation/chapters/user.texi
@@ -2,20 +2,21 @@
@chapter Using GNUnet
@c %**end of header
-This tutorial is supposed to give a first introduction for end-users
-trying to do something "real" with GNUnet. Installation and
+This tutorial is supposed to give a first introduction for users
+trying to do something real with GNUnet. Installation and
configuration are specifically outside of the scope of this tutorial.
Instead, we start by briefly checking that the installation works, and
then dive into uncomplicated, concrete practical things that can be done
-with the network.
+with the framework provided by GNUnet.
-This chapter of the GNUnet Reference Documentation documents
-how to use the various peer-to-peer applications of the
+In short, this chapter of the ``GNUnet Reference Documentation'' will
+show you how to use the various peer-to-peer applications of the
GNUnet system.
-As GNUnet evolves, we will add new chapters for the various
+As GNUnet evolves, we will add new sections for the various
applications that are being created.
-Comments and extensions of this documentation are always welcome.
+Comments on the content of this chapter, and extensions of it are
+always welcome.
@menu
@@ -27,16 +28,19 @@ Comments and extensions of this documentation are always
welcome.
* File-sharing::
* The GNU Name System::
* Using the Virtual Public Network::
+* The graphical configuration interface::
+* How to start and stop a GNUnet peer::
@end menu
@node Checking the Installation
@section Checking the Installation
@c %**end of header
-This section describes a quick casual way to check if your GNUnet
+This section describes a quick, casual way to check if your GNUnet
installation works. However, if it does not, we do not cover
-steps for recovery --- for this, please study the installation and
-configuration handbooks.
+steps for recovery --- for this, please study the instructions
+provided in the developer handbook as well as the system-specific
+instruction in the source code address@hidden system specific instructions are
not provided as part of this handbook!}.
@menu
@@ -45,13 +49,16 @@ configuration handbooks.
* Peer Information::
@end menu
address@hidden GNUnet GTK
address@hidden GTK
address@hidden GTK user interface
@node gnunet-gtk
@subsection gnunet-gtk
@c %**end of header
The @command{gnunet-gtk} package contains several graphical
user interfaces for the respective GNUnet applications.
-Those currently are:
+Currently these interfaces cover:
@itemize @bullet
@item Statistics
@@ -66,20 +73,21 @@ Those currently are:
@subsection Statistics
@c %**end of header
-First, you should launch the graphical user interface. You can do
-this from the command-line by typing
+First, you should launch GNUnet address@hidden you should also start gnunet,
via gnunet-arm or the system provided method}.
+You can do this from the command-line by typing
@example
-$ gnunet-statistics-gtk
+gnunet-statistics-gtk
@end example
-If your peer is running correctly, you should see a bunch of
-lines, all of which should be "significantly" above zero (at least if your
-peer has been running for a few seconds). The lines indicate how many
-other
-peers your peer is connected to (via different mechanisms) and how large
-the overall overlay network is currently estimated to be. The X-axis
-represents time (in seconds since the start of @command{gnunet-gtk}).
+If your address@hidden term ``peer'' is a common word used in federated and
distributed networks to describe a participating device which is connected to
the network. Thus, your Personal Computer or whatever it is you are looking at
the Gtk+ interface describes a ``Peer'' or a ``Node''.}
+is running correctly, you should see a bunch of lines,
+all of which should be ``significantly'' above zero (at least if your
+peer has been running for more than a few seconds). The lines indicate
+how many other peers your peer is connected to (via different
+mechanisms) and how large the entire overlay network is currently
+estimated to be. The X-axis represents time (in seconds since the
+start of @command{gnunet-gtk}).
You can click on "Traffic" to see information about the amount of
bandwidth your peer has consumed, and on "Storage" to check the amount
@@ -2006,3 +2014,1925 @@ service offered by that peer, you can create an IP
tunnel to
that peer by specifying the peer's identity, service name and
protocol (--tcp or --udp) and you will again receive an IP address
that will terminate at the respective peer's service.
+
+
+
address@hidden NOTE: Inserted from Installation Handbook in original ``order'':
address@hidden FIXME: Move this to User Handbook.
address@hidden The graphical configuration interface
address@hidden The graphical configuration interface
+
+If you also would like to use @command{gnunet-gtk} and
address@hidden (highly recommended for beginners), do:
+
address@hidden
+* Configuring your peer::
+* Configuring the Friend-to-Friend (F2F) mode::
+* Configuring the hostlist to bootstrap::
+* Configuration of the HOSTLIST proxy settings::
+* Configuring your peer to provide a hostlist ::
+* Configuring the datastore::
+* Configuring the MySQL database::
+* Reasons for using MySQL::
+* Reasons for not using MySQL::
+* Setup Instructions::
+* Testing::
+* Performance Tuning::
+* Setup for running Testcases::
+* Configuring the Postgres database::
+* Reasons to use Postgres::
+* Reasons not to use Postgres::
+* Manual setup instructions::
+* Testing the setup manually::
+* Configuring the datacache::
+* Configuring the file-sharing service::
+* Configuring logging::
+* Configuring the transport service and plugins::
+* Configuring the wlan transport plugin::
+* Configuring HTTP(S) reverse proxy functionality using Apache or nginx::
+* Blacklisting peers::
+* Configuration of the HTTP and HTTPS transport plugins::
+* Configuring the GNU Name System::
+* Configuring the GNUnet VPN::
+* Bandwidth Configuration::
+* Configuring NAT::
+* Peer configuration for distributions::
address@hidden menu
+
address@hidden Configuring your peer
address@hidden Configuring your peer
+
+This chapter will describe the various configuration options in GNUnet.
+
+The easiest way to configure your peer is to use the
address@hidden tool.
address@hidden 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 @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
+as it requires a more in-depth understanding of the configuration files
+and internal dependencies of GNUnet.
+
address@hidden Configuring the Friend-to-Friend (F2F) mode
address@hidden Configuring the Friend-to-Friend (F2F) mode
+
+GNUnet knows three basic modes of operation:
address@hidden @bullet
address@hidden In standard "peer-to-peer" mode,
+your peer will connect to any peer.
address@hidden In the pure "friend-to-friend"
+mode, your peer will ONLY connect to peers from a list of friends
+specified in the configuration.
address@hidden Finally, in mixed mode,
+GNUnet will only connect to arbitrary peers if it
+has at least a specified number of connections to friends.
address@hidden itemize
+
+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
+
address@hidden
+$ gnunet-peerinfo -sq
address@hidden example
+
address@hidden
+The resulting output of this command needs to be added to your
address@hidden 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 @file{friends} file in the
address@hidden option of the "topology" section.
+
+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
address@hidden to zero and @code{FRIENDS_ONLY} to NO.
+This is the default.
+
address@hidden Configuring the hostlist to bootstrap
address@hidden Configuring the hostlist to bootstrap
+
+After installing the software you need to get connected to the GNUnet
+network. The configuration file included in your download is already
+configured to connect you to the GNUnet network.
+In this section the relevant configuration settings are explained.
+
+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".
+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 the @code{[hostlist]}-section in your
+configuration file. You have to set the argument @command{-b} in the
+options line:
+
address@hidden
+[hostlist]
+OPTIONS = -b
address@hidden example
+
+Additionally you have to specify which server you want to use.
+The default bootstrapping server is
+"@uref{http://v10.gnunet.org/hostlist, http://v10.gnunet.org/hostlist}";.
+[^] To set the server you have to edit the line "SERVERS" in the hostlist
+section. To use the default server you should set the lines to
+
address@hidden
+SERVERS = http://v10.gnunet.org/hostlist [^]
address@hidden example
+
address@hidden
+To use bootstrapping your configuration file should include these lines:
+
address@hidden
+[hostlist]
+OPTIONS = -b
+SERVERS = http://v10.gnunet.org/hostlist [^]
address@hidden example
+
address@hidden
+Besides using bootstrap servers you can configure your GNUnet peer to
+recieve hostlist advertisements.
+Peers offering hostlists to other peers can send advertisement messages
+to peers that connect to them. If you configure your peer to receive these
+messages, your peer can download these lists and connect to the peers
+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 @command{-e}
+switch to the @code{OPTIONS} line in the hostlist section:
+
address@hidden
+[hostlist]
+OPTIONS = -b -e
address@hidden example
+
address@hidden
+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:
+
address@hidden
+HOSTLISTFILE = hostlists.file
address@hidden example
+
address@hidden
+Best practice is to activate both bootstrapping and hostlist learning.
+So your configuration file should include these lines:
+
address@hidden
+[hostlist]
+OPTIONS = -b -e
+HTTPPORT = 8080
+SERVERS = http://v10.gnunet.org/hostlist [^]
+HOSTLISTFILE = $SERVICEHOME/hostlists.file
address@hidden example
+
address@hidden Configuration of the HOSTLIST proxy settings
address@hidden Configuration of the HOSTLIST proxy settings
+
+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 @command{gnunet-setup} tool.
+
+The hostlist client supports the following proxy types at the moment:
+
address@hidden @bullet
address@hidden HTTP and HTTP 1.0 only proxy
address@hidden SOCKS 4/4a/5/5 with hostname
address@hidden itemize
+
+In addition authentication at the proxy with username and password can be
+configured.
+
+To configure proxy support for the hostlist client in the
address@hidden 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 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 provide these options directly in the configuration, you can
+enter the following settings in the @code{[hostlist]} section of
+the configuration:
+
address@hidden
+# Type of proxy server,
+# Valid values: HTTP, HTTP_1_0, SOCKS4, SOCKS5, SOCKS4A, SOCKS5_HOSTNAME
+# Default: HTTP
+# PROXY_TYPE = HTTP
+
+# Hostname or IP of proxy server
+# PROXY =
+# User name for proxy server
+# PROXY_USERNAME =
+# User password for proxy server
+# PROXY_PASSWORD =
address@hidden example
+
address@hidden Configuring your peer to provide a hostlist
address@hidden Configuring your peer to provide a hostlist
+
+If you operate a peer permanently connected to GNUnet you can configure
+your peer to act as a hostlist server, providing other peers the list of
+peers known to him.
+
+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 libgnurl (or libcurl)
+and microhttpd support.
+
+To configure your peer to act as a bootstrap server you have to add the
address@hidden 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:
+
address@hidden
+[hostlist]
+HTTPPORT = 12980
+OPTIONS = -p
address@hidden example
+
address@hidden
+If your peer acts as a bootstrap server other peers should know about
+that. You can advertise the hostlist your are providing to other peers.
+Peers connecting to your peer will get a message containing an
+advertisement for your hostlist and the URL where it can be downloaded.
+If this peer is in learning mode, it will test the hostlist and, in the
+case it can obtain the list successfully, it will save it for
+bootstrapping.
+
+To activate hostlist advertisement on your peer, you have to set the
+following lines in your configuration file:
+
address@hidden
+[hostlist]
+EXTERNAL_DNS_NAME = example.org
+HTTPPORT = 12981
+OPTIONS = -p -a
address@hidden example
+
address@hidden
+With this configuration your peer will a act as a bootstrap server and
+advertise this hostlist to other peers connecting to it.
+The URL used to download the list will be
address@hidden@uref{http://example.org:12981/, http://example.org:12981/}}.
+
+Please notice:
+
address@hidden @bullet
address@hidden 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!
address@hidden Advertising without providing a hostlist does not make sense and
+will not work.
address@hidden itemize
+
address@hidden Configuring the datastore
address@hidden Configuring the datastore
+
+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 @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
+so. Currently, you have the choice between sqLite, MySQL and Postgres.
+
address@hidden Configuring the MySQL database
address@hidden Configuring the MySQL database
+
+This section describes how to setup the MySQL database for GNUnet.
+
+Note that the mysql plugin does NOT work with mysql before 4.1 since we
+need prepared statements.
+We are generally testing the code against MySQL 5.1 at this point.
+
address@hidden Reasons for using MySQL
address@hidden Reasons for using MySQL
+
address@hidden @bullet
+
address@hidden 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).
+
address@hidden Its often possible to recover the mysql database from internal
+inconsistencies. Some of the other databases do not support repair.
address@hidden itemize
+
address@hidden Reasons for not using MySQL
address@hidden Reasons for not using MySQL
+
address@hidden @bullet
address@hidden Memory usage (likely not an issue if you have more than 1 GB)
address@hidden Complex manual setup
address@hidden itemize
+
address@hidden Setup Instructions
address@hidden Setup Instructions
+
address@hidden @bullet
+
address@hidden In @file{gnunet.conf} set in section @code{DATASTORE} the value
for
address@hidden to @code{mysql}.
+
address@hidden Access mysql as root:
+
address@hidden
+$ mysql -u root -p
address@hidden example
+
address@hidden
+and issue the following commands, replacing $USER with the username
+that will be running @command{gnunet-arm} (so typically "gnunet"):
+
address@hidden
+CREATE DATABASE gnunet;
+GRANT select,insert,update,delete,create,alter,drop,create \
+temporary tables ON gnunet.* TO $USER@@localhost;
+SET PASSWORD FOR $USER@@localhost=PASSWORD('$the_password_you_like');
+FLUSH PRIVILEGES;
address@hidden example
+
address@hidden
+In the $HOME directory of $USER, create a @file{.my.cnf} file with the
+following lines
+
address@hidden
+[client]
+user=$USER
+password=$the_password_you_like
address@hidden example
+
address@hidden itemize
+
+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.
+
address@hidden Testing
address@hidden Testing
+
+You should briefly try if the database connection works. First, login
+as $USER. Then use:
+
address@hidden
+$ mysql -u $USER
+mysql> use gnunet;
address@hidden example
+
address@hidden
+If you get the message
+
address@hidden
+Database changed
address@hidden example
+
address@hidden
+it probably works.
+
+If you get
+
address@hidden
+ERROR 2002: Can't connect to local MySQL server
+through socket '/tmp/mysql.sock' (2)
address@hidden example
+
address@hidden
+it may be resolvable by
+
address@hidden
+ln -s /var/run/mysqld/mysqld.sock /tmp/mysql.sock
address@hidden example
+
address@hidden
+so there may be some additional trouble depending on your mysql setup.
+
address@hidden Performance Tuning
address@hidden Performance Tuning
+
+For GNUnet, you probably want to set the option
+
address@hidden
+innodb_flush_log_at_trx_commit = 0
address@hidden example
+
address@hidden
+for a rather dramatic boost in MySQL performance. However, this reduces
+the "safety" of your database as with this options you may loose
+transactions during a power outage.
+While this is totally harmless for GNUnet, the option applies to all
+applications using MySQL. So you should set it if (and only if) GNUnet is
+the only application on your system using MySQL.
+
address@hidden Setup for running Testcases
address@hidden Setup for running Testcases
+
+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 (@command{make check}).
+
address@hidden Configuring the Postgres database
address@hidden Configuring the Postgres database
+
+This text describes how to setup the Postgres database for GNUnet.
+
+This Postgres plugin was developed for Postgres 8.3 but might work for
+earlier versions as well.
+
address@hidden Reasons to use Postgres
address@hidden Reasons to use Postgres
+
address@hidden @bullet
address@hidden Easier to setup than MySQL
address@hidden Real database
address@hidden itemize
+
address@hidden Reasons not to use Postgres
address@hidden Reasons not to use Postgres
+
address@hidden @bullet
address@hidden Quite slow
address@hidden Still some manual setup required
address@hidden itemize
+
address@hidden Manual setup instructions
address@hidden Manual setup instructions
+
address@hidden @bullet
address@hidden In @file{gnunet.conf} set in section @code{DATASTORE} the value
for
address@hidden to @code{postgres}.
address@hidden Access Postgres to create a user:
+
address@hidden @asis
address@hidden with Postgres 8.x, use:
+
address@hidden
+# su - postgres
+$ createuser
address@hidden example
+
address@hidden
+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.
+
address@hidden with Postgres 9.x, use:
+
address@hidden
+# su - postgres
+$ createuser -d $GNUNET_USER
address@hidden example
+
address@hidden
+where $GNUNET_USER is the name of the user running GNUnet.
+
address@hidden table
+
+
address@hidden
+As that user (so typically as user "gnunet"), create a database (or two):
+
address@hidden
+$ createdb gnunet
+# this way you can run "make check"
+$ createdb gnunetcheck
address@hidden example
+
address@hidden itemize
+
+Now you should be able to start @code{gnunet-arm}.
+
address@hidden Testing the setup manually
address@hidden Testing the setup manually
+
+You may want to try if the database connection works. First, again login
+as the user who will run @command{gnunet-arm}. Then use:
+
address@hidden
+$ psql gnunet # or gnunetcheck
+gnunet=> \dt
address@hidden example
+
address@hidden
+If, after you have started @command{gnunet-arm} at least once, you get
+a @code{gn090} table here, it probably works.
+
address@hidden Configuring the datacache
address@hidden Configuring the datacache
address@hidden %**end of header
+
+The datacache is what GNUnet uses for storing temporary data. This data is
+expected to be wiped completely each time GNUnet is restarted (or the
+system is rebooted).
+
+You need to specify how many bytes GNUnet is allowed to use for the
+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.
+
address@hidden Configuring the file-sharing service
address@hidden Configuring the file-sharing service
+
+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 @code{AUTOSTART} option in
+section @code{[fs]} to "YES". Alternatively, you can run
+
address@hidden
+$ gnunet-arm -i fs
address@hidden example
+
address@hidden
+to start the file-sharing service by hand.
+
+Except for configuring the database and the datacache the only important
+option for file-sharing is content migration.
+
+Content migration allows your peer to cache content from other peers as
+well as send out content stored on your system without explicit requests.
+This content replication has positive and negative impacts on both system
+performance and privacy.
+
+FIXME: discuss the trade-offs. Here is some older text about it...
+
+Setting this option to YES allows gnunetd to migrate data to the local
+machine. Setting this option to YES is highly recommended for efficiency.
+Its also the default. If you set this value to YES, GNUnet will store
+content on your machine that you cannot decrypt.
+While this may protect you from liability if the judge is sane, it may
+not (IANAL). If you put illegal content on your machine yourself, setting
+this option to YES will probably increase your chances to get away with it
+since you can plausibly deny that you inserted the content.
+Note that in either case, your anonymity would have to be broken first
+(which may be possible depending on the size of the GNUnet network and the
+strength of the adversary).
+
address@hidden Configuring logging
address@hidden Configuring logging
+
+Logging in GNUnet 0.9.0 is controlled via the "-L" and "-l" options.
+Using @code{-L}, a log level can be specified. With log level
address@hidden 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
address@hidden can be used by developers to log debugging messages
+(but you need to run @code{./configure} with
address@hidden to get them compiled).
+The @code{-l} option is used to specify the log file.
+
+Since most GNUnet services are managed by @code{gnunet-arm}, using the
address@hidden 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
address@hidden option.
+The value specified here is given as an extra option to all services for
+which the configuration does contain a service-specific @code{OPTIONS}
+field.
+
address@hidden can contain the special sequence "@address@hidden" 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
address@hidden to log-files called @code{SERVICENAME-logs}, the
+following global prefix should be used:
+
address@hidden
+GLOBAL_POSTFIX = -l $SERVICEHOME/@address@hidden -L INFO
address@hidden example
+
address@hidden Configuring the transport service and plugins
address@hidden Configuring the transport service and plugins
+
+The transport service in GNUnet is responsible to maintain basic
+connectivity to other peers.
+Besides initiating and keeping connections alive it is also responsible
+for address validation.
+
+The GNUnet transport supports more than one transport protocol.
+These protocols are configured together with the transport service.
+
+The configuration section for the transport service itself is quite
+similar to all the other services
+
address@hidden
+AUTOSTART = YES
+@@UNIXONLY@@ PORT = 2091
+HOSTNAME = localhost
+HOME = $SERVICEHOME
+CONFIG = $DEFAULTCONFIG
+BINARY = gnunet-service-transport
+#PREFIX = valgrind
+NEIGHBOUR_LIMIT = 50
+ACCEPT_FROM = 127.0.0.1;
+ACCEPT_FROM6 = ::1;
+PLUGINS = tcp udp
+UNIXPATH = /tmp/gnunet-service-transport.sock
address@hidden example
+
+Different are the settings for the plugins to load @code{PLUGINS}.
+The first setting specifies which transport plugins to load.
+
address@hidden @bullet
address@hidden transport-unix
+A plugin for local only communication with UNIX domain sockets. Used for
+testing and available on unix systems only. Just set the port
+
address@hidden
+[transport-unix]
+PORT = 22086
+TESTING_IGNORE_KEYS = ACCEPT_FROM;
address@hidden example
+
address@hidden transport-tcp
+A plugin for communication with TCP. Set port to 0 for client mode with
+outbound only connections
+
address@hidden
+[transport-tcp]
+# Use 0 to ONLY advertise as a peer behind NAT (no port binding)
+PORT = 2086
+ADVERTISED_PORT = 2086
+TESTING_IGNORE_KEYS = ACCEPT_FROM;
+# Maximum number of open TCP connections allowed
+MAX_CONNECTIONS = 128
address@hidden example
+
address@hidden transport-udp
+A plugin for communication with UDP. Supports peer discovery using
+broadcasts.
+
address@hidden
+[transport-udp]
+PORT = 2086
+BROADCAST = YES
+BROADCAST_INTERVAL = 30 s
+MAX_BPS = 1000000
+TESTING_IGNORE_KEYS = ACCEPT_FROM;
address@hidden example
+
address@hidden transport-http
+HTTP and HTTPS support is split in two part: a client plugin initiating
+outbound connections and a server part accepting connections from the
+client. The client plugin just takes the maximum number of connections as
+an argument.
+
address@hidden
+[transport-http_client]
+MAX_CONNECTIONS = 128
+TESTING_IGNORE_KEYS = ACCEPT_FROM;
address@hidden example
+
address@hidden
+[transport-https_client]
+MAX_CONNECTIONS = 128
+TESTING_IGNORE_KEYS = ACCEPT_FROM;
address@hidden example
+
address@hidden
+The server has a port configured and the maximum nunber of connections.
+The HTTPS part has two files with the certificate key and the certificate
+file.
+
+The server plugin supports reverse proxies, so a external hostname can be
+set using the @code{EXTERNAL_HOSTNAME} setting.
+The webserver under this address should forward the request to the peer
+and the configure port.
+
address@hidden
+[transport-http_server]
+EXTERNAL_HOSTNAME = fulcrum.net.in.tum.de/gnunet
+PORT = 1080
+MAX_CONNECTIONS = 128
+TESTING_IGNORE_KEYS = ACCEPT_FROM;
address@hidden example
+
address@hidden
+[transport-https_server]
+PORT = 4433
+CRYPTO_INIT = NORMAL
+KEY_FILE = https.key
+CERT_FILE = https.cert
+MAX_CONNECTIONS = 128
+TESTING_IGNORE_KEYS = ACCEPT_FROM;
address@hidden example
+
address@hidden transport-wlan
+
+The next section describes how to setup the WLAN plugin,
+so here only the settings. Just specify the interface to use:
+
address@hidden
+[transport-wlan]
+# Name of the interface in monitor mode (typically monX)
+INTERFACE = mon0
+# Real hardware, no testing
+TESTMODE = 0
+TESTING_IGNORE_KEYS = ACCEPT_FROM;
address@hidden example
address@hidden itemize
+
address@hidden Configuring the wlan transport plugin
address@hidden 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
+GNUnet where no internet access is possible, for example during
+catastrophes or when censorship cuts you off from the internet.
+
+
address@hidden
+* Requirements for the WLAN plugin::
+* Configuration::
+* Before starting GNUnet::
+* Limitations and known bugs::
address@hidden menu
+
+
address@hidden Requirements for the WLAN plugin
address@hidden Requirements for the WLAN plugin
+
address@hidden @bullet
+
address@hidden wlan network card with monitor support and packet injection
+(see @uref{http://www.aircrack-ng.org/, aircrack-ng.org})
+
address@hidden Linux kernel with mac80211 stack, introduced in 2.6.22, tested
with
+2.6.35 and 2.6.38
+
address@hidden Wlantools to create the a monitor interface, tested with
airmon-ng
+of the aircrack-ng package
address@hidden itemize
+
address@hidden Configuration
address@hidden Configuration
+
+There are the following options for the wlan plugin (they should be like
+this in your default config file, you only need to adjust them if the
+values are incorrect for your system)
+
address@hidden
+# section for the wlan transport plugin
+[transport-wlan]
+# interface to use, more information in the
+# "Before starting GNUnet" section of the handbook.
+INTERFACE = mon0
+# testmode for developers:
+# 0 use wlan interface,
+#1 or 2 use loopback driver for tests 1 = server, 2 = client
+TESTMODE = 0
address@hidden example
+
address@hidden Before starting GNUnet
address@hidden 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:
+
address@hidden
+sudo airmon-ng start wlan0
address@hidden example
+
address@hidden
+Here is an example what the result should look like:
+
address@hidden
+Interface Chipset Driver
+wlan0 Intel 4965 a/b/g/n iwl4965 - [phy0]
+(monitor mode enabled on mon0)
address@hidden example
+
address@hidden
+The monitor interface is mon0 is the one that you have to put into the
+configuration file.
+
address@hidden Limitations and known bugs
address@hidden Limitations and known bugs
+
+Wlan speed is at the maximum of 1 Mbit/s because support for choosing the
+wlan speed with packet injection was removed in newer kernels.
+Please pester the kernel developers about fixing this.
+
+The interface channel depends on the wlan network that the card is
+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:
+
address@hidden
+iwconfig wlan0 channel 1
address@hidden example
+
address@hidden Configuring HTTP(S) reverse proxy functionality using Apache or
nginx
address@hidden Configuring HTTP(S) reverse proxy functionality using Apache or
nginx
+
+The HTTP plugin supports data transfer using reverse proxies. A reverse
+proxy forwards the HTTP request he receives with a certain URL to another
+webserver, here a GNUnet peer.
+
+So if you have a running Apache or nginx webserver you can configure it to
+be a GNUnet reverse proxy. Especially if you have a well-known webiste
+this improves censorship resistance since it looks as normal surfing
+behaviour.
+
+To do so, you have to do two things:
+
address@hidden @bullet
address@hidden Configure your webserver to forward the GNUnet HTTP traffic
address@hidden Configure your GNUnet peer to announce the respective address
address@hidden itemize
+
+As an example we want to use GNUnet peer running:
+
address@hidden @bullet
+
address@hidden HTTP server plugin on @code{gnunet.foo.org:1080}
+
address@hidden HTTPS server plugin on @code{gnunet.foo.org:4433}
+
address@hidden A apache or nginx webserver on
address@hidden://www.foo.org/, http://www.foo.org:80/}
+
address@hidden A apache or nginx webserver on https://www.foo.org:443/
address@hidden itemize
+
+And we want the webserver to accept GNUnet traffic under
address@hidden://www.foo.org/bar/}. The required steps are described here:
+
address@hidden
+* 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::
address@hidden menu
+
address@hidden Reverse Proxy - Configure your Apache2 HTTP webserver
address@hidden Reverse Proxy - Configure your Apache2 HTTP webserver
+
+First of all you need mod_proxy installed.
+
+Edit your webserver configuration. Edit
address@hidden/etc/apache2/apache2.conf} or the site-specific configuration
file.
+
+In the respective @code{server config},@code{virtual host} or
address@hidden section add the following lines:
+
address@hidden
+ProxyTimeout 300
+ProxyRequests Off
+<Location /bar/ >
+ProxyPass http://gnunet.foo.org:1080/
+ProxyPassReverse http://gnunet.foo.org:1080/
+</Location>
address@hidden example
+
address@hidden Reverse Proxy - Configure your Apache2 HTTPS webserver
address@hidden 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 uncomplicated to use example
+is the example configuration file for Apache2/HTTPD provided in
address@hidden/sites-available/default-ssl}.
+
+In the respective HTTPS @code{server config},@code{virtual host} or
address@hidden section add the following lines:
+
address@hidden
+SSLProxyEngine On
+ProxyTimeout 300
+ProxyRequests Off
+<Location /bar/ >
+ProxyPass https://gnunet.foo.org:4433/
+ProxyPassReverse https://gnunet.foo.org:4433/
+</Location>
address@hidden example
+
address@hidden
+More information about the apache mod_proxy configuration can be found
+in the Apache
address@hidden@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}}
+
address@hidden Reverse Proxy - Configure your nginx HTTPS webserver
address@hidden Reverse Proxy - Configure your nginx HTTPS webserver
+
+Since nginx does not support chunked encoding, you first of all have to
+install the @code{chunkin}
address@hidden@uref{http://wiki.nginx.org/HttpChunkinModule,
http://wiki.nginx.org/HttpChunkinModule}}
+
+To enable chunkin add:
+
address@hidden
+chunkin on;
+error_page 411 = @@my_411_error;
+location @@my_411_error @{
+chunkin_resume;
address@hidden
address@hidden example
+
address@hidden
+Edit your webserver configuration. Edit @file{/etc/nginx/nginx.conf} or
+the site-specific configuration file.
+
+In the @code{server} section add:
+
address@hidden
+location /bar/ @{
+proxy_pass http://gnunet.foo.org:1080/;
+proxy_buffering off;
+proxy_connect_timeout 5; # more than http_server
+proxy_read_timeout 350; # 60 default, 300s is GNUnet's idle timeout
+proxy_http_version 1.1; # 1.0 default
+proxy_next_upstream error timeout invalid_header http_500 http_503 http_502
http_504;
address@hidden
address@hidden example
+
address@hidden Reverse Proxy - Configure your nginx HTTP webserver
address@hidden Reverse Proxy - Configure your nginx HTTP webserver
+
+Edit your webserver configuration. Edit @file{/etc/nginx/nginx.conf} or
+the site-specific configuration file.
+
+In the @code{server} section add:
+
address@hidden
+ssl_session_timeout 6m;
+location /bar/
address@hidden
+proxy_pass https://gnunet.foo.org:4433/;
+proxy_buffering off;
+proxy_connect_timeout 5; # more than http_server
+proxy_read_timeout 350; # 60 default, 300s is GNUnet's idle timeout
+proxy_http_version 1.1; # 1.0 default
+proxy_next_upstream error timeout invalid_header http_500 http_503 http_502
http_504;
address@hidden
address@hidden example
+
address@hidden Reverse Proxy - Configure your GNUnet peer
address@hidden Reverse Proxy - Configure your GNUnet peer
+
+To have your GNUnet peer announce the address, you have to specify the
address@hidden option in the @code{[transport-http_server]}
+section:
+
address@hidden
+[transport-http_server]
+EXTERNAL_HOSTNAME = http://www.foo.org/bar/
address@hidden example
+
address@hidden
+and/or @code{[transport-https_server]} section:
+
address@hidden
+[transport-https_server]
+EXTERNAL_HOSTNAME = https://www.foo.org/bar/
address@hidden example
+
address@hidden
+Now restart your webserver and your peer...
+
address@hidden Blacklisting peers
address@hidden Blacklisting peers
+
+Transport service supports to deny connecting to a specific peer of to a
+specific peer with a specific transport plugin using te blacklisting
+component of transport service. With@ blacklisting it is possible to deny
+connections to specific peers of@ to use a specific plugin to a specific
+peer. Peers can be blacklisted using@ the configuration or a blacklist
+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
+the plugin@ if required.
+
+Examples:
+
+To blacklist connections to P565... on peer AG2P... using tcp add:
+
address@hidden FIXME: This is too long and produces errors in the pdf.
address@hidden
+[transport-blacklist
AG2PHES1BARB9IJCPAMJTFPVJ5V3A72S3F2A8SBUB8DAQ2V0O3V8G6G2JU56FHGFOHMQVKBSQFV98TCGTC3RJ1NINP82G0RC00N1520]
+P565723JO1C2HSN6J29TAQ22MN6CI8HTMUU55T0FUQG4CMDGGEQ8UCNBKUMB94GC8R9G4FB2SF9LDOBAJ6AMINBP4JHHDD6L7VD801G
= tcp
address@hidden example
+
+To blacklist connections to P565... on peer AG2P... using all plugins add:
+
address@hidden
+[transport-blacklist-AG2PHES1BARB9IJCPAMJTFPVJ5V3A72S3F2A8SBUB8DAQ2V0O3V8G6G2JU56FHGFOHMQVKBSQFV98TCGTC3RJ1NINP82G0RC00N1520]
+P565723JO1C2HSN6J29TAQ22MN6CI8HTMUU55T0FUQG4CMDGGEQ8UCNBKUMB94GC8R9G4FB2SF9LDOBAJ6AMINBP4JHHDD6L7VD801G
=
address@hidden example
+
+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.
+
+On blacklist check for (peer, plugin)
address@hidden @bullet
address@hidden Do we have a local blacklist entry for this peer and this
plugin?@
address@hidden YES: disallow connection@
address@hidden Do we have a local blacklist entry for this peer and all
plugins?@
address@hidden YES: disallow connection@
address@hidden Does one of the clients disallow?@
address@hidden YES: disallow connection
address@hidden itemize
+
address@hidden Configuration of the HTTP and HTTPS transport plugins
address@hidden Configuration of the HTTP and HTTPS transport plugins
+
+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.
+
+Both the HTTP and HTTPS clients support the following proxy types at
+the moment:
+
address@hidden @bullet
address@hidden HTTP 1.1 proxy
address@hidden SOCKS 4/4a/5/5 with hostname
address@hidden itemize
+
+In addition authentication at the proxy with username and password can be
+configured.
+
+To configure proxy support for the clients in the gnunet-setup tool,
+select the "transport" tab and activate the respective plugin. Now you
+can 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.
+
+To configure these options directly in the configuration, you can
+configure the following settings in the @code{[transport-http_client]}
+and @code{[transport-https_client]} section of the configuration:
+
address@hidden
+# Type of proxy server,
+# Valid values: HTTP, SOCKS4, SOCKS5, SOCKS4A, SOCKS5_HOSTNAME
+# Default: HTTP
+# PROXY_TYPE = HTTP
+
+# Hostname or IP of proxy server
+# PROXY =
+# User name for proxy server
+# PROXY_USERNAME =
+# User password for proxy server
+# PROXY_PASSWORD =
address@hidden example
+
address@hidden Configuring the GNU Name System
address@hidden Configuring the GNU Name System
+
address@hidden
+* Configuring system-wide DNS interception::
+* Configuring the GNS nsswitch plugin::
+* Configuring GNS on W32::
+* GNS Proxy Setup::
+* Setup of the GNS CA::
+* Testing the GNS setup::
address@hidden menu
+
+
address@hidden Configuring system-wide DNS interception
address@hidden Configuring system-wide DNS interception
+
+Before you install GNUnet, make sure you have a user and group 'gnunet'
+as well as an empty group 'gnunetdns'.
+
+When using GNUnet with system-wide DNS interception, it is absolutely
+necessary for all GNUnet service processes to be started by
address@hidden as user and group 'gnunet'. You also need to be
+sure to run @code{make install} as root (or use the @code{sudo} option to
+configure) to grant GNUnet sufficient privileges.
+
+With this setup, all that is required for enabling system-wide DNS
+interception is for some GNUnet component (VPN or GNS) to request it.
+The @code{gnunet-service-dns} will then start helper programs that will
+make the necessary changes to your firewall (@code{iptables}) rules.
+
+Note that this will NOT work if your system sends out DNS traffic to a
+link-local IPv6 address, as in this case GNUnet can intercept the traffic,
+but not inject the responses from the link-local IPv6 address. Hence you
+cannot use system-wide DNS interception in conjunction with link-local
+IPv6-based DNS servers. If such a DNS server is used, it will bypass
+GNUnet's DNS traffic interception.
+
+Using the GNU Name System (GNS) requires two different configuration
+steps.
+First of all, GNS needs to be integrated with the operating system. Most
+of this section is about the operating system level integration.
+
+The remainder of this chapter will detail the various methods for
+configuring the use of GNS with your operating system.
+
+At this point in time you have different options depending on your OS:
+
address@hidden @asis
+
address@hidden Use the gnunet-gns-proxy This approach works for all operating
+systems and is likely the easiest. However, it enables GNS only for
+browsers, not for other applications that might be using DNS, such as SSH.
+Still, using the proxy is required for using HTTP with GNS and is thus
+recommended for all users. To do this, you simply have to run the
address@hidden script as the user who will run the
+browser (this will create a GNS certificate authority (CA) on your system
+and import its key into your browser), then start @code{gnunet-gns-proxy}
+and inform your browser to use the Socks5 proxy which
address@hidden makes available by default on port 7777.
address@hidden Use a nsswitch plugin (recommended on GNU systems)
+This approach has the advantage of offering fully personalized resolution
+even on multi-user systems. A potential disadvantage is that some
+applications might be able to bypass GNS.
address@hidden Use a W32 resolver plugin (recommended on W32)
+This is currently the only option on W32 systems.
address@hidden Use system-wide DNS packet interception
+This approach is recommended for the GNUnet VPN. It can be used to handle
+GNS at the same time; however, if you only use this method, you will only
+get one root zone per machine (not so great for multi-user systems).
address@hidden table
+
+You can combine system-wide DNS packet interception with the nsswitch
+plugin.
+The setup of the system-wide DNS interception is described here. All of
+the other GNS-specific configuration steps are described in the following
+sections.
+
address@hidden Configuring the GNS nsswitch plugin
address@hidden Configuring the GNS nsswitch plugin
+
+The Name Service Switch (NSS) is a facility in Unix-like operating systems
address@hidden 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 superuser (system administrator) usually configures the
+operating system's name services using the file
address@hidden/etc/nsswitch.conf}.
+
+GNS provides a NSS plugin to integrate GNS name resolution with the
+operating system's name resolution process.
+To use the GNS NSS plugin you have to either
+
address@hidden @bullet
address@hidden install GNUnet as root or
address@hidden compile GNUnet with the @code{--with-sudo=yes} switch.
address@hidden itemize
+
+Name resolution is controlled by the @emph{hosts} section in the NSS
+configuration. By default this section first performs a lookup in the
address@hidden/etc/hosts} file and then in DNS.
+The nsswitch file should contain a line similar to:
+
address@hidden
+hosts: files dns [NOTFOUND=return] mdns4_minimal mdns4
address@hidden example
+
address@hidden
+Here the GNS NSS plugin can be added to perform a GNS lookup before
+performing a DNS lookup.
+The GNS NSS plugin has to be added to the "hosts" section in
address@hidden/etc/nsswitch.conf} file before DNS related plugins:
+
address@hidden
+...
+hosts: files gns [NOTFOUND=return] dns mdns4_minimal mdns4
+...
address@hidden example
+
address@hidden
+The @code{NOTFOUND=return} will ensure that if a @code{.gnu} name is not
+found in GNS it will not be queried in DNS.
+
address@hidden Configuring GNS on W32
address@hidden Configuring GNS on W32
+
+This document is a guide to configuring GNU Name System on W32-compatible
+platforms.
+
+After GNUnet is installed, run the w32nsp-install tool:
+
address@hidden
+w32nsp-install.exe libw32nsp-0.dll
address@hidden example
+
address@hidden
+('0' is the library version of W32 NSP; it might increase in the future,
+change the invocation accordingly).
+
+This will install GNS namespace provider into the system and allow other
+applications to resolve names that end in '@strong{gnu}'
+and '@strong{zkey}'. Note that namespace provider requires
+gnunet-gns-helper-service-w32 to be running, as well as gns service
+itself (and its usual dependencies).
+
+Namespace provider is hardcoded to connect to @strong{127.0.0.1:5353},
+and this is where gnunet-gns-helper-service-w32 should be listening to
+(and is configured to listen to by default).
+
+To uninstall the provider, run:
+
address@hidden
+w32nsp-uninstall.exe
address@hidden example
+
address@hidden
+(uses provider GUID to uninstall it, does not need a dll name).
+
+Note that while MSDN claims that other applications will only be able to
+use the new namespace provider after re-starting, in reality they might
+stat to use it without that. Conversely, they might stop using the
+provider after it's been uninstalled, even if they were not re-started.
+W32 will not permit namespace provider library to be deleted or
+overwritten while the provider is installed, and while there is at least
+one process still using it (even after it was uninstalled).
+
address@hidden GNS Proxy Setup
address@hidden GNS Proxy Setup
+
+When using the GNU Name System (GNS) to browse the WWW, there are several
+issues that can be solved by adding the GNS Proxy to your setup:
+
address@hidden @bullet
+
address@hidden If the target website does not support GNS, it might assume that
it
+is operating under some name in the legacy DNS system (such as
+example.com). It may then attempt to set cookies for that domain, and the
+web server might expect a @code{Host: example.com} header in the request
+from your browser.
+However, your browser might be using @code{example.gnu} for the
address@hidden header and might only accept (and send) cookies for
address@hidden The GNS Proxy will perform the necessary translations
+of the hostnames for cookies and HTTP headers (using the LEHO record for
+the target domain as the desired substitute).
+
address@hidden If using HTTPS, the target site might include an SSL certificate
+which is either only valid for the LEHO domain or might match a TLSA
+record in GNS. However, your browser would expect a valid certificate for
address@hidden, not for some legacy domain name. The proxy will
+validate the certificate (either against LEHO or TLSA) and then
+on-the-fly produce a valid certificate for the exchange, signed by your
+own CA. Assuming you installed the CA of your proxy in your browser's
+certificate authority list, your browser will then trust the
+HTTPS/SSL/TLS connection, as the hostname mismatch is hidden by the proxy.
+
address@hidden Finally, the proxy will in the future indicate to the server
that it
+speaks GNS, which will enable server operators to deliver GNS-enabled web
+sites to your browser (and continue to deliver legacy links to legacy
+browsers)
address@hidden itemize
+
address@hidden Setup of the GNS CA
address@hidden Setup of the GNS CA
+
+First you need to create a CA certificate that the proxy can use.
+To do so use the provided script gnunet-gns-proxy-ca:
+
address@hidden
+$ gnunet-gns-proxy-setup-ca
address@hidden example
+
address@hidden
+This will create a personal certification authority for you and add this
+authority to the firefox and chrome database. The proxy will use the this
+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 @b{not} work with libcurl compiled
+against OpenSSL.
+
+You can check the configuration your libcurl was build with by
+running:
+
address@hidden
+curl --version
address@hidden example
+
+the output will look like this (without the linebreaks):
+
address@hidden
+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
address@hidden example
+
address@hidden Testing the GNS setup
address@hidden Testing the GNS setup
+
+Now for testing purposes we can create some records in our zone to test
+the SSL functionality of the proxy:
+
address@hidden
+$ 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
address@hidden example
+
address@hidden
+At this point we can start the proxy. Simply execute
+
address@hidden
+$ gnunet-gns-proxy
address@hidden example
+
address@hidden
+Configure your browser to use this SOCKSv5 proxy on port 7777 and visit
+this link.
+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
address@hidden to @code{true}.
+
+When you visit @code{https://homepage.test/}, you should get to the
address@hidden://gnunet.org/} frontpage and the browser (with the correctly
+configured proxy) should give you a valid SSL certificate for
address@hidden and no warnings. It should look like this:
+
address@hidden FIXME: Image does not exist, create it or save it from Drupal?
address@hidden @image{images/gnunethpgns.png,5in,, picture of homepage.gnu in
Webbrowser}
+
+
address@hidden Configuring the GNUnet VPN
address@hidden Configuring the GNUnet VPN
+
address@hidden
+* IPv4 address for interface::
+* IPv6 address for interface::
+* Configuring the GNUnet VPN DNS::
+* Configuring the GNUnet VPN Exit Service::
+* IP Address of external DNS resolver::
+* IPv4 address for Exit interface::
+* IPv6 address for Exit interface::
address@hidden menu
+
+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. @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.
+
+The other options as shown on the gnunet-setup tool are:
+
address@hidden IPv4 address for interface
address@hidden IPv4 address for interface
+
+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 @code{10.0.0.1/255.255.0.0} already, you might use
address@hidden/255.255.0.0}.
+If you use @code{10.0.0.1/255.0.0.0} already, then you might use
address@hidden/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
+(@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.
+
address@hidden IPv6 address for interface
address@hidden 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 @code{fe80:}).
+A subnet Unique Local Unicast (@code{fd00::/8} prefix) that you are
+currently not using would be a good choice.
+
address@hidden Configuring the GNUnet VPN DNS
address@hidden Configuring the GNUnet VPN DNS
+
+To resolve names for remote nodes, activate the DNS exit option.
+
address@hidden Configuring the GNUnet VPN Exit Service
address@hidden Configuring the GNUnet VPN Exit Service
+
+If you want to allow other users to share your Internet connection (yes,
+this may be dangerous, just as running a Tor exit node) or want to
+provide access to services on your host (this should be less dangerous,
+as long as those services are secure), you have to enable the GNUnet exit
+daemon.
+
+You then get to specify which exit functions you want to provide. By
+enabling the exit daemon, you will always automatically provide exit
+functions for manually configured local services (this component of the
+system is under
+development and not documented further at this time). As for those
+services you explicitly specify the target IP address and port, there is
+no significant security risk in doing so.
+
+Furthermore, you can serve as a DNS, IPv4 or IPv6 exit to the Internet.
+Being a DNS exit is usually pretty harmless. However, enabling IPv4 or
+IPv6-exit without further precautions may enable adversaries to access
+your local network, send spam, attack other systems from your Internet
+connection and to other mischief that will appear to come from your
+machine. This may or may not get you into legal trouble.
+If you want to allow IPv4 or IPv6-exit functionality, you should strongly
+consider adding additional firewall rules manually to protect your local
+network and to restrict outgoing TCP traffic (i.e. by not allowing access
+to port 25). While we plan to improve exit-filtering in the future,
+you're currently on your own here.
+Essentially, be prepared for any kind of IP-traffic to exit the respective
+TUN interface (and GNUnet will enable IP-forwarding and NAT for the
+interface automatically).
+
+Additional configuration options of the exit as shown by the gnunet-setup
+tool are:
+
address@hidden IP Address of external DNS resolver
address@hidden IP Address of external DNS resolver
+
+If DNS traffic is to exit your machine, it will be send to this DNS
+resolver. You can specify an IPv4 or IPv6 address.
+
address@hidden IPv4 address for Exit interface
address@hidden IPv4 address for Exit interface
+
+This is the IPv4 address the Interface will get. Make the mask of the
+address big enough (255.255.0.0 or, even better, 255.0.0.0) to allow more
+mappings of IP addresses into this range. As for the VPN interface, any
+unused, private IPv4 address range will do.
+
address@hidden IPv6 address for Exit interface
address@hidden IPv6 address for Exit interface
+
+The public IPv6 address the interface will get. If your kernel is not a
+very recent kernel and you are willing to manually enable IPv6-NAT, the
+IPv6 address you specify here must be a globally routed IPv6 address of
+your host.
+
+Suppose your host has the address @code{2001:4ca0::1234/64}, then
+using @code{2001:4ca0::1:0/112} would be fine (keep the first 64 bits,
+then change at least one bit in the range before the bitmask, in the
+example above we changed bit 111 from 0 to 1).
+
+You may also have to configure your router to route traffic for the entire
+subnet (@code{2001:4ca0::1:0/112} for example) through your computer (this
+should be automatic with IPv6, but obviously anything can be
+disabled).
+
address@hidden Bandwidth Configuration
address@hidden Bandwidth Configuration
+
+You can specify how many bandwidth GNUnet is allowed to use to receive
+and send data. This is important for users with limited bandwidth or
+traffic volume.
+
address@hidden Configuring NAT
address@hidden Configuring NAT
+
+Most hosts today do not have a normal global IP address but instead are
+behind a router performing Network Address Translation (NAT) which assigns
+each host in the local network a private IP address.
+As a result, these machines cannot trivially receive inbound connections
+from the Internet. GNUnet supports NAT traversal to enable these machines
+to receive incoming connections from other peers despite their
+limitations.
+
+In an ideal world, you can press the "Attempt automatic configuration"
+button in gnunet-setup to automatically configure your peer correctly.
+Alternatively, your distribution might have already triggered this
+automatic configuration during the installation process.
+However, automatic configuration can fail to determine the optimal
+settings, resulting in your peer either not receiving as many connections
+as possible, or in the worst case it not connecting to the network at all.
+
+To manually configure the peer, you need to know a few things about your
+network setup. First, determine if you are behind a NAT in the first
+place.
+This is always the case if your IP address starts with "10.*" or
+"192.168.*". Next, if you have control over your NAT router, you may
+choose to manually configure it to allow GNUnet traffic to your host.
+If you have configured your NAT to forward traffic on ports 2086 (and
+possibly 1080) to your host, you can check the "NAT ports have been opened
+manually" option, which corresponds to the "PUNCHED_NAT" option in the
+configuration file. If you did not punch your NAT box, it may still be
+configured to support UPnP, which allows GNUnet to automatically
+configure it. In that case, you need to install the "upnpc" command,
+enable UPnP (or PMP) on your NAT box and set the "Enable NAT traversal
+via UPnP or PMP" option (corresponding to "ENABLE_UPNP" in the
+configuration file).
+
+Some NAT boxes can be traversed using the autonomous NAT traversal method.
+This requires certain GNUnet components to be installed with "SUID"
+prividledges on your system (so if you're installing on a system you do
+not have administrative rights to, this will not work).
+If you installed as 'root', you can enable autonomous NAT traversal by
+checking the "Enable NAT traversal using ICMP method".
+The ICMP method requires a way to determine your NAT's external (global)
+IP address. This can be done using either UPnP, DynDNS, or by manual
+configuration. If you have a DynDNS name or know your external IP address,
+you should enter that name under "External (public) IPv4 address" (which
+corresponds to the "EXTERNAL_ADDRESS" option in the configuration file).
+If you leave the option empty, GNUnet will try to determine your external
+IP address automatically (which may fail, in which case autonomous
+NAT traversal will then not work).
+
+Finally, if you yourself are not behind NAT but want to be able to
+connect to NATed peers using autonomous NAT traversal, you need to check
+the "Enable connecting to NATed peers using ICMP method" box.
+
+
address@hidden Peer configuration for distributions
address@hidden Peer configuration for distributions
+
+The "GNUNET_DATA_HOME" in "[path]" in @file{/etc/gnunet.conf} should be
+manually set to "/var/lib/gnunet/data/" as the default
+"~/.local/share/gnunet/" is probably not that appropriate in this case.
+Similarly, distributions may consider pointing "GNUNET_RUNTIME_DIR" to
+"/var/run/gnunet/" and "GNUNET_HOME" to "/var/lib/gnunet/". Also, should a
+distribution decide to override system defaults, all of these changes
+should be done in a custom @file{/etc/gnunet.conf} and not in the files
+in the @file{config.d/} directory.
+
+Given the proposed access permissions, the "gnunet-setup" tool must be
+run as use "gnunet" (and with option "-c /etc/gnunet.conf" so that it
+modifies the system configuration). As always, gnunet-setup should be run
+after the GNUnet peer was stopped using "gnunet-arm -e". Distributions
+might want to include a wrapper for gnunet-setup that allows the
+desktop-user to "sudo" (i.e. using gtksudo) to the "gnunet" user account
+and then runs "gnunet-arm -e", "gnunet-setup" and "gnunet-arm -s" in
+sequence.
+
address@hidden How to start and stop a GNUnet peer
address@hidden How to start and stop a GNUnet peer
+
+This section describes how to start a GNUnet peer. It assumes that you
+have already compiled and installed GNUnet and its' dependencies.
+Before you start a GNUnet peer, you may want to create a configuration
+file using gnunet-setup (but you do not have to).
+Sane defaults should exist in your
address@hidden/share/gnunet/config.d/} directory, so in practice
+you could simply start without any configuration. If you want to
+configure your peer later, you need to stop it before invoking the
address@hidden tool to customize further and to test your
+configuration (@code{gnunet-setup} has build-in test functions).
+
+The most important option you might have to still set by hand is in
+[PATHS]. Here, you use the option "GNUNET_HOME" to specify the path where
+GNUnet should store its data.
+It defaults to @code{$HOME/}, which again should work for most users.
+Make sure that the directory specified as GNUNET_HOME is writable to
+the user that you will use to run GNUnet (note that you can run frontends
+using other users, GNUNET_HOME must only be accessible to the user used to
+run the background processes).
+
+You will also need to make one central decision: should all of GNUnet be
+run under your normal UID, or do you want distinguish between system-wide
+(user-independent) GNUnet services and personal GNUnet services. The
+multi-user setup is slightly more complicated, but also more secure and
+generally recommended.
+
address@hidden
+* The Single-User Setup::
+* The Multi-User Setup::
+* Killing GNUnet services::
+* Access Control for GNUnet::
address@hidden menu
+
address@hidden The Single-User Setup
address@hidden The Single-User Setup
+
+For the single-user setup, you do not need to do anything special and can
+just start the GNUnet background processes using @code{gnunet-arm}.
+By default, GNUnet looks in @file{~/.config/gnunet.conf} for a
+configuration (or @code{$XDG_CONFIG_HOME/gnunet.conf} if@
address@hidden is defined). If your configuration lives
+elsewhere, you need to pass the @code{-c FILENAME} option to all GNUnet
+commands.
+
+Assuming the configuration file is called @file{~/.config/gnunet.conf},
+you start your peer using the @code{gnunet-arm} command (say as user
address@hidden) using:
+
address@hidden
+gnunet-arm -c ~/.config/gnunet.conf -s
address@hidden example
+
address@hidden
+The "-s" option here is for "start". The command should return almost
+instantly. If you want to stop GNUnet, you can use:
+
address@hidden
+gnunet-arm -c ~/.config/gnunet.conf -e
address@hidden example
+
address@hidden
+The "-e" option here is for "end".
+
+Note that this will only start the basic peer, no actual applications
+will be available.
+If you want to start the file-sharing service, use (after starting
+GNUnet):
+
address@hidden
+gnunet-arm -c ~/.config/gnunet.conf -i fs
address@hidden example
+
address@hidden
+The "-i fs" option here is for "initialize" the "fs" (file-sharing)
+application. You can also selectively kill only file-sharing support using
+
address@hidden
+gnunet-arm -c ~/.config/gnunet.conf -k fs
address@hidden example
+
address@hidden
+Assuming that you want certain services (like file-sharing) to be always
+automatically started whenever you start GNUnet, you can activate them by
+setting "FORCESTART=YES" in the respective section of the configuration
+file (for example, "[fs]"). Then GNUnet with file-sharing support would
+be started whenever you@ enter:
+
address@hidden
+gnunet-arm -c ~/.config/gnunet.conf -s
address@hidden example
+
address@hidden
+Alternatively, you can combine the two options:
+
address@hidden
+gnunet-arm -c ~/.config/gnunet.conf -s -i fs
address@hidden example
+
address@hidden
+Using @code{gnunet-arm} is also the preferred method for initializing
+GNUnet from @code{init}.
+
+Finally, you should edit your @code{crontab} (using the @code{crontab}
+command) and insert a line@
+
address@hidden
+@@reboot gnunet-arm -c ~/.config/gnunet.conf -s
address@hidden example
+
+to automatically start your peer whenever your system boots.
+
address@hidden The Multi-User Setup
address@hidden The Multi-User Setup
+
+This requires you to create a user @code{gnunet} and an additional group
address@hidden, prior to running @code{make install} during
+installation.
+Then, you create a configuration file @file{/etc/gnunet.conf} which should
+contain the lines:@
+
address@hidden
+[arm]
+SYSTEM_ONLY = YES
+USER_ONLY = NO
address@hidden example
+
address@hidden
+Then, perform the same steps to run GNUnet as in the per-user
+configuration, except as user @code{gnunet} (including the
address@hidden installation).
+You may also want to run @code{gnunet-setup} to configure your peer
+(databases, etc.).
+Make sure to pass @code{-c /etc/gnunet.conf} to all commands. If you
+run @code{gnunet-setup} as user @code{gnunet}, you might need to change
+permissions on @file{/etc/gnunet.conf} so that the @code{gnunet} user can
+write to the file (during setup).
+
+Afterwards, you need to perform another setup step for each normal user
+account from which you want to access GNUnet. First, grant the normal user
+(@code{$USER}) permission to the group gnunet:
+
address@hidden
+# adduser $USER gnunet
address@hidden example
+
address@hidden
+Then, create a configuration file in @file{~/.config/gnunet.conf} for the
+$USER with the lines:
+
address@hidden
+[arm]
+SYSTEM_ONLY = NO
+USER_ONLY = YES
address@hidden example
+
address@hidden
+This will ensure that @code{gnunet-arm} when started by the normal user
+will only run services that are per-user, and otherwise rely on the
+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
address@hidden/etc/gnunet.conf} and ignore options set by individual users.
+
+Again, each user should then start the peer using
address@hidden -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)
address@hidden processes running in your system.
+
address@hidden Killing GNUnet services
address@hidden Killing GNUnet services
+
+It is not necessary to stop GNUnet services explicitly when shutting
+down your computer.
+
+It should be noted that manually killing "most" of the
address@hidden processes is generally not a successful method for
+stopping a peer (since @code{gnunet-service-arm} will instantly restart
+them). The best way to explicitly stop a peer is using
address@hidden -e}; note that the per-user services may need to be
+terminated before the system-wide services will terminate normally.
+
address@hidden Access Control for GNUnet
address@hidden Access Control for GNUnet
+
+This chapter documents how we plan to make access control work within the
+GNUnet system for a typical peer. It should be read as a best-practice
+installation guide for advanced users and builders of binary
+distributions. The recommendations in this guide apply to POSIX-systems
+with full support for UNIX domain sockets only.
+
+Note that this is an advanced topic. The discussion presumes a very good
+understanding of users, groups and file permissions. Normal users on
+hosts with just a single user can just install GNUnet under their own
+account (and possibly allow the installer to use SUDO to grant additional
+permissions for special GNUnet tools that need additional rights).
+The discussion below largely applies to installations where multiple users
+share a system and to installations where the best possible security is
+paramount.
+
+A typical GNUnet system consists of components that fall into four
+categories:
+
address@hidden @asis
+
address@hidden User interfaces
+User interfaces are not security sensitive and are supposed to be run and
+used by normal system users.
+The GTK GUIs and most command-line programs fall into this category.
+Some command-line tools (like gnunet-transport) should be excluded as they
+offer low-level access that normal users should not need.
address@hidden System services and support tools
+System services should always run and offer services that can then be
+accessed by the normal users.
+System services do not require special permissions, but as they are not
+specific to a particular user, they probably should not run as a
+particular user. Also, there should typically only be one GNUnet peer per
+host. System services include the gnunet-service and gnunet-daemon
+programs; support tools include command-line programs such as gnunet-arm.
address@hidden Priviledged helpers
+Some GNUnet components require root rights to open raw sockets or perform
+other special operations. These gnunet-helper binaries are typically
+installed SUID and run from services or daemons.
address@hidden Critical services
+Some GNUnet services (such as the DNS service) can manipulate the service
+in deep and possibly highly security sensitive ways. For example, the DNS
+service can be used to intercept and alter any DNS query originating from
+the local machine. Access to the APIs of these critical services and their
+priviledged helpers must be tightly controlled.
address@hidden table
+
address@hidden FIXME: The titles of these chapters are too long in the index.
+
address@hidden
+* Recommendation - Disable access to services via TCP::
+* Recommendation - Run most services as system user "gnunet"::
+* Recommendation - Control access to services using group "gnunet"::
+* Recommendation - Limit access to certain SUID binaries by group "gnunet"::
+* Recommendation - Limit access to critical gnunet-helper-dns to group
"gnunetdns"::
+* Differences between "make install" and these recommendations::
address@hidden menu
+
address@hidden Recommendation - Disable access to services via TCP
address@hidden Recommendation - Disable access to services via TCP
+
+GNUnet services allow two types of access: via TCP socket or via UNIX
+domain socket.
+If the service is available via TCP, access control can only be
+implemented by restricting connections to a particular range of IP
+addresses.
+This is acceptable for non-critical services that are supposed to be
+available to all users on the local system or local network.
+However, as TCP is generally less efficient and it is rarely the case
+that a single GNUnet peer is supposed to serve an entire local network,
+the default configuration should disable TCP access to all GNUnet
+services on systems with support for UNIX domain sockets.
+As of GNUnet 0.9.2, configuration files with TCP access disabled should be
+generated by default. Users can re-enable TCP access to particular
+services simply by specifying a non-zero port number in the section of
+the respective service.
+
+
address@hidden Recommendation - Run most services as system user "gnunet"
address@hidden Recommendation - Run most services as system user "gnunet"
+
+GNUnet's main services should be run as a separate user "gnunet" in a
+special group "gnunet".
+The user "gnunet" should start the peer using "gnunet-arm -s" during
+system startup. The home directory for this user should be
address@hidden/var/lib/gnunet} and the configuration file should be
address@hidden/etc/gnunet.conf}.
+Only the @code{gnunet} user should have the right to access
address@hidden/var/lib/gnunet} (@emph{mode: 700}).
+
address@hidden Recommendation - Control access to services using group "gnunet"
address@hidden Recommendation - Control access to services using group "gnunet"
+
+Users that should be allowed to use the GNUnet peer should be added to the
+group "gnunet". Using GNUnet's access control mechanism for UNIX domain
+sockets, those services that are considered useful to ordinary users
+should be made available by setting "UNIX_MATCH_GID=YES" for those
+services.
+Again, as shipped, GNUnet provides reasonable defaults.
+Permissions to access the transport and core subsystems might additionally
+be granted without necessarily causing security concerns.
+Some services, such as DNS, must NOT be made accessible to the "gnunet"
+group (and should thus only be accessible to the "gnunet" user and
+services running with this UID).
+
address@hidden Recommendation - Limit access to certain SUID binaries by group
"gnunet"
address@hidden Recommendation - Limit access to certain SUID binaries by group
"gnunet"
+
+Most of GNUnet's SUID binaries should be safe even if executed by normal
+users. However, it is possible to reduce the risk a little bit more by
+making these binaries owned by the group "gnunet" and restricting their
+execution to user of the group "gnunet" as well (4750).
+
address@hidden Recommendation - Limit access to critical gnunet-helper-dns to
group "gnunetdns"
address@hidden Recommendation - Limit access to critical gnunet-helper-dns to
group "gnunetdns"
+
+A special group "gnunetdns" should be created for controlling access to
+the "gnunet-helper-dns".
+The binary should then be owned by root and be in group "gnunetdns" and
+be installed SUID and only be group-executable (2750).
address@hidden that the group "gnunetdns" should have no users in it at all,
+ever.}
+The "gnunet-service-dns" program should be executed by user "gnunet" (via
+gnunet-service-arm) with the binary owned by the user "root" and the group
+"gnunetdns" and be SGID (2700). This way, @strong{only}
+"gnunet-service-dns" can change its group to "gnunetdns" and execute the
+helper, and the helper can then run as root (as per SUID).
+Access to the API offered by "gnunet-service-dns" is in turn restricted
+to the user "gnunet" (not the group!), which means that only
+"benign" services can manipulate DNS queries using "gnunet-service-dns".
+
address@hidden Differences between "make install" and these recommendations
address@hidden Differences between "make install" and these recommendations
+
+The current build system does not set all permissions automatically based
+on the recommendations above. In particular, it does not use the group
+"gnunet" at all (so setting gnunet-helpers other than the
+gnunet-helper-dns to be owned by group "gnunet" must be done manually).
+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
address@hidden configure option.
diff --git a/doc/documentation/gnunet.texi b/doc/documentation/gnunet.texi
index 22ee8206a..e1847c227 100644
--- a/doc/documentation/gnunet.texi
+++ b/doc/documentation/gnunet.texi
@@ -75,7 +75,6 @@ This document is the Reference Manual for GNUnet version
@value{VERSION}.
* Preface:: Chapter 0
* Philosophy:: About GNUnet
@c * Vocabulary:: Vocabulary
-* GNUnet Installation Handbook:: How to install GNUnet
* Using GNUnet:: Using GNUnet
@c * Configuration Handbook:: Configuring GNUnet
* GNUnet Contributors Handbook:: Contributing to GNUnet
@@ -113,22 +112,6 @@ Philosophy
* Backup of Identities and Egos::
* Revocation::
-GNUnet Installation Handbook
-
-* 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::
-* Outdated build instructions for previous revisions::
address@hidden * Portable GNUnet::
-* The graphical configuration interface::
-* How to start and stop a GNUnet peer::
-
Using GNUnet
* Checking the Installation::
@@ -139,8 +122,8 @@ Using GNUnet
* File-sharing::
* The GNU Name System::
* Using the Virtual Public Network::
-
address@hidden Configuration Handbook
+* The graphical configuration interface::
+* How to start and stop a GNUnet peer::
GNUnet Contributors Handbook
@@ -152,6 +135,7 @@ GNUnet Contributors Handbook
GNUnet Developer Handbook
* Developer Introduction::
+* Internal dependencies::
* Code overview::
* System Architecture::
* Subsystem stability::
@@ -159,6 +143,7 @@ GNUnet Developer Handbook
* Build-system::
* Developing extensions for GNUnet using the gnunet-ext template::
* Writing testcases::
+* Building GNUnet and its dependencies::
* TESTING library::
* Performance regression analysis with Gauger::
* TESTBED Subsystem::
@@ -199,20 +184,10 @@ GNUnet Developer Handbook
@include chapters/philosophy.texi
@c *********************************************************************
address@hidden WIP:
address@hidden @include chapters/vocabulary.texi
-
address@hidden
*********************************************************************
address@hidden chapters/installation.texi
address@hidden
*********************************************************************
-
@c *********************************************************************
@include chapters/user.texi
@c *********************************************************************
address@hidden WIP:
address@hidden @include chapters/configuration.texi
-
@include chapters/contributing.texi
@c *********************************************************************
diff --git a/doc/system_specific/FROM_SOURCE b/doc/system_specific/FROM_SOURCE
new file mode 100644
index 000000000..074b6a91e
--- /dev/null
+++ b/doc/system_specific/FROM_SOURCE
@@ -0,0 +1,1423 @@
address@hidden Build instructions for Ubuntu 12.04 using Git
address@hidden Build instructions for Ubuntu 12.04 using Git
+
address@hidden
+* Install the required build tools::
+* Install libgcrypt 1.6 and libgpg-error::
+* Install gnutls with DANE support::
+* Install libgnurl::
+* Install libmicrohttpd from Git::
+* Install libextractor from Git::
+* Install GNUnet dependencies::
+* Build GNUnet::
+* Install the GNUnet-gtk user interface from Git::
address@hidden menu
+
address@hidden Install the required build tools
address@hidden Install the required build tools
+
+First, make sure Git is installed on your system:
+
address@hidden
+$ sudo apt-get install git
address@hidden example
+
+Install the essential buildtools:
+
address@hidden
+$ sudo apt-get install automake autopoint autoconf libtool
address@hidden example
+
address@hidden Install libgcrypt 1.6 and libgpg-error
address@hidden Install libgcrypt 1.6 and libgpg-error
+
address@hidden source installation - libgpg-error}
+
address@hidden Install gnutls with DANE support
address@hidden Install gnutls with DANE support
+
address@hidden @bullet
address@hidden @ref{generic source installation - nettle}
address@hidden @ref{generic source installation - ldns}
address@hidden @ref{generic source installation - libunbound/unbound}
address@hidden @ref{generic source installation - gnutls}
address@hidden @ref{generic source installation - libgcrypt}
address@hidden itemize
+
address@hidden Install libgnurl
address@hidden Install libgnurl
+
+Follow the @ref{generic source installation - libgnurl}.
+
address@hidden Install libmicrohttpd from Git
address@hidden Install libmicrohttpd from Git
+
address@hidden
+$ git clone https://gnunet.org/git/libmicrohttpd
+$ cd libmicrohttpd/
+$ ./bootstrap
+$ ./configure
+$ sudo make install ; cd ..
address@hidden example
+
address@hidden Install libextractor from Git
address@hidden Install libextractor from Git
+
+Install libextractor dependencies:
+
address@hidden
+$ sudo apt-get install zlib1g-dev libgsf-1-dev libmpeg2-4-dev \
+ libpoppler-dev libvorbis-dev libexiv2-dev libjpeg-dev \
+ libtiff-dev libgif-dev libvorbis-dev libflac-dev libsmf-dev \
+ g++
address@hidden example
+
+Build libextractor:
+
address@hidden
+$ git clone https://gnunet.org/git/libextractor
+$ cd libextractor
+$ ./bootstrap
+$ ./configure
+$ sudo make install ; cd ..
address@hidden example
+
address@hidden Install GNUnet dependencies
address@hidden Install GNUnet dependencies
+
address@hidden
+$ sudo apt-get install libidn11-dev libunistring-dev libglpk-dev \
+ libpulse-dev libbluetooth-dev libsqlite-dev
address@hidden example
+
+Install libopus:
+
address@hidden
+$ wget http://downloads.xiph.org/releases/opus/opus-1.1.tar.gz
+$ tar xf opus-1.1.tar.gz
+$ cd opus-1.1/
+$ ./configure
+$ sudo make install ; cd ..
address@hidden example
+
+Choose one or more database backends:
+
+SQLite3:
address@hidden
+$ sudo apt-get install libsqlite3-dev
address@hidden example
+MySQL:
address@hidden
+$ sudo apt-get install libmysqlclient-dev
address@hidden example
+PostgreSQL:
address@hidden
+$ sudo apt-get install libpq-dev postgresql
address@hidden example
+
+
+
address@hidden Build GNUnet
address@hidden Build GNUnet
+
+
+
address@hidden
+* Configuring the installation path::
+* Configuring the system::
+* Installing components requiring sudo permission::
+* Build::
address@hidden menu
+
address@hidden Configuring the installation path
address@hidden Configuring the installation path
+
+You can specify the location of the GNUnet installation by setting the
+prefix when calling the configure script with @code{--prefix=DIRECTORY}
+
address@hidden
+$ export PATH=$PATH:DIRECTORY/bin
address@hidden example
+
address@hidden Configuring the system
address@hidden Configuring the system
+
+Please make sure NOW that you have created a user and group 'gnunet'
+and additionally a group 'gnunetdns':
+
address@hidden
+$ sudo addgroup gnunet
+$ sudo addgroup gnunetdns
+$ sudo adduser gnunet
address@hidden example
+
+Each GNUnet user should be added to the 'gnunet' group (may
+require fresh login to come into effect):
+
address@hidden
+$ sudo useradd -G gnunet
address@hidden example
+
address@hidden Installing components requiring sudo permission
address@hidden Installing components requiring sudo permission
+
+Some components, like the nss plugin required for GNS, may require root
+permissions. To allow these few components to be installed use:
+
address@hidden
+$ ./configure --with-sudo
address@hidden example
+
address@hidden Build
address@hidden Build
+
address@hidden
+$ git clone https://gnunet.org/git/gnunet/
+$ cd gnunet/
+$ ./bootstrap
address@hidden example
+
+Use the required configure call including the optional installation prefix
address@hidden or the sudo permissions:
+
address@hidden
+$ ./configure [ --with-sudo | --with-prefix=PREFIX ]
address@hidden example
+
address@hidden
+$ make; sudo make install
address@hidden example
+
+After installing it, you need to create an empty configuration file:
+
address@hidden
+mkdir ~/.gnunet; touch ~/.gnunet/gnunet.conf
address@hidden example
+
+And finally you can start GNUnet with:
+
address@hidden
+$ gnunet-arm -s
address@hidden example
+
address@hidden Install the GNUnet-gtk user interface from Git
address@hidden Install the GNUnet-gtk user interface from Git
+
+
+Install depencies:
+
address@hidden
+$ sudo apt-get install libgtk-3-dev libunique-3.0-dev libgladeui-dev \
+ libqrencode-dev
address@hidden example
+
+Build GNUnet (with an optional prefix) and execute:
+
address@hidden
+$ git clone https://gnunet.org/git/gnunet-gtk/
+$ cd gnunet-gtk/
+$ ./bootstrap
+$ ./configure [--prefix=PREFIX] --with-gnunet=DIRECTORY
+$ make; sudo make install
address@hidden example
+
address@hidden Build Instructions for Microsoft Windows Platforms
address@hidden Build Instructions for Microsoft Windows Platforms
+
address@hidden
+* Introduction to building on MS Windows::
+* Requirements::
+* Dependencies & Initial Setup::
+* GNUnet Installation::
+* Adjusting Windows for running and testing GNUnet::
+* Building the GNUnet Installer::
+* Using GNUnet with Netbeans on Windows::
address@hidden menu
+
address@hidden Introduction to building on MS Windows
address@hidden Introduction to building on MS Windows
+
+
+This document is a guide to building GNUnet and its dependencies on
+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.
+
address@hidden Requirements
address@hidden Requirements
+
+The Howto is based upon a @strong{Windows Server 2008 32bit}
address@hidden, @strong{sbuild} and thus a
address@hidden://www.mingw.org/wiki/MSYS, MSYS+MinGW}
+(W32-GCC-Compiler-Suite + Unix-like Userland) installation. sbuild
+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 these instructions,
+GNUnet @strong{requires} a Windows @strong{Server} 2003 or
+newer for full feature support.
+Windows Vista and later will also work, but
address@hidden version can not run a VPN-Exit-Node} as the NAT
+features have been removed as of Windows Vista.
+
address@hidden TODO: We should document Windows 10!
address@hidden It seems like the situation hasn't changed with W10
+
address@hidden Dependencies & Initial Setup
address@hidden Dependencies & Initial Setup
+
+
address@hidden @bullet
+
address@hidden
+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 is currently incompatible.
+
address@hidden
+Install your favorite @uref{http://code.google.com/p/tortoisegit/, git} &
address@hidden://tortoisesvn.net/, subversion}-clients.
+
address@hidden
+You will also need some archive-manager like
address@hidden://www.7-zip.org/, 7zip}.
+
address@hidden
+Pull a copy of sbuild to a directory of your choice, which will be used
+in the remainder of this guide. For now, we will use
address@hidden:\gnunet\sbuild\}
+
address@hidden
+in @file{sbuild\src\mingw\mingw32-buildall.sh}, comment out the packages
address@hidden and @strong{gnunet-gtk-svn}, as we don't want sbuild
+to compile/install those for us.
+
address@hidden
+Follow LRN's sbuild installation instructions.-
address@hidden itemize
+
+Please note that sbuild may (or will most likely) fail during
+installation, thus you really HAVE to @strong{check the logfiles} created
+during the installation process.
+Certain packages may fail to build initially due to missing dependencies,
+thus you may have to
address@hidden those with binary-versions initially}. Later on once
+dependencies are satisfied you can re-build the newer package versions.
+
address@hidden is normal that you may have to repeat this step multiple times
+and there is no uniform way to fix all compile-time issues, as the
+build-process of many of the dependencies installed are rather unstable
+on win32 and certain releases may not even compile at all.}
+
+Most dependencies for GNUnet have been set up by sbuild, thus we now
+should add the @file{bin/} directories in your new msys and mingw
+installations to PATH. You will want to create a backup of your finished
+msys-environment by now.
+
address@hidden GNUnet Installation
address@hidden GNUnet Installation
+
+First, we need to launch our msys-shell, you can do this via
+
address@hidden:\gnunet\sbuild\msys\msys.bat}
+
+You might wish to take a look at this file and adjust some
+login-parameters to your msys environment.
+
+Also, sbuild added two pointpoints to your msys-environment, though those
+might remain invisible:
+
address@hidden @bullet
+
address@hidden
+/mingw, which will mount your mingw-directory from sbuild/mingw and the
+other one is
+
address@hidden
+/src which contains all the installation sources sbuild just compiled.
address@hidden itemize
+
+Check out the current GNUnet sources (git HEAD) from the
+GNUnet repository "gnunet.git", we will do this in your home directory:
+
address@hidden clone https://gnunet.org/git/gnunet/ ~/gnunet}
+
+Now, we will first need to bootstrap the checked out installation and then
+configure it accordingly.
+
address@hidden
+cd ~/gnunet
+./bootstrap
+STRIP=true CPPFLAGS="-DUSE_IPV6=1 -DW32_VEH" CFLAGS="$CFLAGS -g -O2" \
+./configure --prefix=/ --docdir=/share/doc/gnunet \
+--with-libiconv-prefix=/mingw --with-libintl-prefix=/mingw \
+--with-libcurl=/mingw --with-extractor=/mingw --with-sqlite=/mingw \
+--with-microhttpd=/mingw --with-plibc=/mingw --enable-benchmarks \
+--enable-expensivetests --enable-experimental --with-qrencode=/mingw \
+--enable-silent-rules --enable-experimental 2>&1 | tee -a ./configure.log
address@hidden example
+
+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
+the /mingw subdirectory, so remember to prefix library locations with
+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
+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,
+so you may fetch yourself a coffee or some Mate now...
+
address@hidden
+make ; make install
address@hidden example
+
address@hidden Adjusting Windows for running and testing GNUnet
address@hidden Adjusting Windows for running and testing GNUnet
+
+Assuming the build succeeded and you
address@hidden 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 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).
+
address@hidden Building the GNUnet Installer
address@hidden Building the GNUnet Installer
+
+The GNUnet installer is made with
address@hidden://nsis.sourceforge.net/, NSIS}.
+The installer script is located in @file{contrib\win} in the
+GNUnet source tree.
+
address@hidden Using GNUnet with Netbeans on Windows
address@hidden Using GNUnet with Netbeans on Windows
+
+TODO
+
address@hidden Build instructions for Debian 7.5
address@hidden Build instructions for Debian 7.5
+
+
+These are the installation instructions for Debian 7.5. They were tested
+using a minimal, fresh Debian 7.5 AMD64 installation without non-free
+software (no contrib or non-free).
+By "minimal", we mean that during installation, we did not select any
+desktop environment, servers or system utilities during the "tasksel"
+step. Note that the packages and the dependencies that we will install
+during this chapter take about 1.5 GB of disk space.
+Combined with GNUnet and space for objects during compilation, you should
+not even attempt this unless you have about 2.5 GB free after the minimal
+Debian installation.
+Using these instructions to build a VM image is likely to require a
+minimum of 4-5 GB for the VM (as you will likely also want a desktop
+manager).
+
+GNUnet's security model assumes that your @file{/home} directory is
+encrypted. Thus, if possible, you should encrypt your home partition
+(or per-user home directory).
+
+Naturally, the exact details of the starting state for your installation
+should not matter much. For example, if you selected any of those
+installation groups you might simply already have some of the necessary
+packages installed.
+We did this for testing, as this way we are less likely to forget to
+mention a required package.
+Note that we will not install a desktop environment, but of course you
+will need to install one to use GNUnet's graphical user interfaces.
+Thus, it is suggested that you simply install the desktop environment of
+your choice before beginning with the instructions.
+
+
+
address@hidden
+* Update::
+* Stable? Hah!::
+* Update again::
+* Installing packages::
+* Installing dependencies from source::
+* Installing GNUnet from source::
+* But wait there is more!::
address@hidden menu
+
address@hidden Update
address@hidden Update
+
+After any installation, you should begin by running
+
address@hidden
+# apt-get update ; apt-get upgrade
address@hidden example
+
+to ensure that all of your packages are up-to-date. Note that the "#" is
+used to indicate that you need to type in this command as "root"
+(or prefix with "sudo"), whereas "$" is used to indicate typing in a
+command as a normal user.
+
address@hidden Stable? Hah!
address@hidden Stable? Hah!
+
+Yes, we said we start with a Debian 7.5 "stable" system. However, to
+reduce the amount of compilation by hand, we will begin by allowing the
+installation of packages from the testing and unstable distributions as
+well.
+We will stick to "stable" packages where possible, but some packages will
+be taken from the other distributions.
+Start by modifying @file{/etc/apt/sources.list} to contain the
+following (possibly adjusted to point to your mirror of choice):
+
address@hidden
+# These were there before:
+deb http://ftp.de.debian.org/debian/ wheezy main
+deb-src http://ftp.de.debian.org/debian/ wheezy main
+deb http://security.debian.org/ wheezy/updates main
+deb-src http://security.debian.org/ wheezy/updates main
+deb http://ftp.de.debian.org/debian/ wheezy-updates main
+deb-src http://ftp.de.debian.org/debian/ wheezy-updates main
+
+# Add these lines (feel free to adjust the mirror):
+deb http://ftp.de.debian.org/debian/ testing main
+deb http://ftp.de.debian.org/debian/ unstable main
address@hidden example
+
+The next step is to create/edit your @file{/etc/apt/preferences}
+file to look like this:
+
address@hidden
+Package: *
+Pin: release a=stable,n=wheezy
+Pin-Priority: 700
+
+Package: *
+Pin: release o=Debian,a=testing
+Pin-Priority: 650
+
+Package: *
+Pin: release o=Debian,a=unstable
+Pin-Priority: 600
address@hidden example
+
+You can read more about Apt Preferences here and here.
+Note that other pinnings are likely to also work for GNUnet, the key
+thing is that you need some packages from unstable (as shown below).
+However, as unstable is unlikely to be comprehensive (missing packages)
+or might be problematic (crashing packages), you probably want others
+from stable and/or testing.
+
address@hidden Update again
address@hidden Update again
+
+Now, run again@
+
address@hidden
+# apt-get update@
+# apt-get upgrade@
address@hidden example
+
+to ensure that all your new distribution indices are downloaded, and
+that your pinning is correct: the upgrade step should cause no changes
+at all.
+
address@hidden Installing packages
address@hidden Installing packages
+
+We begin by installing a few Debian packages from stable:@
+
address@hidden
+# 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 libexiv2-dev libflac-dev libgif-dev libglib2.0-dev \
+ libgtk-3-dev libmagic-dev libjpeg8-dev libmpeg2-4-dev libmp4v2-dev \
+ librpm-dev libsmf-dev libtidy-dev libtiff5-dev libvorbis-dev \
+ libogg-dev zlib1g-dev g++ gettext libgsf-1-dev libunbound-dev \
+ libqrencode-dev libgladeui-dev nasm texlive-latex-extra \
+ libunique-3.0-dev gawk miniupnpc libfuse-dev libbluetooth-dev
address@hidden example
+
+After that, we install a few more packages from unstable:@
+
address@hidden
+# apt-get install -t unstable nettle-dev libgstreamer1.0-dev \
+ gstreamer1.0-plugins-base gstreamer1.0-plugins-good \
+ libgstreamer-plugins-base1.0-dev
address@hidden example
+
address@hidden Installing dependencies from source
address@hidden Installing dependencies from source
+
+Next, we need to install a few dependencies from source.
+You might want to do this as a "normal" user and only run the
address@hidden 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.
+
+For these steps, follow the instructions given in the
+installation from source instruction in this order:
+
address@hidden @bullet
address@hidden @ref{generic source installation - libav}
address@hidden @ref{generic source installation - libextractor}
address@hidden @ref{generic source installation - libgpg-error}
address@hidden @ref{generic source installation - libgcrypt}
address@hidden @ref{generic source installation - gnutls}
address@hidden @ref{generic source installation - libmicrohttpd}
address@hidden @ref{generic source installation - libgnurl}
address@hidden itemize
+
address@hidden Installing GNUnet from source
address@hidden Installing GNUnet from source
+
+
+For this, simply follow the generic installation instructions from
+here.
+
address@hidden But wait there is more!
address@hidden But wait there is more!
+
+So far, we installed all of the packages and dependencies required to
+ensure that all of GNUnet would be built.
+However, while for example the plugins to interact with the MySQL or
+Postgres databases have been created, we did not actually install or
+configure those databases. Thus, you will need to install
+and configure those databases or stick with the default Sqlite database.
+Sqlite is usually fine for most applications, but MySQL can offer better
+performance and Postgres better resillience.
+
+
address@hidden Installing GNUnet from Git on Ubuntu 14.4
address@hidden Installing GNUnet from Git on Ubuntu 14.4
+
address@hidden the required build tools:}
+
address@hidden
+$ sudo apt-get install git automake autopoint autoconf
address@hidden example
+
address@hidden the required dependencies}
+
address@hidden
+$ sudo apt-get install libltdl-dev libgpg-error-dev libidn11-dev \
+ libunistring-dev libglpk-dev libbluetooth-dev libextractor-dev \
+ libmicrohttpd-dev libgnutls28-dev
address@hidden example
+
address@hidden one or more database backends}
+
address@hidden @bullet
+
address@hidden SQLite3:
+
address@hidden
+$ sudo apt-get install libsqlite3-dev
address@hidden example
+
address@hidden MySQL:
+
address@hidden
+$ sudo apt-get install libmysqlclient-dev
address@hidden example
+
address@hidden PostgreSQL:
+
address@hidden
+$ sudo apt-get install libpq-dev postgresql
address@hidden example
+
address@hidden itemize
+
address@hidden the optional dependencies for gnunet-conversation:}
+
address@hidden
+$ sudo apt-get install gstreamer1.0 libpulse-dev libopus-dev
address@hidden example
+
address@hidden the libgrypt 1.6.1:}
+
address@hidden @bullet
+
address@hidden For Ubuntu 14.04:
+
address@hidden
+$ sudo apt-get install libgcrypt20-dev
address@hidden example
+
address@hidden For Ubuntu older 14.04:
+
address@hidden
+$ wget ftp://ftp.gnupg.org/gcrypt/libgcrypt/libgcrypt-1.6.1.tar.bz2
+$ tar xf libgcrypt-1.6.1.tar.bz2
+$ cd libgcrypt-1.6.1
+$ ./configure
+$ sudo make install
+$ cd ..
address@hidden example
+
address@hidden itemize
+
address@hidden libgnurl}
+
address@hidden GNUnet}
+
address@hidden
+$ git clone https://gnunet.org/git/gnunet/
+$ cd gnunet/
+$ ./bootstrap
address@hidden example
+
+If you want to:
+
address@hidden @bullet
+
address@hidden Install to a different directory:
+
address@hidden
+--prefix=PREFIX
address@hidden example
+
address@hidden
+Have sudo permission, but do not want to compile as root:
+
address@hidden
+--with-sudo
address@hidden example
+
address@hidden
+Want debug message enabled:
+
address@hidden
+--enable-logging=verbose
address@hidden example
+
address@hidden itemize
+
+
address@hidden
+$ ./configure [ --with-sudo | --prefix=PREFIX | --enable-logging=verbose]
+$ make; sudo make install
address@hidden example
+
+After installing it, you need to create an empty configuration file:
+
address@hidden
+touch ~/.config/gnunet.conf
address@hidden example
+
+And finally you can start GNUnet with
+
address@hidden
+$ gnunet-arm -s
address@hidden example
+
address@hidden Build instructions for Debian 8
address@hidden Build instructions for Debian 8
address@hidden 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
+contrib or non-free). During installation, I only selected "lxde" for the
+desktop environment.
+Note that the packages and the dependencies that we will install during
+this chapter take about 1.5 GB of disk space. Combined with GNUnet and
+space for objects during compilation, you should not even attempt this
+unless you have about 2.5 GB free after the Debian installation.
+Using these instructions to build a VM image is likely to require a
+minimum of 4-5 GB for the VM (as you will likely also want a desktop
+manager).
+
+GNUnet's security model assumes that your @code{/home} directory is
+encrypted.
+Thus, if possible, you should encrypt your entire disk, or at least just
+your home partition (or per-user home directory).
+
+Naturally, the exact details of the starting state for your installation
+should not matter much.
+For example, if you selected any of those installation groups you might
+simply already have some of the necessary packages installed. Thus, it is
+suggested that you simply install the desktop environment of your choice
+before beginning with the instructions.
+
+
address@hidden
+* Update Debian::
+* Installing Debian Packages::
+* Installing Dependencies from Source2::
+* Installing GNUnet from Source2::
+* But wait (again) there is more!::
address@hidden menu
+
address@hidden Update Debian
address@hidden Update Debian
+
+After any installation, you should begin by running
+
address@hidden
+# apt-get update
+# apt-get upgrade
address@hidden example
+
+to ensure that all of your packages are up-to-date. Note that the "#" is
+used to indicate that you need to type in this command as "root" (or
+prefix with "sudo"), whereas "$" is used to indicate typing in a command
+as a normal user.
+
address@hidden Installing Debian Packages
address@hidden Installing Debian Packages
+
+We begin by installing a few Debian packages from stable:
+
address@hidden
+# 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 \
+libtidy-dev libvorbis-dev libogg-dev zlib1g-dev g++ gettext \
+libgsf-1-dev libunbound-dev libqrencode-dev libgladeui-dev nasm \
+texlive-latex-extra libunique-3.0-dev gawk miniupnpc libfuse-dev \
+libbluetooth-dev gstreamer1.0-plugins-base gstreamer1.0-plugins-good \
+libgstreamer-plugins-base1.0-dev nettle-dev libextractor-dev \
+libgcrypt20-dev libmicrohttpd-dev
address@hidden example
+
address@hidden Installing Dependencies from Source2
address@hidden Installing Dependencies from Source2
+
+Yes, we said we start with a Debian 8 "stable" system, but because Debian
+linked GnuTLS without support for DANE, we need to compile a few things,
+in addition to GNUnet, still by hand. Yes, you can run GNUnet using the
+respective Debian packages, but then you will not get DANE support.
+
+Next, we need to install a few dependencies from source. You might want
+to do this as a "normal" user and only run the @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:
+
address@hidden
+$ wget ftp://ftp.gnutls.org/gcrypt/gnutls/v3.3/gnutls-3.3.12.tar.xz
+$ tar xvf gnutls-3.3.12.tar.xz
+$ cd gnutls-3.3.12 ; ./configure ; make ; sudo make install ; cd ..
address@hidden example
+
+For the installation and compilation of libgnurl/gnURL refer to
+the generic installation section,
address@hidden source installation - libgnurl}.
+
address@hidden Installing GNUnet from Source2
address@hidden Installing GNUnet from Source2
+
+For this, simply follow the generic installation instructions from@
+here.
+
address@hidden But wait (again) there is more!
address@hidden But wait (again) there is more!
+
+So far, we installed all of the packages and dependencies required to
+ensure that all of GNUnet would be built. However, while for example the
+plugins to interact with the MySQL or Postgres databases have been
+created, we did not actually install or configure those databases.
+Thus, you will need to install and configure those databases or stick
+with the default Sqlite database. Sqlite is usually fine for most
+applications, but MySQL can offer better performance and Postgres better
+resillience.
+
address@hidden Build instructions for macOS
address@hidden Build instructions for macOS
address@hidden FIXME: I -> we
+
+These are the installation guidelines for macOS.
+They were tested on macOS High Sierra.
+
address@hidden
+* Installing dependencies::
+* Compile from Source::
address@hidden menu
+
address@hidden Installing dependencies
address@hidden Installing dependencies
+
+First, install XCode in the newest version.
+See https://developer.apple.com/xcode/.
+
+Install Homebrew (https://brew.sh) and then install the dependencies listed
above.
+If a dependency does not exists in brew, you need to compile it from source.
+
address@hidden
+# brew install <dependency>
address@hidden example
+
address@hidden Compile from Source
address@hidden Compile from Source
+
+Before you start building GNUnet, you need to setup your environment.
+This means that you have to make sure the proper tools are used in the build
process.
+For example, after installing texinfo you need to make sure the new texinfo is
actually used:
+
address@hidden
+# echo 'export PATH="/usr/local/opt/texinfo/bin:$PATH"' >> ~/.bash_profile
address@hidden example
+
+Note: brew tells you the appropriate command when executing
+
address@hidden
+# brew info texinfo
address@hidden example
+
+This may also be necessary for the gettext package.
+
+Before you start compiling, you need to make sure gcc is used and not the
clang compile of your macOS system.
+On my system, gcc was actually ``gcc-7'' and gcc pointed to the clang compiler.
+
address@hidden
+# export CC=gcc-7
address@hidden example
+
+After this the standard compile instructions apply.
+
address@hidden @node Build instructions for OpenBSD 6.2
address@hidden @section Build instructions for OpenBSD 6.2
+
address@hidden Outdated build instructions for previous revisions
address@hidden Outdated build instructions for previous revisions
+
+This chapter contains a collection of outdated, older installation guides.
+They are mostly intended to serve as a starting point for writing
+up-to-date instructions and should not be expected to work for
+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 tree of GNUnet.
+
+This file covers old instructions which no longer receive security
+updates or any kind of support.
+
address@hidden
+* Installing GNUnet 0.10.1 on Ubuntu 14.04::
+* Building GLPK for MinGW::
+* GUI build instructions for Ubuntu 12.04 using Subversion::
address@hidden * Installation with gnunet-update::
+* Instructions for Microsoft Windows Platforms (Old)::
address@hidden menu
+
+
address@hidden Installing GNUnet 0.10.1 on Ubuntu 14.04
address@hidden Installing GNUnet 0.10.1 on Ubuntu 14.04
+
+Install the required dependencies:
+
address@hidden
+$ sudo apt-get install libltdl-dev libgpg-error-dev libidn11-dev \
+ libunistring-dev libglpk-dev libbluetooth-dev libextractor-dev \
+ libmicrohttpd-dev libgnutls28-dev
address@hidden example
+
+Choose one or more database backends:
+
address@hidden @bullet
+
address@hidden SQLite3
+
address@hidden
+ $ sudo apt-get install libsqlite3-dev@
address@hidden example
+
address@hidden MySQL
+
address@hidden
+$ sudo apt-get install libmysqlclient-dev@
address@hidden example
+
address@hidden PostgreSQL
+
address@hidden
+ $ sudo apt-get install libpq-dev postgresql@
address@hidden example
+
address@hidden itemize
+
+Install the optional dependencies for gnunet-conversation:
+
address@hidden
+ $ sudo apt-get install gstreamer1.0 libpulse-dev libopus-dev
address@hidden example
+
+Install libgcrypt 1.6:
+
address@hidden @bullet
+
address@hidden For Ubuntu 14.04:
+
address@hidden
+$ sudo apt-get install libgcrypt20-dev
address@hidden example
+
address@hidden For Ubuntu older than 14.04:
+
address@hidden
+wget ftp://ftp.gnupg.org/gcrypt/libgcrypt/libgcrypt-1.6.1.tar.bz2
+$ tar xf libgcrypt-1.6.1.tar.bz2
+$ cd libgcrypt-1.6.1
+$ ./configure
+$ sudo make install
+$ cd ..
address@hidden example
address@hidden itemize
+
+Install libgnurl:
+
address@hidden source installation - libgnurl}.
+
+Install GNUnet:
+
address@hidden
+$ wget http://ftpmirror.gnu.org/gnunet/gnunet-0.10.1.tar.gz
+$ tar xf gnunet-0.10.1.tar.gz
+$ cd gnunet-0.10.1
address@hidden example
+
+If you want to:
+
address@hidden @bullet
+
address@hidden
+Install to a different directory:
+
address@hidden
+--prefix=PREFIX
address@hidden example
+
address@hidden
+Have sudo permission, but do not want to compile as root:
+
address@hidden
+--with-sudo
address@hidden example
+
address@hidden
+Want debug message enabled:
+
address@hidden
+--enable-logging=verbose
address@hidden example
+
address@hidden itemize
+
address@hidden
+$ ./configure [ --with-sudo | --prefix=PREFIX | --enable-logging=verbose]
+$ make; sudo make install
address@hidden example
+
+After installing it, you need to create an empty configuration file:
+
address@hidden
+touch ~/.config/gnunet.conf
address@hidden example
+
+And finally you can start GNUnet with
+
address@hidden
+$ gnunet-arm -s
address@hidden example
+
address@hidden Building GLPK for MinGW
address@hidden Building GLPK for MinGW
+
+GNUnet now requires the GNU Linear Programming Kit (GLPK).
+Since there's is no package you can install with @code{mingw-get} you
+have to compile it from source:
+
address@hidden @bullet
+
address@hidden Download the latest version from
address@hidden://ftp.gnu.org/gnu/glpk/}
+
address@hidden Unzip the downloaded source tarball using your favourite
+unzipper application In the MSYS shell
+
address@hidden change to the respective directory
+
address@hidden Configure glpk for "i686-pc-mingw32":
+
address@hidden
+./configure '--build=i686-pc-mingw32'
address@hidden example
+
address@hidden run
+
address@hidden
+make install check
address@hidden example
+
address@hidden itemize
+
+MinGW does not automatically detect the correct buildtype so you have to
+specify it manually.
+
+
address@hidden GUI build instructions for Ubuntu 12.04 using Subversion
address@hidden GUI build instructions for Ubuntu 12.04 using Subversion
+
+After installing GNUnet you can continue installing the GNUnet GUI tools:
+
+First, install the required dependencies:
+
address@hidden
+$ sudo apt-get install libgladeui-dev libqrencode-dev
address@hidden 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
+
address@hidden @bullet
+
address@hidden set the environmental variable permanently to:
+
address@hidden
+LD_LIBRARY_PATH=$GNUNET_PREFIX
address@hidden example
+
address@hidden or add @code{$GNUNET_PREFIX} to @file{/etc/ld.so.conf}
+
address@hidden itemize
+
+Now you can checkout and compile the GNUnet GUI tools:
+
address@hidden
+$ git clone https://gnunet.org/git/gnunet-gtk
+$ cd gnunet-gtk
+$ ./bootstrap
+$ ./configure --prefix=$GNUNET_PREFIX/.. --with-gnunet=$GNUNET_PREFIX/..
+$ make install
address@hidden example
+
address@hidden Instructions for Microsoft Windows Platforms (Old)
address@hidden Instructions for Microsoft Windows Platforms (Old)
+
+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.
+
+The Windows build uses a UNIX emulator for Windows,
address@hidden://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 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.
+
address@hidden
+* Hardware and OS requirements::
+* Software installation::
+* Building libextractor and GNUnet::
+* Installer::
+* Source::
address@hidden menu
+
address@hidden Hardware and OS requirements
address@hidden Hardware and OS requirements
+
address@hidden @bullet
address@hidden Pentium II or equivalent processor, @geq{} 350 MHz
address@hidden 128 MB RAM
address@hidden 600 MB free disk space
address@hidden Windows 2000 or Windows XP are recommended
address@hidden itemize
+
address@hidden Software installation
address@hidden Software installation
+
address@hidden @bullet
+
address@hidden
address@hidden software}@
+
+The software packages GNUnet depends on are usually compressed using UNIX
+tools like @command{tar}, @command{gzip}, @command{xzip} and
address@hidden
+If you do not already have an utility that is able to extract such
+archives, get @uref{http://www.7-zip.org/, 7-Zip}.
+
address@hidden
address@hidden environment}@
+
+The MinGW project provides the compiler toolchain that is used to build
+GNUnet.
+Get the following packages from the
address@hidden://sourceforge.net/projects/mingw/files/, MinGW} project:
+
address@hidden @bullet
+
address@hidden GCC core
address@hidden GCC g++
address@hidden MSYS
address@hidden MSYS Developer Tool Kit (msysDTK)
address@hidden MSYS Developer Tool Kit - msys-autoconf (bin)
address@hidden MSYS Developer Tool Kit - msys-automake (bin)
address@hidden MinGW Runtime
address@hidden MinGW Utilities
address@hidden Windows API
address@hidden Binutils
address@hidden make
address@hidden pdcurses
address@hidden GDB (snapshot)
address@hidden itemize
+
address@hidden @bullet
+
+
address@hidden 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}.
+
address@hidden Install MinGW runtime, utilities and GCC to a subdirectory
+(to @file{c:\mingw\mingw}, for example)
+
address@hidden Install the Development Kit to the MSYS directory
+(@file{c:\mingw})
+
address@hidden Create a batch file bash.bat in your MSYS directory with
+the files:
+
address@hidden
+bin\sh.exe --login
address@hidden example
+
+This batch file opens a shell which is used to invoke the build
+processes.
+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.
+
address@hidden
+Start @command{bash.sh} and rename
address@hidden:\mingw\mingw\lib\libstdc++.la} to avoid problems:
+
address@hidden
+mv /usr/mingw/lib/libstdc++.la /usr/mingw/lib/libstdc++.la.broken
address@hidden example
+
address@hidden
+Unpack the Windows API to the MinGW directory (@file{c:\mingw\mingw\}) and
+remove the declaration of DATADIR from
+(@file{c:\mingw\mingw\include\objidl.h} (lines 55-58)
+
address@hidden
+Unpack autoconf, automake to the MSYS directory (@file{c:\mingw})
+
address@hidden
+Install all other packages to the MinGW directory (@file{c:\mingw\mingw\})
address@hidden itemize
+
+
address@hidden @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})
+
address@hidden @strong{Pthreads}@
+GNUnet uses the portable POSIX thread library for multi-threading:
+
address@hidden @bullet
+
address@hidden Save
address@hidden://sources.redhat.com/pub/pthreads-win32/dll-latest/lib/x86/libpthreadGC2.a,
libpthreadGC2.a}
+(x86) or
address@hidden://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}).
+
address@hidden Save
address@hidden://sources.redhat.com/pub/pthreads-win32/dll-latest/lib/x86/pthreadGC2.dll,
pthreadGC2.dll}
+(x86) or
address@hidden://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}).
+
address@hidden Download all header files from
address@hidden://sources.redhat.com/pub/pthreads-win32/dll-latest/include/,
include/}
+to the @file{include} directory (@file{c:\mingw\mingw\include}).
address@hidden itemize
+
+
address@hidden @strong{GNU MP}@
+GNUnet uses the GNU Multiple Precision library for special cryptographic
+operations. Get the GMP binary package from the
address@hidden://sourceforge.net/projects/mingwrep/, MinGW repository} and
+unpack it to the MinGW directory (@file{c:\mingw\mingw})
+
address@hidden @strong{GNU Gettext}@
+GNU gettext is used to provide national language support.
+Get the prebuilt package from hereand unpack it to the MinGW
+directory (@file{c:\mingw\mingw})
+
address@hidden @strong{GNU iconv}@
+GNU Libiconv is used for character encoding conversion.
+Get the prebuilt package from here and unpack it to the MinGW
+directory (@file{c:\mingw\mingw}).
+
address@hidden @strong{SQLite}@
+GNUnet uses the SQLite database to store data.
+Get the prebuilt binary from here and unpack it to your MinGW directory.
+
address@hidden @strong{MySQL}@
+As an alternative to SQLite, GNUnet also supports MySQL.
+
address@hidden @bullet
+
address@hidden Get the binary installer from the
address@hidden://dev.mysql.com/downloads/mysql/4.1.html#Windows, MySQL project}
+(version 4.1), install it and follow the instructions in
address@hidden
+
address@hidden Create a temporary build directory (@file{c:\mysql})
+
address@hidden Copy the directories @file{include\} and @file{lib\} from the
+MySQL directory to the new directory
+
address@hidden Get the patches from
address@hidden://bugs.mysql.com/bug.php?id=8906&files=1, Bug #8906} and
address@hidden://bugs.mysql.com/bug.php?id=8872&files=1, Bug #8872} (the
+latter is only required for MySQL
+
address@hidden
+patch -p 0
address@hidden example
+
address@hidden Move @file{lib\opt\libmysql.dll} to @file{lib\libmysql.dll}
+
address@hidden Change to @file{lib\} and create an import library:
+
address@hidden
+dlltool --input-def ../include/libmySQL.def \
+--dllname libmysql.dll \
+--output-lib libmysqlclient.a -k
address@hidden example
+
address@hidden Copy include\* to include\mysql\
+
address@hidden Pass @code{--with-mysql=/c/mysql} to
address@hidden/configure} and copy @file{libmysql.dll}
+to your PATH or GNUnet's @file{bin} directory
address@hidden itemize
+
+
address@hidden @strong{GTK+}@
address@hidden and @command{libextractor} depend on GTK.
+Get the the binary and developer packages of @command{atk},
address@hidden, @command{gtk}, @command{iconv},
address@hidden, @command{pango} from
address@hidden://ftp.gtk.org/pub/gtk/v2.6/win32, gtk.org} and unpack them
+to the MinGW directory (@file{c:\mingw\mingw}).
address@hidden FIXME: The URL below for pkg-config seems wrong.
+Get @uref{http://www.gtk.org/download/win32.php, pkg-config} and
address@hidden and unpack them to the MinGW directory
+(@file{c:\mingw\mingw}).
+Here is an all-in-one package for the
address@hidden://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!
+
address@hidden @strong{Glade}@
address@hidden and @command{gnunet-setup} were created using
+this interface builder
+
address@hidden @bullet
+
address@hidden Get the Glade and libglade (-bin and -devel) packages
+(without GTK!) from
address@hidden://gladewin32.sourceforge.net/, GladeWin32} and unpack them to
+the MinGW directory (@file{c:\mingw\mingw}).
+
address@hidden Get @command{libxml} from here and unpack it to the MinGW
+directory (@file{c:\mingw\mingw}).
address@hidden itemize
+
address@hidden FIXME: URLs
address@hidden @strong{zLib}@
address@hidden 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}).
+
address@hidden @strong{Bzip2}@
address@hidden also requires @command{Bzip2} to
+decompress some file formats.
+Get the Bzip2 (binary and developer package) from
address@hidden://gnuwin32.sourceforge.net/packages/bzip2.htm, GnuWin32} and
+unpack it to the MinGW directory (@file{c:\mingw\mingw}).
+
address@hidden @strong{Libgcrypt}@
address@hidden 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
+(@file{c:\mingw\mingw}). Currently libgcrypt @geq{} 1.4.2 is required to
+compile GNUnet.
+
address@hidden @strong{PlibC}@
+PlibC emulates Unix functions under Windows. Get PlibC from here and
+unpack it to the MinGW directory (c:\mingw\mingw)
+
address@hidden @strong{OGG Vorbis}@
address@hidden Vorbis} is used to extract meta-data from @file{.ogg} files.
+Get the packages
address@hidden://www.gnunet.org/libextractor/download/win/libogg-1.1.4.zip,
libogg}
+and
address@hidden://www.gnunet.org/libextractor/download/win/libvorbis-1.2.3.zip,
libvorbis}
+from the
address@hidden://ftp.gnu.org/gnu/libextractor/libextractor-w32-1.0.0.zip,
libextractor win32 build}
+and unpack them to the MinGW directory (c:\mingw\mingw).
+
address@hidden @strong{Exiv2}@
+(lib)Exiv2 is used to extract meta-data from files with Exiv2 meta-data.
+Download
address@hidden://www.gnunet.org/libextractor/download/win/exiv2-0.18.2.zip,
Exiv2}
+and unpack it to the MSYS directory (c:\mingw).
address@hidden itemize
+
address@hidden Building libextractor and GNUnet
address@hidden Building libextractor and GNUnet
+
+Before you compile @command{libextractor} or @command{GNUnet},
+be sure to set @code{PKG_CONFIG_PATH}:
+
address@hidden
+export PKG_CONFIG_PATH=/mingw/lib/pkgconfig
address@hidden example
+
address@hidden
address@hidden Installation Handbook}, for basic instructions on building
address@hidden 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}:
+
address@hidden
+export CFLAGS='-O2 -march=pentium -fomit-frame-pointer'
+./configure --prefix=$HOME --with-extractor=$HOME
address@hidden example
+
address@hidden Installer
address@hidden Installer
+
+The GNUnet installer is made with
address@hidden://nsis.sourceforge.net/, NSIS}. The installer script is
+located in @file{contrib\win} in the GNUnet source tree.
+
address@hidden Source
address@hidden Source
+
address@hidden FIXME: URL... or: WHERE is HERE?
+The sources of all dependencies are available here.
diff --git a/doc/outdated-and-old-installation-instructions.txt
b/doc/system_specific/outdated-and-old-installation-instructions.txt
similarity index 100%
rename from doc/outdated-and-old-installation-instructions.txt
rename to doc/system_specific/outdated-and-old-installation-instructions.txt
diff --git a/guix-env.scm b/guix-env.scm
index 16fdc7528..d905ab716 100644
--- a/guix-env.scm
+++ b/guix-env.scm
@@ -96,10 +96,11 @@
("pulseaudio" ,pulseaudio)
("sqlite" ,sqlite)
("postgresql" ,postgresql)
- ("mysql" ,mysql)
+ ("mysql" ,mariadb)
("zlib" ,zlib)
("perl" ,perl)
("python-2" ,python-2) ; tests and gnunet-qr
+ ("python2-future" ,python2-future)
("jansson" ,jansson)
("nss" ,nss)
("glib" ,glib "bin")
--
To stop receiving notification emails like this one, please contact
address@hidden
- [GNUnet-SVN] [gnunet] branch master updated (8503c6fa2 -> 9417d4af8),
gnunet <=
- [GNUnet-SVN] [gnunet] 01/19: contrib: rename scripts/report.sh to scripts/gnunet-bugreport and install it., gnunet, 2018/06/13
- [GNUnet-SVN] [gnunet] 09/19: doc: create system specific folder and move files into it, gnunet, 2018/06/13
- [GNUnet-SVN] [gnunet] 04/19: gnunet-bugreport: GNUtls->GnuTLS, gnunet, 2018/06/13
- [GNUnet-SVN] [gnunet] 05/19: README rework part 1, gnunet, 2018/06/13
- [GNUnet-SVN] [gnunet] 11/19: Fix the link to the preliminary documentation, gnunet, 2018/06/13
- [GNUnet-SVN] [gnunet] 02/19: extend the list of known package maintainers, gnunet, 2018/06/13
- [GNUnet-SVN] [gnunet] 08/19: guix-env.scm: Add python2-future., gnunet, 2018/06/13
- [GNUnet-SVN] [gnunet] 10/19: README: Mention further reading material, gnunet, 2018/06/13
- [GNUnet-SVN] [gnunet] 03/19: Add GPL2 licensed openrc service file, gnunet, 2018/06/13
- [GNUnet-SVN] [gnunet] 13/19: doc: Add new files to Makefile., gnunet, 2018/06/13