describe taler-auditor-sync setup

1 files changed, 21 insertions, 0 deletions

diff --git a/taler-auditor-manual.rst b/taler-auditor-manual.rst
index 027e789f..96c39d26 100644
--- a/taler-auditor-manual.rst
+++ b/taler-auditor-manual.rst
@@ -661,6 +661,25 @@ database, and a second with the options for accessing the destination
 database.  In both cases, likely only the ``[exchangedb]/CONFIG`` option
 needs to be changed.
 
+To run ``taler-auditor-sync``, you must first configure two configuration
+files that identify the source and destination databases:
+
+.. code-block:: console
+
+   # As the 'sync' user:
+   $ taler-config -c src.conf -s exchangedb -o CONFIG -V "postgres:///auditor-ingres/"
+   $ taler-config -c dst.conf -s exchangedb -o CONFIG -V "postgres:///auditor/"
+
+Now you should be able to launch the synchronization process. You can run
+the process via systemd in the background. For a first one-off test, you should
+use the ``-t`` option which will cause the process to terminate once the two
+databases are synchronized:
+
+.. code-block:: console
+
+   # As the 'sync' user:
+   $ taler-auditor-sync -s src.conf -d dst.cfg -t
+
 When the exchange performs garbage collection to ``DELETE`` obsolete records,
 this change should be automatically replicated to the auditors untrusted
 ingress database.  However, as ``taler-auditor-sync`` tries to be "safe",
@@ -671,6 +690,8 @@ auditor's production copy.  We note that this does not have to be done
 at the same time when the exchange runs its garbage collection.
 
 
+
+
 .. _Operation:
 
 Operation