diff options
Diffstat (limited to 'doc/sphinx/installation.rst')
-rw-r--r-- | doc/sphinx/installation.rst | 175 |
1 files changed, 175 insertions, 0 deletions
diff --git a/doc/sphinx/installation.rst b/doc/sphinx/installation.rst new file mode 100644 index 0000000..225160f --- /dev/null +++ b/doc/sphinx/installation.rst | |||
@@ -0,0 +1,175 @@ | |||
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 | Please install the following packages before proceeding with the | ||
25 | exchange compilation. | ||
26 | |||
27 | .. include:: frags/list-of-dependencies.rst | ||
28 | |||
29 | - GNU Taler exchange | ||
30 | |||
31 | - GNU Taler merchant backend | ||
32 | |||
33 | Except for the last two, these are available in most GNU/Linux distributions | ||
34 | and should just be installed using the respective package manager. | ||
35 | |||
36 | |||
37 | Installing from source | ||
38 | ---------------------- | ||
39 | |||
40 | The following instructions will show how to install libgnunetutil and | ||
41 | the GNU Taler exchange from source. | ||
42 | |||
43 | Installing GNUnet | ||
44 | ^^^^^^^^^^^^^^^^^ | ||
45 | |||
46 | .. include:: frags/installing-gnunet.rst | ||
47 | |||
48 | Installing the Taler Exchange | ||
49 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
50 | |||
51 | .. include:: frags/installing-taler-exchange.rst | ||
52 | |||
53 | Installing the Taler Merchant | ||
54 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
55 | |||
56 | .. include:: frags/installing-taler-merchant.rst | ||
57 | |||
58 | Installing Anastasis | ||
59 | ^^^^^^^^^^^^^^^^^^^^ | ||
60 | |||
61 | .. include:: frags/installing-anastasis.rst | ||
62 | |||
63 | Installing GNUnet-gtk | ||
64 | ^^^^^^^^^^^^^^^^^^^^^ | ||
65 | |||
66 | .. include:: frags/installing-gnunet-gtk.rst | ||
67 | |||
68 | Installing Anastasis-gtk | ||
69 | ^^^^^^^^^^^^^^^^^^^^^^^^ | ||
70 | |||
71 | .. include:: frags/installing-anastasis-gtk.rst | ||
72 | |||
73 | |||
74 | |||
75 | Installing Anastasis binary packages on Debian | ||
76 | ---------------------------------------------- | ||
77 | |||
78 | .. include:: frags/installing-debian.rst | ||
79 | |||
80 | |||
81 | Installing the graphical front-end | ||
82 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
83 | |||
84 | To install the Anastasis Gtk+ frontend, you can simply run: | ||
85 | |||
86 | .. code-block:: console | ||
87 | |||
88 | # apt install anastasis-gtk | ||
89 | |||
90 | To use ``anastasis-gtk``, you can simply run: | ||
91 | |||
92 | .. code-block:: console | ||
93 | |||
94 | $ anastasis-gtk | ||
95 | |||
96 | |||
97 | Installing the backend | ||
98 | ^^^^^^^^^^^^^^^^^^^^^^ | ||
99 | |||
100 | If you want to install the Anastasis backend-end (which normal users do not | ||
101 | need), you should run: | ||
102 | |||
103 | .. code-block:: console | ||
104 | |||
105 | # apt install -t sid anastasis-httpd | ||
106 | |||
107 | Note that the latter package does not perform all of the configuration work. | ||
108 | It does setup the user users and the systemd service scripts, but you still | ||
109 | must configure the database backup, HTTP reverse proxy (typically with TLS | ||
110 | certificates), Taler merchant backend for payments, authentication services, | ||
111 | prices and the terms of service. | ||
112 | |||
113 | Sample configuration files for the HTTP reverse proxy can be found in | ||
114 | ``/etc/anastasis.conf``. | ||
115 | |||
116 | Note that the package does not complete the integration of the backend | ||
117 | with the HTTP reverse proxy (typically with TLS certificates). A | ||
118 | configuration fragment for Nginx or Apache will be placed in | ||
119 | ``/etc/{apache,nginx}/conf-available/anastasis.conf``. | ||
120 | |||
121 | To operate an Anastasis backend with payments, you additionally | ||
122 | need to install a Taler merchant backend via: | ||
123 | |||
124 | .. code-block:: console | ||
125 | |||
126 | # apt install -t sid taler-merchant-httpd | ||
127 | |||
128 | |||
129 | |||
130 | Installing Anastasis binary packages on Ubuntu | ||
131 | ---------------------------------------------- | ||
132 | |||
133 | .. include:: frags/installing-ubuntu.rst | ||
134 | |||
135 | Installing the graphical front-end | ||
136 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
137 | |||
138 | To install the Anastasis front-end, you can now simply run: | ||
139 | |||
140 | .. code-block:: console | ||
141 | |||
142 | # apt install -t focal-fossa anastasis-gtk | ||
143 | |||
144 | To use ``anastasis-gtk``, you can simply run: | ||
145 | |||
146 | .. code-block:: console | ||
147 | |||
148 | $ anastasis-gtk | ||
149 | |||
150 | |||
151 | Installing the backend | ||
152 | ^^^^^^^^^^^^^^^^^^^^^^ | ||
153 | |||
154 | If you want to install the Anastasis backend-end (which normal users do not | ||
155 | need), you should run: | ||
156 | |||
157 | .. code-block:: console | ||
158 | |||
159 | # apt install -t focal-fossa anastasis-httpd | ||
160 | |||
161 | Note that the latter package does not perform all of the configuration work. | ||
162 | It does setup the user users and the systemd service scripts, but you still | ||
163 | must configure the database backup, HTTP reverse proxy (typically with TLS | ||
164 | certificates), Taler merchant backend for payments, authentication services, | ||
165 | prices and the terms of service. | ||
166 | |||
167 | Sample configuration files for the HTTP reverse proxy can be found in | ||
168 | ``/etc/anastasis.conf``. | ||
169 | |||
170 | To operate an Anastasis backend with payments, you additionally | ||
171 | need to install a Taler merchant backend via: | ||
172 | |||
173 | .. code-block:: console | ||
174 | |||
175 | # apt install -t sid taler-merchant-httpd | ||