Click here to sign up to SurrealDB Cloud

Back to top
Documentation Installation

Installation

Getting started with SurrealDB is intended to be quick and easy. All of SurrealDB's functionality for starting a server, and importing and exporting data, is enabled through the command-line tool, packaged and distributed as a single executable file, which can be downloaded, installed, or run from within Docker.

Installing SurrealDB

Apple icon macOS

Follow this tutorial to install SurrealDB on macOS operating systems

Linux icon Linux

Follow this tutorial to install SurrealDB on Linux operating systems

Windows icon Windows

Follow this tutorial to install SurrealDB on Windows operating systems

Surreal icon Install SurrealDB Nightly

If you prefer developing on the bleeding edge, you can use SurrealDB Nightly, which includes the latest features, built and released every night

Running SurrealDB

Docker icon Run with Docker

Follow this tutorial to get started with SurrealDB using the Docker container management system or the Docker Compose orchestration tool

Run a single-node, in-memory server

Follow this tutorial to get started with a single-node, in-memory server instance for testing and development

Run a single-node, on-disk server

Follow this tutorial to get started with a single-node, in-disk server instance for vertical scaling

Run a multi-node, scalable cluster with TiKV

Follow this tutorial to get started with a single-node, in-disk server instance for horizontal scaling

Upgrading SurrealDB

From beta-9 to beta-10

Follow this guide to get started upgrading from beta-9 to beta-10

From beta-8 to beta-9

Follow this guide to get started upgrading from beta-8 to beta-9