Instructions for standalone deployment

1 files changed, 103 insertions, 0 deletions

diff --git a/deployment.rst b/deployment.rst
index 2a5ee9f0..7281fd21 100644
--- a/deployment.rst
+++ b/deployment.rst
@@ -107,3 +107,106 @@ The exchange db can be re-initialized with
 
 CAUTION: YOU WILL LOSE ALL DATA WITH THIS!
 
+
+---------------------
+Standalone deployment
+---------------------
+
+This tecnique aims to set a thorough Taler installation up on a
+machine whose nginx configuration is configured by config files
+from https://git.taler.net/deployment.git/tree/etc/nginx.
+
+This installation assumes that all the steps are run with ``$HOME``
+as ``$CWD``.
+
+The first step is to fetch the `deployment` repository, which hosts all
+the needed scripts.
+
+.. code-block:: none
+  
+  # Adapt the repository's URI to your needs.
+  $ git clone /var/git/deployment.git/
+
+The next step is to fetch all the codebases from all the components.
+
+.. code-block:: none
+  
+  $ ./deployment/bootstrap-standalone
+
+If the previous step succeeded, a file named ``activate`` should be now
+in the ``$CWD``.  It contains environmental definitions for ``$PATH`` and
+database names.
+
+.. note::
+
+  Please *ignore* the output from the previous script when it succeeds,
+  which is
+
+    .. code-block:: none
+
+      WARNING: enabling "trust" authentication for local connections
+      You can change this by editing pg_hba.conf or using the option -A, or
+      --auth-local and --auth-host, the next time you run initdb.
+  
+      Success. You can now start the database server using:
+  
+      /usr/lib/postgresql/9.5/bin/pg_ctl -D talerdb -l logfile start
+
+    The reason is that this message is generated by Postgresql's utilities and
+    you never need to start your database manually; it will be started by the
+    init script that launches all the Taler processes.
+
+Now we need to compile and install all the downloaded codebases.
+
+.. code-block:: none
+
+  # We first update ``$PATH``, in order to make all the compilation
+    and configuration utilities available.
+  $ source activate
+
+  # Double check if the previous step worked: $PATH should
+  # contain $HOME/local/bin.
+  $ echo $PATH
+
+  # The actual compilation:
+  $ taler-deployment-build
+
+The following step will generate config files for all the components.
+Please **note** that although a default currency will be picked up by the
+script, it is possible to have a custom currency by setting the environment
+variable ``TALER_CONFIG_CURRENCY`` to the wanted currency, and then runing
+the config generator.
+
+.. code-block:: none
+  
+  $ taler-deployment-config-generate
+
+whereas the following one will place signatures inside wireformat JSON
+files.
+
+.. code-block:: none
+
+  $ taler-deployment-config-sign
+
+The next step is to generate `signkeys` and `denomkeys`.
+
+.. code-block:: none
+
+  $ taler-deployment-keyup
+
+..
+  An error of "invalid currency name" might be related to the current
+  policy of 12-chars limit for currency names; which is likely going to
+  be changed.
+
+If all previous steps succeeded, it is now possible to launch all the
+processes.  That is accomplished by the following command:
+
+.. code-block:: none
+
+  $ taler-deployment-start
+
+.. note::
+
+  Please make sure your nginx works correctly with its configuration
+  at ``<DEPLOYMENT-REPO>/etc/nginx``.