Skip to content

Commit 20262da

Browse files
authored
Merge pull request #33 from WorldHealthOrganization/32-ferretdb-steps
Add docs folder with ferret config doc
2 parents e542f3e + d71fc12 commit 20262da

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

docs/configuring-ferret-db.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
## Using FerretDB in place of MongoDB
2+
3+
### Overview
4+
5+
Go.Data works best with MongoDB because of its extensive features and flexibility. However, if you would like to use a fully Open Source alternative, you may configure [FerretDB](https://docs.ferretdb.io/), a proxy that translates MongoDB protocol queries to SQL, with PostgreSQL (or SQLite) as the database engine.
6+
7+
## Steps
8+
9+
### 1. Set up FerretDB and PostgreSQL locally with Docker
10+
11+
Use the [intructions from FerretDB documentation](https://docs.ferretdb.io/quickstart-guide/docker/) to deploy FerretDB.
12+
13+
You will be asked do a local setup of FerretDB and PostgreSQL using Docker Compose.
14+
15+
### 2. Run the Go.Data installer with the FerretDB arguments in place of the MongoDB arguments
16+
17+
In the [Download Installer](https://github.com/WorldHealthOrganization/GoDataSource-Installers?tab=readme-ov-file#5-download-installer) step of creating a running the Go.Data installers, pass the FerretDB arguments in `--dbport` and `--dbpath`.
18+
19+
For MacOS and Windows installations, these arguments may be requested during the installation process.
20+
21+
Note: Go.Data has not been extensively tested with FerretDB. The Go.Data maintainers will update these steps as further improvements are made to the Go.Data project.

0 commit comments

Comments
 (0)