github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-11-22 17:56:30 -05:00
Code Issues Projects Releases Packages Wiki Activity
hedgedoc/docs/content/references/config/index.md
Philip Molares e07cd62596 docs: restructure documentation 
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>
2023-09-17 21:50:21 +02:00

1.1 KiB
Raw Blame History

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:

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/"

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.