From 6ffe740652955bf324e50b218552ab11ffd7933e Mon Sep 17 00:00:00 2001 From: Pirate Praveen Arimbrathodiyil Date: Fri, 18 Apr 2025 20:27:57 +0530 Subject: [PATCH] FerretDB 2.0 is now fully compatible We don't need to use the older snapshot anymore if we drop the index created by ferretdb 1.0 when updating to ferretdb 2.0. --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 25b5281..1b14e57 100644 --- a/README.md +++ b/README.md @@ -188,9 +188,7 @@ A key is rejected if one of the following is detected: The server is written is in JavaScript ES2020 and runs on [Node.js](https://nodejs.org/) v18+. -It uses [MongoDB](https://www.mongodb.com/) v6.0+ as its database. - -Note: You may also use [FerretDB](https://ferretdb.com) 2.0+, which aims to provide a Free Software replacement for MongoDB. But you will need to use [an older version of Mailvelope Key Server](https://github.com/mailvelope/keyserver/tree/c7ffbefa744473be06500e722dc1c9327a130cd5) since FerretDB [TTL indexes are not fully MongoDB compatible](https://github.com/FerretDB/FerretDB/issues/4960) yet. +It uses [MongoDB](https://www.mongodb.com/) v6.0+ or [FerretDB](https://ferretdb.com) 2.0+ (Free Software replacement for MongoDB) as its database. # Getting started ## Installation @@ -228,6 +226,10 @@ use keyserver-test db.createUser({ user:"keyserver-user", pwd:"your_mongo_db_pwd", roles:[{ role:"readWrite", db:"keyserver-test" }] }) ``` +## FerrerDB + +You can find [instructions to install FerretDB on their website](https://docs.ferretdb.io/installation/ferretdb/). + #### Purge unverfied keys with TTL (time to live) indexes Unverified keys are automatically purged after `PUBLIC_KEY_PURGE_TIME` days. The MongoDB TTLMonitor thread that is used for this purpose, runs by default every 60 seconds. To change this interval to a more appropriate value run the following admin command in the mongo shell: