Skip to content

Commit

Permalink
docs: Add more config documentation to the README
Browse files Browse the repository at this point in the history
These new options were missing in the configuration section.
  • Loading branch information
g3n35i5 committed Jan 17, 2025
1 parent 9c31d88 commit 1027a3a
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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``

0 comments on commit 1027a3a

Please sign in to comment.