github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-11-21 09:16:30 -05:00
Code Issues Projects Releases Packages Wiki Activity

docs: Move 'Configuration' to design docs

Browse source 
Signed-off-by: David Mehren <git@herrmehren.de>
This commit is contained in:
David Mehren 2023-03-12 20:40:47 +01:00
parent 162a8e8816
commit c9f8285f57
2 changed files with 7 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/content/dev/config.md → docs/content/dev/design_docs/config.md
View file

@ -1,10 +1,12 @@
# Config
The configuration of HedgeDoc is handled entirely by environment variables. Most of these variables are prefixed with `HD_` (for HedgeDoc).
!!! info "Design Document"
This is a design document, explaining the design and vision for a HedgeDoc 2
feature. It is not a user guide and may or may not be fully implemented.
## Configuring HedgeDoc for development
NestJS - the framework we use - is reading the variables from the environment and also from the `.env` file in the root of the project. To make it easy to get the project started we included an example `.env` file in the root of this project called `.env.example`.
The configuration of HedgeDoc 2 is handled entirely by environment variables.
Most of these variables are prefixed with `HD_` (for HedgeDoc).
NestJS - the framework we use - is reading the variables from the environment and also from the `.env` file in the root of the project.
## How the config code works

2
docs/mkdocs.yml
View file

@ -24,7 +24,7 @@ nav:
- Design Documents:
- Notes: dev/notes.md
- 'User Profiles & Authentication': dev/design_docs/user_profiles.md
- Configuration: dev/config.md
- Configuration: dev/design_docs/config.md
- 'Writing Docs': dev/documentation.md
- FAQ: https://hedgedoc.org/faq
markdown_extensions: