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-ferretdb

Specification

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
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.

ServiceImageTagPortsVolumes
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.

ServiceVariableValue
ferretdbFERRETDB_POSTGRESQL_URLGenerated at deploy
ferretdbFERRETDB_TELEMETRYPreset by the template
postgresPOSTGRES_DBPreset by the template
postgresPOSTGRES_PASSWORDGenerated at deploy
postgresPOSTGRES_USERPreset by the template

First run

  1. 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

  1. 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
  2. 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 | sh if the machine does not have it. See Getting started.

    levelrail-cli login --device
  3. Read the template

    Shows the entry, including its full compose.yaml.

    levelrail-cli templates get ferretdb
  4. 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.

More in Database Tools

All Database Tools templates