surrealpatch/docker/DOCKER.md

is the ultimate cloud
database for tomorrow's applications

Develop easier.   Build faster.   Scale quicker.

         

     

             

  What is SurrealDB?

SurrealDB is an end-to-end cloud native database for web, mobile, serverless, jamstack, backend, and traditional applications. SurrealDB reduces the development time of modern applications by simplifying your database and API stack, removing the need for most server-side components, allowing you to build secure, performant apps quicker and cheaper. SurrealDB acts as both a database and a modern, realtime, collaborative API backend layer. SurrealDB can run as a single server or in a highly-available, highly-scalable distributed mode - with support for SQL querying from client devices, GraphQL, ACID transactions, WebSocket connections, structured and unstructured data, graph querying, full-text indexing, geospatial querying, and row-by-row permissions-based access.

View the features, the latest releases, the product roadmap, and documentation.

  Documentation

For guidance on installation, development, deployment, and administration, see our documentation.

  Run using Docker

Docker can be used to manage and run SurrealDB database instances without the need to install any command-line tools. The SurrealDB docker container contains the full command-line tools for importing and exporting data from a running server, or for running a server itself.

docker run --rm --pull always --name surrealdb -p 8000:8000 surrealdb/surrealdb:latest start

For just getting started with a development server running in memory, you can pass the container a basic initialization to set the user and password as root and enable logging.

docker run --rm --pull always --name surrealdb -p 8000:8000 surrealdb/surrealdb:latest start --log trace --user root --pass root memory

Access to the surrealdb CLI with:

docker exec -it <container_name> /surreal sql -e http://localhost:8000 -u root -p root --ns test --db test --pretty

  Run using Docker Compose

The Docker image can be used with the docker-compose tool. You can execute the following command to view the help of the start command to know the supported environment variables:

docker run --rm surrealdb/surrealdb:latest start --help

Here is an example of docker-compose.yml file.

version: '3'

services:
  surrealdb:
    env_file:
      - .env
    command: start 
    image: surrealdb/surrealdb:latest
    ports:
      - 8000:8000

Here is an example of .env file.

SURREAL_LOG=trace
SURREAL_AUTH=true
SURREAL_USER=root
SURREAL_PASS=root
SURREAL_CAPS_ALLOW_ALL=true

  Community

Join our growing community around the world, for help, ideas, and discussions regarding SurrealDB.

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

  Contributing

We would    for you to get involved with SurrealDB development! If you wish to help, you can learn more about how you can contribute to this project in the contribution guide.

  Security

For security issues, view our vulnerability policy, view our security policy, and kindly email us at security@surrealdb.com instead of posting a public issue on GitHub.

  License

Source code for SurrealDB is variously licensed under a number of different licenses. A copy of each license can be found in each repository.

• Libraries and SDKs, each located in its own distinct repository, are released under either the Apache License 2.0 or MIT License.
• Certain core database components, each located in its own distinct repository, are released under the Apache License 2.0.
• Core database code for SurrealDB, located in this repository, is released under the Business Source License 1.1.

For more information, see the licensing information.