Introduction min read


The easiest way to demonstrate how to use MemSQL on any major operating system is through a pre-configured Docker image. The memsql/cluster-in-a-box container is available for free and allows users to easily run a simple single-host MemSQL cluster. It also includes MemSQL Studio, our cluster monitoring and management tool to easily monitor, debug and interact with your MemSQL cluster.

If you are running Windows or macOS, using the memsql/cluster-in-a-box container allows you to easily try out MemSQL on your local machine.

Warning

Running MemSQL in a Docker container as described below is for prototyping and functional testing purposes only! If you wish to test out MemSQL for production deployments, see the multi-host on-premises install guide instead.

By downloading the memsql/cluster-in-a-box image, you agree to the MemSQL terms of service. Users who want to use MemSQL on Docker in production should contact MemSQL Support before proceeding. Get free enterprise support by creating a MemSQL Enterprise trial license key in our Customer Portal and using it with your memsql/cluster-in-a-box container.

Before You Begin

Install Docker

For newer macOS and Windows 10 machines, Install Docker Community Edition (CE). For users running older versions of Windows or macOS, install Docker Toolbox instead.

Configure Docker

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 MemSQL 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.

Info

For Windows users, the examples in this guide assume you are running them in a PowerShell window.

Was this article useful?