mirror of
https://github.com/hedgedoc/hedgedoc.git
synced 2025-05-09 05:41:57 -04:00
098322cef8
Some checks failed
Docker / build-and-push (backend) (push) Has been cancelled
Docker / build-and-push (frontend) (push) Has been cancelled
Deploy HD2 docs to Netlify / Deploys to netlify (push) Has been cancelled
E2E Tests / backend-sqlite (push) Has been cancelled
E2E Tests / backend-mariadb (push) Has been cancelled
E2E Tests / backend-postgres (push) Has been cancelled
E2E Tests / Build test build of frontend (push) Has been cancelled
Lint and check format / Lint files and check formatting (push) Has been cancelled
REUSE Compliance Check / reuse (push) Has been cancelled
Scorecard supply-chain security / Scorecard analysis (push) Has been cancelled
Static Analysis / Njsscan code scanning (push) Has been cancelled
Static Analysis / CodeQL analysis (push) Has been cancelled
Run tests & build / Test and build with NodeJS 20 (push) Has been cancelled
E2E Tests / frontend-cypress (1) (push) Has been cancelled
E2E Tests / frontend-cypress (2) (push) Has been cancelled
E2E Tests / frontend-cypress (3) (push) Has been cancelled
We don't test it, and so we should not tell people HD2 could work with mysql Signed-off-by: Philip Molares <philip.molares@udo.edu>
1.4 KiB
1.4 KiB
Database
We officially support and test these databases:
- SQLite (for development and smaller instances)
- PostgreSQL
- MariaDB
!!! warning
We don't necessarily support MySQL.
| environment variable | default | example | description |
|---|---|---|---|
HD_DATABASE_TYPE |
- | postgres |
The database type you want to use. This can be postgres, mariadb or sqlite. |
HD_DATABASE_NAME |
- | hedgedoc |
The name of the database to use. When using SQLite, this is the path to the database file. |
HD_DATABASE_HOST |
- | db.example.com |
The host, where the database runs. Only if you're not using sqlite. |
HD_DATABASE_PORT |
- | 5432 |
The port, where the database runs. Only if you're not using sqlite. |
HD_DATABASE_USER |
- | hedgedoc |
The user that logs in the database. Only if you're not using sqlite. |
HD_DATABASE_PASS |
- | password |
The password to log into the database. Only if you're not using sqlite. |