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-surrealdbSpecification
- 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.
| Service | Image | Tag | Ports | Volumes |
|---|---|---|---|---|
| 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.
| Service | Variable | Value |
|---|---|---|
| surrealdb | SURREAL_PASS | Generated at deploy |
| surrealdb | SURREAL_USER | Preset by the template |
First run
- 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
-
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 surrealdb -
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.
Docs and upstream
More in Database Tools
- SQLPadWeb based SQL editor for running queries against many databases, with saved queries, charts and sharing. The admin account is created from the install form.
- SonicFast, lightweight schema less search index server that stores identifiers instead of documents. The install form carries config.cfg as an editable file and a generated channel password.
- TiDBA MySQL compatible distributed SQL database, run here as a single node on local storage for development and testing. Apache-2.0 licensed. The root user has no password, so keep it private.
- TimescaleDBPostgreSQL with the TimescaleDB extension for time series data, with a persistent volume and a generated password. The core is Apache-2.0 and some features fall under the Timescale License. It is not published on the host, so reach it from other services in this project at timescaledb:5432.
- ScyllaDBA wide column database compatible with Cassandra, running as one node in developer mode with a data volume. It has no web page, so connect over the project network at scylladb:9042.
- ValkeyA Redis-compatible in-memory key-value store under the Linux Foundation, with password auth and append-only persistence.