surrealdb/surrealdb-enterprise repository overview

⁠ Enterprise is the distributed, geo-replicated
edition of SurrealDB

⁠Replicate globally.   Stay consistent.   Scale without sharding pain.

⁠  What is SurrealDB Enterprise?

SurrealDB Enterprise is the commercially licensed edition of SurrealDB. It is the same database, the same SurrealQL, the same HTTP, WebSocket and GraphQL surfaces, with distributed storage engines and operational tooling added on top.

See the features⁠, the documentation⁠, and pricing⁠.

⁠  A licence is required

This image will not start without a valid licence key. Three environment variables control licensing:

Keys are validated against keygen.sh⁠ and the response signature is verified offline, so validation never passes through a SurrealDB-operated service. A node that cannot reach the licence API keeps serving for a grace period rather than failing immediately.

Don't have a key yet? Talk to us⁠.

⁠  Run using Docker

A development server, in memory, with the root user enabled:

docker run --rm --pull always --name surrealdb -p 8000:8000 \
  -e SURREAL_LICENSE_KEY="$SURREAL_LICENSE_KEY" \
  surrealdb/surrealdb-enterprise:latest \
  start --log info --user root --pass root memory

A single node that persists to disk, using the enterprise ds-single engine:

docker run --rm --pull always --name surrealdb -p 8000:8000 \
  -e SURREAL_LICENSE_KEY="$SURREAL_LICENSE_KEY" \
  -v surrealdb-data:/data \
  surrealdb/surrealdb-enterprise:latest \
  start --user root --pass root ds-single:///data/surrealdb

Access the CLI against a running container. There is no shell, so invoke the binary directly:

docker exec -it surrealdb /surrealdb-enterprise sql -e http://localhost:8000 -u root -p root --ns test --db test --pretty

⁠  Run using Docker Compose

A single node, with the licence key supplied from a .env file:

services:
  surrealdb:
    image: surrealdb/surrealdb-enterprise:latest
    command:
      - start
      - --user
      - $DB_USER
      - --pass
      - $DB_PASSWORD
      - ds-single:///data/surrealdb
    env_file:
      - .env
    environment:
      SURREAL_LICENSE_KEY: $SURREAL_LICENSE_KEY
    ports:
      - 8000:8000

⁠  Support and community

Enterprise customers have a support contract; use it for anything production-affecting. For everything else:

• View our official Blog⁠
• Chat live with us on Discord⁠
• Follow us on Twitter⁠
• Connect with us on LinkedIn⁠
• Visit us on YouTube⁠
• Questions tagged #surrealdb on Stack Overflow⁠

For security issues, please email [email protected]⁠ rather than opening a public issue. See our security policy⁠.

⁠  License

SurrealDB Enterprise is commercial software, distributed under a licence agreement with SURREALDB. Use of this image requires a valid licence key. It is not covered by the Business Source License that applies to the community edition.

For licensing terms, pricing, or a trial key, see surrealdb.com/pricing⁠ or contact us⁠.