SurrealDB
Container
SurrealDB is an end-to-end cloud native database for web, mobile, serverless, jamstack, backend, and traditional applications.
Image details
Source details
Configuration
TypeContainerlinuxsurrealdb/surrealdb:lateststart --user ${SDB_USERNAME} --pass ${SDB_PASSWORD} file:/data/database.db8020:8000/tcp/data : /portainer/Files/AppData/Config/surrealdb/dataSDB_USERNAME=default_usernameSDB_PASSWORD=default_passwordunless-stoppedTemplate by novaspirit
Report issueNotes
Check our Github page: https://github.com/pi-hosted/pi-hosted
Official Webpage: https://surrealdb.com/
Official Docker Documentation: https://hub.docker.com/r/surrealdb/surrealdb
Standalone Install
Select an install method, to see config/commands for deploying SurrealDB
Install on Portainer
Import all app templates into your Portainer instance, for easy 1-click deploys
- Ensure both Docker and Portainer are installed, and up-to-date
- Log into your Portainer web UI
- Under Settings → App Templates, paste the below URL
- Head to Home → App Templates, and the list of apps will show up
- Select SurrealDB, fill in any config options, and hit Deploy
Template Import URL
https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me
More install options in our documentation, or see surrealdb/surrealdb for app-specific guidance.
Website · Documentation · Releases · GitHub · Discord
What is SurrealDB?
SurrealDB is a multi-model database built in Rust. It combines document, graph, relational, time-series, geospatial and key-value data in one engine, with full-text, vector and hybrid search, and real-time, event-driven queries. Because it is a single Rust binary, SurrealDB can run embedded, in the browser, at the edge, as a single server, or as a distributed cluster.This image contains the SurrealDB server and the
surreal command-line tools, so you can run a database, or import, export and query a remote one, without installing anything on the host.See the features, the latest releases, and the documentation.
Start a server
Start a server in memory, with a root user calledroot:docker run --rm --pull always --name surrealdb -p 8000:8000 surrealdb/surrealdb:latest start --user root --pass secretTo check that it is running, request
http://localhost:8000/health, which returns 200.Run your first query
Open a SurrealQL shell with thesql command from the same container:docker exec -it surrealdb /surreal sql -e http://localhost:8000 -u root -p secret --ns main --db main --prettyPersist data
Mount a directory and point the on-disk SurrealKV engine at a path inside it:mkdir mydata
docker run --rm --pull always -p 8000:8000 --user $(id -u) -v $(pwd)/mydata:/mydata surrealdb/surrealdb:latest start --user root --pass secret surrealkv:/mydata/mydatabase.dbFrom SurrealDB 4.0, the image runs as the non-root user
nonroot (UID 65532), and /data and /logs belong to that user. A named volume mounted at /data is writable without extra flags. With a directory from the host, as above, pass --user so the container user can write to it.Run with Docker Compose
services:
surrealdb:
image: surrealdb/surrealdb:latest # Consider pinning a version tag
ports:
- "8000:8000"
env_file:
- .env
volumes:
- surrealdb-data:/data
command: start surrealkv:/data/app.db
volumes:
surrealdb-data:# .env
SURREAL_USER=root
SURREAL_PASS=secret # Change this in productionThe server reads
SURREAL_USER and SURREAL_PASS from its environment, so there is no need for --user and --pass in command.Configuration
Most options can be set with environment variables. To list them all, run:docker run --rm surrealdb/surrealdb:latest start --helpThe image contains timezone data. Set the timezone with
TZ:docker run -e TZ=Europe/London surrealdb/surrealdb:latest startImage tags
| Tag | Contents |
|---|---|
latest | The current stable release. |
v4, v4.0 | The latest release in a major or minor line. |
v4.0.1 | One exact release. Use a version tag in production. |
nightly | A build of the main branch, updated every night. |
-dev | Any tag above with -dev added, such as latest-dev. Built on an image with a shell and a package manager, for local development and debugging. |
Documentation
For installation, development, deployment and administration, see the documentation. The Docker guide covers this image in more detail.Community
- Read the Blog
- Chat with us on Discord
- Follow us on X
- Connect with us on LinkedIn
- Watch us on YouTube
- Ask questions tagged #surrealdb on Stack Overflow
To contribute to SurrealDB, see the contribution guide.
Security
For security issues, see our vulnerability policy and security policy, and email [email protected] instead of opening a public issue.License
Source code for SurrealDB is licensed under several licenses. A copy of each can be found in each repository.- Libraries and SDKs, each in its own repository, are released under the Apache License 2.0 or the MIT License.
- Some core database components, each in its own repository, are released under the Apache License 2.0.
- The core database code, in the surrealdb repository, is released under the Business Source License 1.1.
For more information, see the licensing information.
Serve SurrealDB on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.
Proxying surrealdb.example.com to http://SurrealDB:8000
Add this to your Caddyfile
surrealdb.example.com {
reverse_proxy http://SurrealDB:8000
}Check the logs first
Nine times out of ten the logs tell you exactly what went wrong.
- In Portainer, go to Containers, click the container, then Logs. Or run
docker logs SurrealDB - Exit codes help too:
137means killed, usually out of memory.126or127means the command inside the image is broken.
Port already in use
If deployment fails with "Bind for 0.0.0.0:8020 failed: port is already allocated", something else on your server is using that port.
- Find what's using it:
sudo ss -tlnp | grep :8020 - Stop the other service, or pick a different host port. In
8020:8000only the left number is yours to change, the right one belongs to the app.
Running but the page won't load
The container is up but nothing appears in your browser.
- Use your server's real IP:
http://your-server-ip:8020. The 0.0.0.0 link Portainer shows isn't a real address. - Give it a minute after first deploy, SurrealDB can take a while to initialise.
- Make sure your firewall allows the port, e.g.
sudo ufw allow 8020
Permission denied on volumes
If the logs show "permission denied", the app can't write to its data folder on the host.
- Fix the ownership:
sudo chown -R 1000:1000 /portainer/Files/AppData/Config/surrealdb/data
Image won't pull
Test the pull directly on the host: docker pull surrealdb/surrealdb:latest
- "manifest unknown" means the tag no longer exists. This template uses
latest, so try pinning a specific version instead. - "toomanyrequests" is the Docker Hub rate limit. Log in with
docker loginto raise it. - "no space left on device" means a full disk. Reclaim space with
docker system prune
"exec format error"
This means the image was built for a different CPU architecture than your server.
- This image supports:
amd64, arm64 - Check yours with
uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.
Container keeps restarting
The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.
- Check the logs right after a restart, the last few lines before it died are the useful ones.
- Get the exit code with
docker inspect SurrealDB --format '{{.State.ExitCode}}' - Still stuck? Redeploy once with the restart policy set to
noso the failure stays visible.
Raise an issue
Found something which isn't working as it should? Here's how to report it.
- Bug within the app: Open an issue on surrealdb/surrealdb
- Template not working: Open an issue on novaspirit/pi-hosted
- This website not working: Open an issue on lissy93/portainer-templates
A single container
SurrealDB runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.
The app image
An image is the app packed up ready to go, everything SurrealDB needs bundled into one download. This template pulls surrealdb/surrealdb:latest, which Docker fetches once (about 207 MB) and then starts your own copy from.
Where the image comes from
Docker pulls its images from registries, public libraries of ready-built apps. SurrealDB's comes from Docker Hub, published by surrealdb.
Version tags
The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Newest right now is v4.0-dev. Pin a specific tag if you would rather stay on one version.
Which machines it runs on
Every image is built for particular CPU types. This one ships for amd64, arm64, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.
Ports
A port is the door the app answers on. A mapping like 8020:8000 means it's reachable on port 8020 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:8020 in a browser. It opens:
8020:8000, likely the web interface
Volumes
A volume is where SurrealDB keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:
/datafrom/portainer/Files/AppData/Config/surrealdb/dataon the host
Environment variables
Environment variables are the settings you hand over when you deploy, things like a password or a timezone. SurrealDB takes 2 of them, all with defaults you can leave alone or tweak:
SDB_USERNAME, defaults todefault_usernameSDB_PASSWORD, defaults todefault_password
Restart policy
The restart policy here is unless-stopped, so Docker restarts SurrealDB after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).
Networking
Nothing custom is set, so SurrealDB sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.
Container name
Once it's deployed, Portainer names the container SurrealDB. That's what you'll spot in the containers list and use in commands like docker logs SurrealDB.
Startup command
The command is what runs the moment the container starts. This template sets its own, start --user ${SDB_USERNAME} --pass ${SDB_PASSWORD} file:/data/database.db, in place of the image's default.
Platform
The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.
Portainer app templates
Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set SurrealDB up. Add the template list to Portainer once, then deploying SurrealDB is a click rather than a wall of config.