Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ferretdb/ferretdb
A truly Open Source MongoDB alternative
https://github.com/ferretdb/ferretdb
database document ferretdb go golang mongo mongo-db mongodb mongodb-database postgres postgresql
Last synced: 5 days ago
JSON representation
A truly Open Source MongoDB alternative
- Host: GitHub
- URL: https://github.com/ferretdb/ferretdb
- Owner: FerretDB
- License: apache-2.0
- Created: 2021-10-30T08:06:36.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-19T17:04:31.000Z (10 months ago)
- Last Synced: 2024-04-20T06:21:37.060Z (10 months ago)
- Topics: database, document, ferretdb, go, golang, mongo, mongo-db, mongodb, mongodb-database, postgres, postgresql
- Language: Go
- Homepage: https://www.ferretdb.com
- Size: 10.2 MB
- Stars: 8,510
- Watchers: 77
- Forks: 367
- Open Issues: 497
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# FerretDB
> [!TIP]
> Looking for FerretDB v1?
> It is [there](https://github.com/FerretDB/FerretDB/tree/main-v1).
[](https://github.com/FerretDB/FerretDB/actions/workflows/go.yml)
[](https://codecov.io/gh/FerretDB/FerretDB)
[](https://github.com/FerretDB/FerretDB/actions/workflows/security.yml)
[](https://github.com/FerretDB/FerretDB/actions/workflows/packages.yml)
[](https://github.com/FerretDB/FerretDB/actions/workflows/docs.yml)
_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](https://github.com/microsoft/documentdb) as a database engine.
```mermaid
flowchart LR
A["Any application
Any MongoDB driver"]
F{{FerretDB}}
P[(PostgreSQL
DocumentDB extension)]
A -- "MongoDB protocol
BSON" --> F
F -- "PostgreSQL protocol
SQL" --> P
```
## Why do we need FerretDB?
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](https://www.ferretdb.com/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.
## Scope and current state
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](https://github.com/orgs/FerretDB/projects/2/views/1),
a list of [known differences with MongoDB](https://docs.ferretdb.io/diff/),
and [contributing guidelines](CONTRIBUTING.md).
## Quickstart
Run this command to start FerretDB with PostgreSQL:
```sh
docker run -d --rm --name ferretdb -p 27017:27017 --platform linux/amd64 ghcr.io/ferretdb/ferretdb-eval:2
```
This 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](https://docs.ferretdb.io/installation/) 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 run `docker 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](https://docs.ferretdb.io/installation/) for more details.
## Building and packaging
> [!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](https://pkg.go.dev/github.com/FerretDB/FerretDB/v2/build/version) for more details.
## Managed FerretDB at cloud providers
- [Civo](https://www.civo.com/marketplace/FerretDB)
- [Tembo](https://tembo.io/docs/tembo-stacks/mongo-alternative)
- [Elestio](https://elest.io/open-source/ferretdb)
- [Cozystack](https://cozystack.io/docs/components/#managed-ferretdb).
## Community
- Website: https://www.ferretdb.com/.
- Blog: https://blog.ferretdb.io/.
- Documentation: https://docs.ferretdb.io/.
- X (Twitter): [@ferret_db](https://x.com/ferret_db).
- Mastodon: [@[email protected]](https://techhub.social/@ferretdb).
- [Slack chat](https://join.slack.com/t/ferretdb/shared_invite/zt-zqe9hj8g-ZcMG3~5Cs5u9uuOPnZB8~A) for quick questions.
- [GitHub Discussions](https://github.com/FerretDB/FerretDB/discussions) for longer topics.
- [GitHub Issues](https://github.com/FerretDB/FerretDB/issues) for bugs and missing features.
- [Open Office Hours meeting](https://calendar.google.com/calendar/event?action=TEMPLATE&tmeid=NGhrZTA5dXZ0MzQzN2gyaGVtZmx2aWxmN2pfMjAyNDA0MDhUMTcwMDAwWiBjX24zN3RxdW9yZWlsOWIwMm0wNzQwMDA3MjQ0QGc&tmsrc=c_n37tquoreil9b02m0740007244%40group.calendar.google.com&scp=ALL)
every Monday at 17:00 UTC at [Google Meet](https://meet.google.com/mcb-arhw-qbq).
If you want to contact FerretDB Inc., please use [this form](https://www.ferretdb.com/contact/).