summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/sphinx/manpages/anastasis-helper-authorization-iban.1.rst57
-rw-r--r--doc/sphinx/manpages/anastasis.conf.5.rst39
2 files changed, 92 insertions, 4 deletions
diff --git a/doc/sphinx/manpages/anastasis-helper-authorization-iban.1.rst b/doc/sphinx/manpages/anastasis-helper-authorization-iban.1.rst
new file mode 100644
index 0000000..8674510
--- /dev/null
+++ b/doc/sphinx/manpages/anastasis-helper-authorization-iban.1.rst
@@ -0,0 +1,57 @@
+anastasis-helper-authorization-iban(1)
+######################################
+
+.. only:: html
+
+ Name
+ ====
+
+ **anastasis-helper-authorization-iban** - Helper for IBAN authentication
+
+Synopsis
+========
+
+**anastasis-helper-authorization-iban**
+[**-c** *FILENAME* | **––config=**\ ‌\ *FILENAME*]
+[**-h** | **––help**]
+[**-L** *LOGLEVEL* | **––loglevel=**\ ‌\ *LOGLEVEL*]
+[**-l** *FILENAME* | **––logfile=**\ ‌\ *FILENAME*]
+[**-t** | **––test**]
+[**-v** | **––version**]
+
+
+Description
+===========
+
+**anastasis-helper-authorization-iban** monitors the Anastasis provider's bank account for incoming wire transfers. This process supports the IBAN authentication method. It must be configured with the respective wire configuration to talk to LibEuFin/Nexus.
+
+
+**-c** *FILENAME* \| **––config=**\ ‌\ *FILENAME*
+ Use the configuration from *FILENAME*.
+
+**-h** \| **––help**
+ Print short help on options.
+
+**-L** *LOGLEVEL* \| **––loglevel=**\ ‌\ *LOGLEVEL*
+ Specifies the log level to use. Accepted values are: ``DEBUG``, ``INFO``,
+ ``WARNING``, ``ERROR``.
+
+**-l** *FILENAME* \| **––logfile=**\ ‌\ *FILENAME*
+ Send logging output to *FILENAME*.
+
+**-t** \| **––test**
+ Run in test mode. Causes the process to terminate after importing current wire transfers instead of running forever in the background.
+
+**-v** \| **––version**
+ Print version information.
+
+See Also
+========
+
+anastasis-httpd(1), anastasis.conf(5).
+
+Bugs
+====
+
+Report bugs by using https://bugs.anastasis.lu/ or by sending electronic
+mail to <contact@anastasis.lu>.
diff --git a/doc/sphinx/manpages/anastasis.conf.5.rst b/doc/sphinx/manpages/anastasis.conf.5.rst
index 1819d6d..40a3b7e 100644
--- a/doc/sphinx/manpages/anastasis.conf.5.rst
+++ b/doc/sphinx/manpages/anastasis.conf.5.rst
@@ -104,9 +104,11 @@ API_KEY
Authorization options
---------------------
-For each active authorization plugin, options must be configured in
-a section called ``[authorization-$PLUGIN]`` where ``$PLUGIN`` is
-the name of the authorization plugin.
+For each active authorization plugin, options must be configured in a
+section called ``[authorization-$PLUGIN]`` where ``$PLUGIN`` is the
+name of the authorization plugin. Specific plugins may require
+additional options, which are described in the respective sections
+below.
COST
Fee the user has to pay to obtain a challenge from this
@@ -115,8 +117,37 @@ COST
ENABLED
``yes`` to enable this plugin, ``no`` to disable.
+
+SMS Authorization options
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+COMMAND
+ Helper command to run to send SMS.
+
+Email Authorization options
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
COMMAND
- Helper command to run (only relevant for some plugins).
+ Helper command to run to send E-mail.
+
+
+Post Authorization options
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+COMMAND
+ Helper command to run to send physical mail.
+
+
+IBAN Authorization options
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+CREDIT_IBAN
+ IBAN number where the consumers must
+ wire the money to for authentication.
+
+BUSINESS_NAME
+ Name of the account holder.
+
Postgres database configuration