Back to Wekan

FerretDB

docs/Databases/FerretDB/README.md

10.841.4 KB
Original Source

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:

DirectoryVersionStores into
1FerretDB v1, the wekan/FerretDB fork — WeKan's default databaseSQLite (embedded), PostgreSQL, MySQL, MariaDB, SAP HANA
2FerretDB 2, upstreamPostgreSQL 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