Files
wekan/docs/Databases
Lauri Ojansivu a8fd080bc8 Docs mirror the Admin Panel and the menus: a page for every menu entry.
The docs tree is laid out like the menus - a menu path is a docs path.
Admin Panel / Settings follows the new structure: Visibility.md is
Appearance.md, with new Features.md, Feature-Profiles.md, Security.md,
Activities-and-Notifications.md and Delete.md; the section indexes,
Admin-Panel.md, Admin-Panel-URLs.md (with the moved-pane redirects) and
Validation.md follow the live menus, and Who-Sees-What.md explains in one
place which layer decides what is shown and what is allowed.

Pages are added for the menu entries that had none, each written from
the code: every Admin Panel / Problems pane, the member menu, the board
header, Board Settings, the All Boards left menu, and the list,
swimlane and card menus. Older links to the moved panes are updated
across docs/.

TODO.md records what documenting the menus found: Edit Profile does not
save a username for non-admins, the Support page's signed-out case is
unreachable, Create board from this card is hidden from members who can
edit the card, All Boards Settings is unreachable, and the Share template
targets live in browser storage.

Thanks to xet7 !
2026-11-19 01:22:22 +02:00
..

Databases

WeKan stores its data in a MongoDB-compatible database. That can be MongoDB itself, or FerretDB — which speaks the MongoDB wire protocol and stores the data in SQLite, PostgreSQL, MySQL, MariaDB or SAP HANA. The default is FerretDB v1 with its embedded SQLite, so a fresh docker compose up -d needs no database server at all.

Which databases are supported, and how each is tested: Supported.md - FerretDB v1 on SQLite (the default), PostgreSQL, MySQL, MariaDB and SAP HANA, and MongoDB 6, 7, 8 and 9.

Directory What is in it
FerretDB/1/ FerretDB v1 — the default. SQLite, PostgreSQL, MySQL, MariaDB, SAP HANA
FerretDB/2/ FerretDB 2 — PostgreSQL with the DocumentDB extension
MongoDB/ MongoDB itself: drivers, versions, the OpLog, and old CPUs
Migrations/ WeKan's own schema migrations and how they are verified
ToroDB/ ToroDB — a MongoDB proxy to PostgreSQL. No longer developed

FerretDB

Replacing MongoDB with FerretDB. Both of the v1 backends WeKan ships by default are confirmed working with a real Meteor 3 client — the embedded SQLite and vanilla PostgreSQL (#6509); MySQL, MariaDB and SAP HANA are experimental.

MongoDB

Migrations

  • Migrations/ — the schema-migration system, its review notes and verify-migrations.sh

ToroDB

ToroDB is not developed anymore. ToroDB was about adding a MongoDB proxy to PostgreSQL or MySQL.