commit edec0fdc0134da59e4293421f7bce37e392b8103
parent 5c0259799aa92d563082bac8837b9c48e1151a0e
Author: Thien-Thi Nguyen <ttn@gnuvola.org>
Date: Wed, 19 Jan 2022 06:05:52 -0500
describe ‘serve’ in libeufin-sandbox(1)
Diffstat:
1 file changed, 31 insertions(+), 1 deletion(-)
diff --git a/manpages/libeufin-sandbox.1.rst b/manpages/libeufin-sandbox.1.rst
@@ -87,7 +87,37 @@ Command ``camt053tick``
Command ``serve``
=================
-.. WRITEME
+This command starts the HTTP server, listening on port 5000.
+To use a different port, use option ``--port INT``.
+To listen, instead, on a Unix domain socket,
+use option ``--with-unix-socket PATH``.
+When both ``--port`` and ``--with-unix-socket`` are given,
+``--with-unix-socket`` takes precedence.
+
+The process runs in the foreground, writing its logs to standard error.
+The normal log level is ``DEBUG``.
+To change it, use ``--log-level LEVEL``, where ``LEVEL`` is one of:
+``ERROR``, ``WARN``, ``INFO``, ``DEBUG``, ``TRACE``.
+
+Before invoking ``serve``, the following environment variables need to be set:
+
+``LIBEUFIN_SANDBOX_ADMIN_PASSWORD``
+ The password required for later use by ???FIXME???.
+ For testing purposes, you can use option ``--no-auth`` to disable
+ this requirement.
+ (In that case, this environment variable need not be set.)
+
+``LIBEUFIN_SANDBOX_DB_CONNECTION``
+ This specifies the database **libeufin-sandbox** uses to maintain state.
+ Currently, both Sqlite and PostgreSQL are supported.
+ (Only one needs to be specified.)
+ Examples:
+
+ - ``jdbc:sqlite:/tmp/libeufin-sandbox.db``
+ - ``jdbc:postgresql://localhost:5432/libeufindb?user=Foo&password=secret``
+
+.. @MS Is Control-C the best way to interrupt?
+ Are there any other signals handled specially?
Command ``reset-tables``
