mirror of
https://github.com/hedgedoc/hedgedoc.git
synced 2025-05-12 22:26:08 -04:00
7f665fae4b
Some checks are pending
Docker / build-and-push (frontend) (push) Waiting to run
Docker / build-and-push (backend) (push) Waiting to run
Deploy HD2 docs to Netlify / Deploys to netlify (push) Waiting to run
E2E Tests / backend-sqlite (push) Waiting to run
E2E Tests / backend-mariadb (push) Waiting to run
E2E Tests / backend-postgres (push) Waiting to run
E2E Tests / Build test build of frontend (push) Waiting to run
E2E Tests / frontend-cypress (1) (push) Blocked by required conditions
E2E Tests / frontend-cypress (2) (push) Blocked by required conditions
E2E Tests / frontend-cypress (3) (push) Blocked by required conditions
Lint and check format / Lint files and check formatting (push) Waiting to run
REUSE Compliance Check / reuse (push) Waiting to run
Scorecard supply-chain security / Scorecard analysis (push) Waiting to run
Static Analysis / Njsscan code scanning (push) Waiting to run
Static Analysis / CodeQL analysis (push) Waiting to run
Run tests & build / Test and build with NodeJS 20 (push) Waiting to run
Thanks to all HedgeDoc team members for the time discussing, helping with weird Nest issues, providing feedback and suggestions! Co-authored-by: Philip Molares <philip.molares@udo.edu> 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 root directory of the HedgeDoc application and
|
|
contains key-value pairs of environment variables and their corresponding value.
|
|
In the official Docker container this is `/usr/src/app/.env`
|
|
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.
|