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 !
FerretDB
FerretDB speaks the MongoDB wire protocol and stores the data in something else,
so WeKan runs unchanged on top of it — WeKan only ever connects to
mongodb://ferretdb:27017/wekan?directConnection=true and knows nothing about
what is behind it. The directConnection=true is required, not decoration:
without it the driver follows FerretDB's replica-set handshake to the wildcard
address FerretDB listens on and the stack cannot start
(#6582, explained in
1/README.md).
There are two versions, and they are different products:
| Directory | Version | Stores into |
|---|---|---|
| 1 | FerretDB v1, the wekan/FerretDB fork — WeKan's default database | SQLite (embedded), PostgreSQL, MySQL, MariaDB, SAP HANA |
| 2 | FerretDB 2, upstream | PostgreSQL with the DocumentDB extension, only |
Upstream dropped every backend except PostgreSQL in v2. The fork keeps v1 alive because the embedded SQLite backend is what makes a WeKan install self-contained — no database server at all — and because it is the database WeKan ships for the platforms MongoDB has no server build for: ppc64le, s390x and riscv64.
See also
- ../MongoDB — the classic database, if you prefer MongoDB itself
- wekan/FerretDB — the fork, its releases and its CHANGELOG