From 1027a3a06587e82dbfd21b618c67fd96a680da91 Mon Sep 17 00:00:00 2001 From: Jan-Frederik Schmidt Date: Fri, 17 Jan 2025 14:39:18 +0100 Subject: [PATCH 1/2] docs: Add more config documentation to the README These new options were missing in the configuration section. --- README.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.rst b/README.rst index 321cfcb..03c3791 100644 --- a/README.rst +++ b/README.rst @@ -85,3 +85,15 @@ All configuration environment variables are prefixed with ``VDOC_``: * - ``VDOC_DOCS_DIR`` - The directory to which all project documentations will be uploaded to. - ``/srv/vdoc/docs/`` + * - ``VDOC_API_USERNAME`` + - The username required for uploading documentations via the API. + - ``admin`` + * - ``VDOC_API_PASSWORD`` + - The password required for uploading documentations via the API. + - ``admin`` + * - ``VDOC_BIND_ADDRESS`` + - The application bind address. + - ``0.0.0.0`` + * - ``VDOC_BIND_ADDRESS`` + - The application bind port. + - ``8080`` From 938199df0b8c979f35752bc068e168cf405fbf06 Mon Sep 17 00:00:00 2001 From: Jan-Frederik Schmidt Date: Fri, 17 Jan 2025 16:09:13 +0100 Subject: [PATCH 2/2] Update README.rst Co-authored-by: Michael Barulin <168841357+MichaelBarulin@users.noreply.github.com> --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 03c3791..56a6d06 100644 --- a/README.rst +++ b/README.rst @@ -83,7 +83,7 @@ All configuration environment variables are prefixed with ``VDOC_``: - Explanation - Default * - ``VDOC_DOCS_DIR`` - - The directory to which all project documentations will be uploaded to. + - The directory to which all project documentations will be uploaded. - ``/srv/vdoc/docs/`` * - ``VDOC_API_USERNAME`` - The username required for uploading documentations via the API.