Self-host SurrealDB on a VPS

A multi-model database for documents, graphs and relations with a SQL-like query language, using the RocksDB engine on a named volume. The root password is generated at install. Source available under the BSL.

levelrail-cli templates deploy surrealdb --name my-surrealdb

Specification

Status
Listed
Category
Database Tools
Services
surrealdb
Ports
8000
Volumes
1
Memory
about 512 MiB
arm64
unknown
amd64
unknown
Settings to fill in
none
Listing
Community template

About SurrealDB

A multi-model database for documents, graphs and relations with a SQL-like query language, using the RocksDB engine on a named volume. The root password is generated at install. Source available under the BSL.

What it deploys

SurrealDB runs as one service in a single Compose app, listening on port 8000, with 1 named volume mount.

ServiceImageTagPortsVolumes
surrealdb surrealdb/surrealdb v2.1.2 8000 surreal_data -> /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. 1 secret is generated at deploy and stored encrypted. Values are never shown here.

ServiceVariableValue
surrealdbSURREAL_PASSGenerated at deploy
surrealdbSURREAL_USERPreset by the template

First run

  1. Read the generated root password from the app secrets, then connect over HTTP or WebSocket on port 8000 as user root.

Install SurrealDB 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 surrealdb
  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 surrealdb --name my-surrealdb

Without a domain the app gets an sslip.io address. You can also deploy it from the dashboard: Apps, New app, Browse templates, then SurrealDB.

More in Database Tools

All Database Tools templates