Tip
Looking for FerretDB v1? It is there.
Please pardon the dust as we move FerretDB v2 to this repository.
FerretDB is an open-source alternative to MongoDB. It is a proxy that converts MongoDB 5.0+ wire protocol queries to SQL and uses PostgreSQL with DocumentDB extension as a database engine.
flowchart LR
A["Any application<br>Any MongoDB driver"]
F{{FerretDB}}
P[(PostgreSQL<br>DocumentDB extension)]
A -- "MongoDB protocol<br>BSON" --> F
F -- "PostgreSQL protocol<br>SQL" --> P
MongoDB was originally an eye-opening technology for many of us developers, empowering us to build applications faster than using relational databases. In its early days, its ease-to-use and well-documented drivers made MongoDB one of the simplest database solutions available. However, as time passed, MongoDB abandoned its open-source roots; changing the license to SSPL - making it unusable for many open-source and early-stage commercial projects.
Most MongoDB users do not require any advanced features offered by MongoDB; however, they need an easy-to-use open-source document database solution. Recognizing this, FerretDB is here to fill that gap.
FerretDB is compatible with MongoDB drivers and popular MongoDB tools. It functions as a drop-in replacement for MongoDB 5.0+ in many cases. Features are constantly being added to further increase compatibility and performance.
We welcome all contributors. See our public roadmap, a list of known differences with MongoDB, and contributing guidelines.
Run this command to start FerretDB with PostgreSQL:
docker run -d --rm --name ferretdb -p 27017:27017 --platform linux/amd64 ghcr.io/ferretdb/ferretdb-eval:2This command will start a container with FerretDB, pre-packaged PostgreSQL with DocumentDB extension, and MongoDB Shell for quick testing and experiments. However, it is unsuitable for production use cases because it keeps all data inside and loses it on shutdown. See our installation guides for instructions that don't have those problems.
With that container running, you can:
- Connect to it with any MongoDB client application using MongoDB URI
mongodb://username:[email protected]:27017/. - Connect to it using MongoDB Shell by just running
mongosh. If you don't have it installed locally, you can rundocker exec -it ferretdb mongosh. - For PostgreSQL, connect to it by running
docker exec -it ferretdb psql -U username postgres.
You can stop the container with docker stop ferretdb.
We also provide binaries and packages for various Linux distributions. See our documentation for more details.
Note
We advise users not to build FerretDB themselves. Instead, use binaries, Docker images, or packages provided by us.
FerretDB could be built as any other Go program, but a few generated files and build tags could affect it. See there for more details.
- Website: https://www.ferretdb.com/.
- Blog: https://blog.ferretdb.io/.
- Documentation: https://docs.ferretdb.io/.
- X (Twitter): @ferret_db.
- Mastodon: @[email protected].
- Slack chat for quick questions.
- GitHub Discussions for longer topics.
- GitHub Issues for bugs and missing features.
- Open Office Hours meeting every Monday at 17:00 UTC at Google Meet.
If you want to contact FerretDB Inc., please use this form.