Getting Started
FerretDB is an open source, MongoDB-compatible database that stores its data in PostgreSQL. Applications that speak the MongoDB wire protocol can use it without code changes. Available as an open web service in Eyevinn Open Source Cloud. This tutorial walks you through the steps to get started.
Prerequisites
- If you have not already done so, sign up for an Eyevinn OSC account
Step 1: Create the PostgreSQL DocumentDB backend
FerretDB needs a storage backend. In OSC this is the PostgreSQL DocumentDB service (ferretdb-documentdb). Create an instance of it first and wait until its status is "running".
Step 2: Create the FerretDB instance
Go to the FerretDB service, open the tab "My ferretdbs" and click "Create ferretdb". Fill in:
| Field | Description |
|---|---|
| Name | Instance name, alphanumeric only |
| PostgresqlUrl | Connection URL to the DocumentDB instance. In the web console this field is linked to the ferretdb-documentdb service and can be selected from your instances, with credentials included |
| LogLevel | Optional log verbosity |
Credentials
FerretDB has no default admin username and password of its own. Authentication is governed by the credentials of the PostgreSQL DocumentDB instance it is connected to.
CLI usage
osc create ferretdb-ferretdb mydocs \
-o PostgresqlUrl="<postgres-url-of-your-documentdb-instance>"