anastasis

Credential backup and recovery protocol and service
Log | Files | Refs | Submodules | README | LICENSE

installation.rst (5207B)


      1 ..
      2   This file is part of Anastasis
      3   Copyright (C) 2019-2021 Anastasis SARL
      4 
      5   Anastasis is free software; you can redistribute it and/or modify it under the
      6   terms of the GNU Affero General Public License as published by the Free Software
      7   Foundation; either version 2.1, or (at your option) any later version.
      8 
      9   Anastasis is distributed in the hope that it will be useful, but WITHOUT ANY
     10   WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
     11   A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more details.
     12 
     13   You should have received a copy of the GNU Affero General Public License along with
     14   Anastasis; see the file COPYING.  If not, see <http://www.gnu.org/licenses/>
     15 
     16   @author Christian Grothoff
     17   @author Dominik Meister
     18   @author Dennis Neufeld
     19 
     20 ------------
     21 Installation
     22 ------------
     23 
     24 .. note::
     25 
     26   Currently, GNU Anastasis is released as alpha-quality software.
     27   When testing Anastasis, please choose ``demoland`` as
     28   your country of residence!
     29   **It is not yet production ready! You cannot rely on it to keep
     30   your secrets recoverable today!**  In particular, we need to
     31   still review the various country-specific questions used to create
     32   unique user identifiers at the beginning of the backup and
     33   recovery process.  Community feedback on those inputs would be
     34   particularly welcome!
     35 
     36 
     37 
     38 Please install the following packages before proceeding with the
     39 exchange compilation.
     40 
     41 .. include:: frags/list-of-dependencies.rst
     42 
     43 -  GNU Taler exchange
     44 
     45 -  GNU Taler merchant backend
     46 
     47 Except for the last two, these are available in most GNU/Linux distributions
     48 and should just be installed using the respective package manager.
     49 
     50 
     51 Installing from source
     52 ----------------------
     53 
     54 The following instructions will show how to install libgnunetutil and
     55 the GNU Taler exchange from source.
     56 
     57 Installing GNUnet
     58 ^^^^^^^^^^^^^^^^^
     59 
     60 .. include:: frags/installing-gnunet.rst
     61 
     62 Installing the Taler Exchange
     63 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
     64 
     65 .. include:: frags/installing-taler-exchange.rst
     66 
     67 Installing the Taler Merchant
     68 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
     69 
     70 .. include:: frags/installing-taler-merchant.rst
     71 
     72 Installing Anastasis
     73 ^^^^^^^^^^^^^^^^^^^^
     74 
     75 .. include:: frags/installing-anastasis.rst
     76 
     77 Installing GNUnet-gtk
     78 ^^^^^^^^^^^^^^^^^^^^^
     79 
     80 .. include:: frags/installing-gnunet-gtk.rst
     81 
     82 Installing Anastasis-gtk
     83 ^^^^^^^^^^^^^^^^^^^^^^^^
     84 
     85 .. include:: frags/installing-anastasis-gtk.rst
     86 
     87 
     88 
     89 Installing Anastasis binary packages on Debian
     90 ----------------------------------------------
     91 
     92 .. include:: frags/installing-debian.rst
     93 
     94 
     95 Installing the graphical front-end
     96 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
     97 
     98 To install the Anastasis Gtk+ frontend, you can simply run:
     99 
    100 .. code-block:: console
    101 
    102    # apt install anastasis-gtk
    103 
    104 To use ``anastasis-gtk``, you can simply run:
    105 
    106 .. code-block:: console
    107 
    108    $ anastasis-gtk
    109 
    110 
    111 Installing the backend
    112 ^^^^^^^^^^^^^^^^^^^^^^
    113 
    114 If you want to install the Anastasis backend-end (which normal users do not
    115 need), you should run:
    116 
    117 .. code-block:: console
    118 
    119    # apt install -t sid anastasis-httpd
    120 
    121 Note that the latter package does not perform all of the configuration work.
    122 It does setup the user users and the systemd service scripts, but you still
    123 must configure the database backup, HTTP reverse proxy (typically with TLS
    124 certificates), Taler merchant backend for payments, authentication services,
    125 prices and the terms of service.
    126 
    127 Sample configuration files for the HTTP reverse proxy can be found in
    128 ``/etc/anastasis.conf``.
    129 
    130 Note that the package does not complete the integration of the backend
    131 with the HTTP reverse proxy (typically with TLS certificates).  A
    132 configuration fragment for Nginx or Apache will be placed in
    133 ``/etc/{apache,nginx}/conf-available/anastasis.conf``.
    134 
    135 To operate an Anastasis backend with payments, you additionally
    136 need to install a Taler merchant backend via:
    137 
    138 .. code-block:: console
    139 
    140    # apt install -t sid taler-merchant-httpd
    141 
    142 
    143 
    144 Installing Anastasis binary packages on Ubuntu
    145 ----------------------------------------------
    146 
    147 .. include:: frags/installing-ubuntu.rst
    148 
    149 Installing the graphical front-end
    150 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    151 
    152 To install the Anastasis front-end, you can now simply run:
    153 
    154 .. code-block:: console
    155 
    156    # apt install -t focal-fossa anastasis-gtk
    157 
    158 To use ``anastasis-gtk``, you can simply run:
    159 
    160 .. code-block:: console
    161 
    162    $ anastasis-gtk
    163 
    164 
    165 Installing the backend
    166 ^^^^^^^^^^^^^^^^^^^^^^
    167 
    168 If you want to install the Anastasis backend-end (which normal users do not
    169 need), you should run:
    170 
    171 .. code-block:: console
    172 
    173    # apt install -t focal-fossa anastasis-httpd
    174 
    175 Note that the latter package does not perform all of the configuration work.
    176 It does setup the user users and the systemd service scripts, but you still
    177 must configure the database backup, HTTP reverse proxy (typically with TLS
    178 certificates), Taler merchant backend for payments, authentication services,
    179 prices and the terms of service.
    180 
    181 Sample configuration files for the HTTP reverse proxy can be found in
    182 ``/etc/anastasis.conf``.
    183 
    184 To operate an Anastasis backend with payments, you additionally
    185 need to install a Taler merchant backend via:
    186 
    187 .. code-block:: console
    188 
    189    # apt install -t sid taler-merchant-httpd