mirror of
https://github.com/hedgedoc/hedgedoc.git
synced 2024-09-19 23:48:57 -04:00
e07cd62596
This rewrite follows the principles of https://diataxis.fr/ Co-authored-by: Erik Michelson <github@erik.michelson.eu> Signed-off-by: Philip Molares <philip.molares@udo.edu> Signed-off-by: Erik Michelson <github@erik.michelson.eu>
29 lines
1.1 KiB
Markdown
29 lines
1.1 KiB
Markdown
# Configuration
|
|
|
|
HedgeDoc can be configured via environment variables either directly or via an `.env` file.
|
|
|
|
## The `.env` file
|
|
|
|
The `.env` file should be in the working directory of the backend and contains key-value pairs of
|
|
environment variables and their corresponding value.
|
|
In the official Docker container this is `/usr/src/app/backend/`
|
|
This can for example look like this:
|
|
|
|
<!-- markdownlint-disable proper-names -->
|
|
```ini
|
|
HD_BASE_URL="http://localhost:8080"
|
|
HD_SESSION_SECRET="change_me_in_production"
|
|
HD_DATABASE_TYPE="sqlite"
|
|
HD_DATABASE_NAME="./hedgedoc.sqlite"
|
|
HD_MEDIA_BACKEND="filesystem"
|
|
HD_MEDIA_BACKEND_FILESYSTEM_UPLOAD_PATH="uploads/"
|
|
```
|
|
<!-- markdownlint-enable proper-names -->
|
|
|
|
We also provide an `.env.example` file containing a minimal configuration
|
|
in the root of the project. This should help you to write your own configuration.
|
|
|
|
!!! warning
|
|
The minimal configuration provided in `.env.example` is exactly that: minimal.
|
|
It will let you start HedgeDoc for local development,
|
|
but it is **not** meant to be used in production without prior changes.
|