diff options
author | Christian Grothoff <christian@grothoff.org> | 2021-06-24 14:40:56 +0200 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2021-06-24 14:40:56 +0200 |
commit | 80b4f8ab8671c84e8214c676c449fc14d5e12ad7 (patch) | |
tree | 2a021ae8f03970e0c3730b1a23563bc259e0098c | |
parent | 7ec40ddae6314f709147ce1da9c74d7d6cbd9cb0 (diff) | |
download | docs-80b4f8ab8671c84e8214c676c449fc14d5e12ad7.tar.gz docs-80b4f8ab8671c84e8214c676c449fc14d5e12ad7.tar.bz2 docs-80b4f8ab8671c84e8214c676c449fc14d5e12ad7.zip |
update anastasis installation instructions
-rw-r--r-- | anastasis.rst | 153 | ||||
-rw-r--r-- | frags/installing-anastasis-gtk.rst | 31 | ||||
-rw-r--r-- | frags/installing-anastasis.rst | 30 | ||||
-rw-r--r-- | frags/installing-gnunet-gtk.rst | 28 | ||||
-rw-r--r-- | frags/installing-taler-merchant.rst | 34 | ||||
-rw-r--r-- | taler-merchant-manual.rst | 35 |
6 files changed, 268 insertions, 43 deletions
diff --git a/anastasis.rst b/anastasis.rst index 803f16f8..00556b4b 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1,6 +1,6 @@ .. This file is part of Anastasis - Copyright (C) 2019. 2021 Anastasis SARL + Copyright (C) 2019-2021 Anastasis SARL Anastasis is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software @@ -69,15 +69,140 @@ guarding a user's secret. Weak adversaries must not be able to deduce information about a user's **recovery document** (except for its length, which may be exposed to an adversary which monitors the user's network traffic). -------------------- -Anastasis DB Schema -------------------- -.. image:: anastasis-db.png -.. image:: anastasis_challengecode.png -.. image:: anastasis_challenge_payment.png -.. image:: anastasis_truth.png -.. image:: anastasis_truth_payment.png +---------------------- +Anastasis Installation +---------------------- + +Please install the following packages before proceeding with the +exchange compilation. + +.. include:: frags/list-of-dependencies.rst + +- GNU Taler exchange + +- GNU Taler merchant backend + +Except for the last two, these are available in most GNU/Linux distributions +and should just be installed using the respective package manager. + + +Installing from source +---------------------- + +The following instructions will show how to install libgnunetutil and +the GNU Taler exchange from source. + +Installing GNUnet +^^^^^^^^^^^^^^^^^ + +.. include:: frags/installing-gnunet.rst + +Installing the Taler Exchange +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. include:: frags/installing-taler-exchange.rst + +Installing the Taler Merchant +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. include:: frags/installing-taler-merchant.rst + +Installing Anastasis +^^^^^^^^^^^^^^^^^^^^ + +.. include:: frags/installing-anastasis.rst + +Installing GNUnet-gtk +^^^^^^^^^^^^^^^^^^^^^ + +.. include:: frags/installing-gnunet-gtk.rst + +Installing Anastasis-gtk +^^^^^^^^^^^^^^^^^^^^^^^^ + +.. include:: frags/installing-anastasis-gtk.rst + + + +Installing Anastasis binary packages on Debian +---------------------------------------------- + +.. include:: frags/installing-debian.rst + + +Installing the graphical front-end +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +To install the Anastasis front-end, you can now simply run: +.. code-block:: console + + # apt install -t sid anastasis-gtk + +To use ``anastasis-gtk``, you can simply run: + +.. code-block:: console + + $ anastasis-gtk + +Installing the backend +^^^^^^^^^^^^^^^^^^^^^^ + +If you want to install the Anastasis backend-end (which normal users do not +need), you should run: + +.. code-block:: console + + # apt install -t sid anastasis-httpd + +Note that the latter package does not perform all of the configuration work. +It does setup the user users and the systemd service scripts, but you still +must configure the database backup, HTTP reverse proxy (typically with TLS +certificates), Taler merchant backend for payments, authentication services, +prices and the terms of service. + +Sample configuration files for the HTTP reverse proxy can be found in +``/etc/anastasis.conf``. + + +Installing Anastasis binary packages on Ubuntu +---------------------------------------------- + +.. include:: frags/installing-ubuntu.rst + +Installing the graphical front-end +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +To install the Anastasis front-end, you can now simply run: + +.. code-block:: console + + # apt install -t sid anastasis-gtk + +To use ``anastasis-gtk``, you can simply run: + +.. code-block:: console + + $ anastasis-gtk + +Installing the backend +^^^^^^^^^^^^^^^^^^^^^^ + +If you want to install the Anastasis backend-end (which normal users do not +need), you should run: + +.. code-block:: console + + # apt install -t sid anastasis-httpd + +Note that the latter package does not perform all of the configuration work. +It does setup the user users and the systemd service scripts, but you still +must configure the database backup, HTTP reverse proxy (typically with TLS +certificates), Taler merchant backend for payments, authentication services, +prices and the terms of service. + +Sample configuration files for the HTTP reverse proxy can be found in +``/etc/anastasis.conf``. ---------------------- @@ -2381,3 +2506,13 @@ user's mail address, including a UUID which identifies the challenge the code is for. The user must send this code back with their request (see ``$RESPONSE`` under `Managing truth`_). If the transmitted code is correct, the server responds with the requested encrypted key share. + + +------------------- +Anastasis DB Schema +------------------- +.. image:: anastasis-db.png +.. image:: anastasis_challengecode.png +.. image:: anastasis_challenge_payment.png +.. image:: anastasis_truth.png +.. image:: anastasis_truth_payment.png diff --git a/frags/installing-anastasis-gtk.rst b/frags/installing-anastasis-gtk.rst new file mode 100644 index 00000000..b9d5dc31 --- /dev/null +++ b/frags/installing-anastasis-gtk.rst @@ -0,0 +1,31 @@ +The following steps assume at least the GNUnet, gnunet-gtk and Anastasis +dependencies are installed. + +First, unpack the anastasis-gtk tarball and change into the resulting +directory. Then, use the following commands to build and install +anastasis-gtk: + +.. code-block:: console + + $ ./configure [--prefix=PFX] \ + [--with-gnunet=GNUNETPFX] \ + [--with-exchange=EXCHANGEPFX] \ + [--with-anastasis=ANASTASISPFX] + $ # Each dependency can be fetched from non standard locations via + $ # the '--with-<LIBNAME>' option. See './configure --help'. + $ make + # make install + +If you did not specify a prefix, anastasis-gtk will be installed to +``/usr/local``, which requires you to run the last step as ``root``. + +You have to specify ``-with-anastasis=/usr/local``, ``--with-exchange=/usr/local`` and/or +``--with-gnunet=/usr/local`` if you installed the exchange and/or +GNUnet to ``/usr/local`` in the previous steps. + +Depending on the prefixes you specified for the installation and the +distribution you are using, you may have to edit ``/etc/ld.so.conf``, adding +lines for ``GNUNETPFX/lib/`` and ``EXCHANGEPFX/lib/`` and ``PFX/lib/`` +(replace the prefixes with the actual paths you used). Afterwards, you should +run ``ldconfig``. Without this step, it is possible that the linker may not +find the installed libraries and launching anastasis-gtk would then fail. diff --git a/frags/installing-anastasis.rst b/frags/installing-anastasis.rst new file mode 100644 index 00000000..7978b710 --- /dev/null +++ b/frags/installing-anastasis.rst @@ -0,0 +1,30 @@ +The following steps assume all dependencies are installed. + +First, unpack the Anastasis tarball and change into +the resulting directory. +Then, use the following commands to build and install Anastasis: + +.. code-block:: console + + $ ./configure [--prefix=PFX] \ + [--with-gnunet=GNUNETPFX] \ + [--with-exchange=EXCHANGEPFX] + $ # Each dependency can be fetched from non standard locations via + $ # the '--with-<LIBNAME>' option. See './configure --help'. + $ make + # make install + +If you did not specify a prefix, Anastasis will be installed to +``/usr/local``, which requires you to run the last step as ``root``. + +You have to specify ``--with-exchange=/usr/local`` and/or +``--with-gnunet=/usr/local`` if you installed the exchange and/or +GNUnet to ``/usr/local`` in the previous steps. + +Depending on the prefixes you specified for the installation and the +distribution you are using, you may have to edit ``/etc/ld.so.conf``, adding +lines for ``GNUNETPFX/lib/`` and ``EXCHANGEPFX/lib/`` and ``PFX/lib/`` +(replace the prefixes with the actual paths you used). Afterwards, you should +run ``ldconfig``. Without this step, it is possible that the linker may not +find the installed libraries and launching the Anastasis backend would +then fail. diff --git a/frags/installing-gnunet-gtk.rst b/frags/installing-gnunet-gtk.rst new file mode 100644 index 00000000..d4c8319f --- /dev/null +++ b/frags/installing-gnunet-gtk.rst @@ -0,0 +1,28 @@ +The following steps assume at least the GNUnet and Gtk+ dependencies are installed. + +First, unpack the gnunet-gtk tarball and change into the resulting directory. +Then, use the following commands to build and install gnunet-gtk: + +.. code-block:: console + + $ ./configure [--prefix=$PFX] \ + [--with-gnunet=$GNUNETPFX] + $ # Each dependency can be fetched from non standard locations via + $ # the '--with-<LIBNAME>' option. See './configure --help'. + $ make + # make install + +It is highly recommended to use the same prefix ($PFX) for gnunet-gtk that was +used for GNUnet ($GNUNETPFX). If you did not specify a prefix, gnunet-gtk +will be installed to ``/usr/local``, which requires you to run the last step +as ``root``. + +You have to specify ``--with-gnunet=/usr/local`` if you installed +GNUnet to ``/usr/local`` in the previous steps. + +Depending on the prefixes you specified for the installation and the +distribution you are using, you may have to edit ``/etc/ld.so.conf``, adding +lines for ``$GNUNETPFX/lib/`` and ``$PFX/lib/`` (replace the prefixes with the +actual paths you used). Afterwards, you should run ``ldconfig``. Without this +step, it is possible that the linker may not find the installed libraries and +launching gnunet-gtk would then fail. diff --git a/frags/installing-taler-merchant.rst b/frags/installing-taler-merchant.rst new file mode 100644 index 00000000..249d5d77 --- /dev/null +++ b/frags/installing-taler-merchant.rst @@ -0,0 +1,34 @@ +GNU Taler merchant has these additional dependencies: + +- libqrencode >= 4.0.0 + +The following steps assume all dependencies are installed. + +First, unpack the GNU Taler merchant tarball and change into +the resulting directory. +Then, use the following commands to build and install the merchant backend: + +.. code-block:: console + + $ ./configure [--prefix=PFX] \ + [--with-gnunet=GNUNETPFX] \ + [--with-exchange=EXCHANGEPFX] + $ # Each dependency can be fetched from non standard locations via + $ # the '--with-<LIBNAME>' option. See './configure --help'. + $ make + # make install + +If you did not specify a prefix, the exchange will install to +``/usr/local``, which requires you to run the last step as ``root``. + +You have to specify ``--with-exchange=/usr/local`` and/or +``--with-gnunet=/usr/local`` if you installed the exchange and/or +GNUnet to ``/usr/local`` in the previous steps. + +Depending on the prefixes you specified for the installation and the +distribution you are using, you may have to edit ``/etc/ld.so.conf``, adding +lines for ``GNUNETPFX/lib/`` and ``EXCHANGEPFX/lib/`` and ``PFX/lib/`` +(replace the prefixes with the actual paths you used). Afterwards, you should +run ``ldconfig``. Without this step, it is possible that the linker may not +find the installed libraries and launching the Taler merchant backend would +then fail. diff --git a/taler-merchant-manual.rst b/taler-merchant-manual.rst index f8e2eb30..d6d7d9c8 100644 --- a/taler-merchant-manual.rst +++ b/taler-merchant-manual.rst @@ -339,40 +339,7 @@ Installing the GNU Taler merchant backend .. index:: backend -GNU Taler merchant has these additional dependencies: - -- libqrencode >= 4.0.0 - -The following steps assume all dependencies are installed. - -First, unpack the GNU Taler merchant tarball and change into -the resulting directory. -Then, use the following commands to build and install the merchant backend: - -.. code-block:: console - - $ ./configure [--prefix=PFX] \ - [--with-gnunet=GNUNETPFX] \ - [--with-exchange=EXCHANGEPFX] - $ # Each dependency can be fetched from non standard locations via - $ # the '--with-<LIBNAME>' option. See './configure --help'. - $ make - # make install - -If you did not specify a prefix, the exchange will install to -``/usr/local``, which requires you to run the last step as ``root``. - -You have to specify ``--with-exchange=/usr/local`` and/or -``--with-gnunet=/usr/local`` if you installed the exchange and/or -GNUnet to ``/usr/local`` in the previous steps. - -Depending on the prefixes you specified for the installation and the -distribution you are using, you may have to edit ``/etc/ld.so.conf``, adding -lines for ``GNUNETPFX/lib/`` and ``EXCHANGEPFX/lib/`` and ``PFX/lib/`` -(replace the prefixes with the actual paths you used). Afterwards, you should -run ``ldconfig``. Without this step, it is possible that the linker may not -find the installed libraries and launching the Taler merchant backend would -then fail. +.. include:: frags/installing-taler-merchant.rst Installing the GNU Taler binary packages on Debian |