The easiest way to demonstrate how to use SingleStore DB on any major operating system is through a pre-configured Docker image. The
singlestore/cluster-in-a-box container is available for free and allows users to easily run a simple single-host cluster. It also includes SingleStore DB Studio, our cluster monitoring and management tool to easily monitor, debug and interact with your cluster.
If you are running Windows or macOS, using the
singlestore/cluster-in-a-box container allows you to easily try out SingleStore DB on your local machine.
Running SingleStore DB in a Docker container as described below is for prototyping and functional testing purposes only! If you wish to test out SingleStore DB for production deployments, see the SingleStore Tools-based deployment guide instead.
By downloading the
singlestore/cluster-in-a-box image, you agree to the SingleStore terms of service. If you do not have a paid Enterprise license, you may obtain help from other community members at the SingleStore Forums.
Before You Begin
Make sure Docker is running. The recommended configuration is at least 4 cores and 4GB of RAM on your host machine. For macOS users, you can enable this in the Advanced tab located under the Preferences menu item. For Windows users, this tab is located under Settings.
Get a License key
You must have a License key copied from the SingleStore Customer Portal. You can easily create a free license for a cluster with up to four license units or request an Enterprise licence trial key for larger clusters. Because this guide shows you how to spin up a Docker container for testing purposes, you will only need a free license key to continue.
For Windows users, the examples in this guide assume you are running them in a PowerShell window.