Skip to content

Commit

Permalink
docs: Add more config documentation to the README (#11)
Browse files Browse the repository at this point in the history
These new options were missing in the configuration section.

---------

Co-authored-by: Michael Barulin <[email protected]>
  • Loading branch information
g3n35i5 and MichaelBarulin authored Jan 20, 2025
1 parent 9c31d88 commit afe8361
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,5 +83,17 @@ 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.
- ``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``

0 comments on commit afe8361

Please sign in to comment.