Self-host FerretDB on a VPS
A MongoDB compatible database that stores documents in PostgreSQL. Runs FerretDB with a bundled PostgreSQL that has the DocumentDB extension, a persistent volume and a generated password. It is not published on the host, so reach it from other services in this project at ferretdb:27017.
levelrail-cli templates deploy ferretdb --name my-ferretdbSpecification
- Status
- Listed
- Category
- Database Tools
- Services
- ferretdb, postgres
- Ports
- 27017
- Volumes
- 1
- Memory
- about 512 MiB
- arm64
- unknown
- amd64
- unknown
- Settings to fill in
- none
- License
- Permissive license, Apache-2.0
- Listing
- Community template
About FerretDB
A MongoDB compatible database that stores documents in PostgreSQL. Runs FerretDB with a bundled PostgreSQL that has the DocumentDB extension, a persistent volume and a generated password. It is not published on the host, so reach it from other services in this project at ferretdb:27017.
What it deploys
FerretDB runs as 2 services in a single Compose app, listening on port 27017, with 1 named volume mount.
| Service | Image | Tag | Ports | Volumes |
|---|---|---|---|---|
| ferretdb | ghcr.io/ferretdb/ferretdb | 2.7.0 | 27017 | none |
| postgres | ghcr.io/ferretdb/postgres-documentdb | 17-0.107.0-ferretdb-2.7.0 | none | pgdata -> /var/lib/postgresql/data |
Before you install
- CPU architecture. arm64 unknown. The scan could not read a manifest or the tag is chosen at install time. This is not a claim either way.
- Listed. It is in the catalog. Back up the data volume before changing an image tag.
Settings and environment
You do not have to fill in anything. 2 secrets are generated at deploy and stored encrypted. Values are never shown here.
| Service | Variable | Value |
|---|---|---|
| ferretdb | FERRETDB_POSTGRESQL_URL | Generated at deploy |
| ferretdb | FERRETDB_TELEMETRY | Preset by the template |
| postgres | POSTGRES_DB | Preset by the template |
| postgres | POSTGRES_PASSWORD | Generated at deploy |
| postgres | POSTGRES_USER | Preset by the template |
First run
- Read the generated password from the app secrets, then connect with a MongoDB client as the ferretdb user from a service in the same project.
Install FerretDB on a VPS
-
Install Levelrail on a fresh VPS
Run this as root on a Linux server (amd64 or arm64) with ports 80 and 443 reachable. The installer prints a setup link.
curl -fsSL https://levelrail.com/install.sh | sudo sh -
Sign in
Open the setup link, choose a password, then log the CLI in. The CLI install command is
curl -fsSL https://levelrail.com/install-cli.sh | shif the machine does not have it. See Getting started.levelrail-cli login --device -
Read the template
Shows the entry, including its full compose.yaml.
levelrail-cli templates get ferretdb -
Deploy it
This deploys the template compose file as an app. The app name defaults to the template id; --name sets another.
levelrail-cli templates deploy ferretdb --name my-ferretdb
Without a domain the app gets an sslip.io address. You can also deploy it from the dashboard: Apps, New app, Browse templates, then FerretDB.
Docs and upstream
More in Database Tools
- FalkorDBLow latency graph database that speaks the Redis protocol and the Cypher query language, with a bundled browser UI. Source available under the SSPL-1.0, which is not an open source license, so check it before offering it as a hosted service.
- Elasticsearch + KibanaElasticsearch paired with Kibana for log and document search with a visual dashboard. Kibana has no login, so anyone who can open it controls the data: before attaching a domain, enable Basic Auth or the auth gate on it. Elasticsearch is reachable only from services in this project at elasticsearch:9200 and is not published on the host.
- DbGateA web database client for SQL and NoSQL databases with a generated login and a data volume. Sign in as admin with the generated password, then add connections to other services here.
- CouchDBA document database with an HTTP API, built-in replication and the Fauxton admin console.
- CockroachDBA distributed SQL database that speaks the Postgres wire protocol, run as one insecure node for development and small workloads. The SQL port is private, the admin console is the web page. Source available license.
- CloudBeaverA web-based database manager for browsing and querying Postgres, MySQL, SQLite and more.