Skip to content

memgraph/memgraph-platform

Repository files navigation

One command to run it all.

license dockerhub dockerhub-pulls

🏃 Quick start

With Docker running on your system and ports 7687, 7444 and 3000 available, run one of the following commands to download Memgraph Platform Docker Compose file and start Memgraph and Memgraph Lab services:

Linux/macOS

curl https://install.memgraph.com | sh

Windows

iwr https://windows.memgraph.com | iex

By running docker ps, you'll notice memgraph-mage and memgraph-lab containers running. If you head over to localhost:3000, Quick Connect in Memgraph Lab will detect Memgraph running on your system. Check out the basic Docker Compose file and update it to fit your needs.

To start mgconsole, run the following command:

# with `docker ps` get the Memgraph container id 
docker exec -ti <container-id> mgconsole

📋 Description

This repository serves as a Docker package builder for the Memgraph ecosystem, consisting of:

Here are the Docker images which can be built from this repository:

❗ (Deprecated) Memgraph Platform Docker image

The last Memgraph Platform image published on Docker Hub is 2.14.1. In the future, from Memgraph 2.15, Memgraph Platform image will no longer be published, and Docker Compose containing Memgraph MAGE and Lab services will replace it.

You can start Memgraph Platform with:

docker run -p 3000:3000 -p 7444:7444 -p 7687:7687 --name memgraph memgraph/memgraph-platform

How to start mgconsole

Start mgconsole with:

# get the running-container-id with `docker ps`
docker exec -ti <running-container-id> mgconsole

# or
docker run -ti --entrypoint=mgconsole memgraph/memgraph-platform

When connecting to local Memgraph with mgconsole on Windows and Mac, make sure to provide the following argument --host host.docker.internal:

docker run -ti --entrypoint=mgconsole memgraph/memgraph-platform --host host.docker.internal

How to start only Lab

Run only the Lab with the following command:

docker run -p 3000:3000 memgraph/memgraph-platform -c /etc/supervisor/supervisord-lab-only.conf

How to start only Memgraph

Run only Memgraph with the following command:

docker run -p 7687:7687 memgraph/memgraph-platform -c /etc/supervisor/supervisord-memgraph-only.conf

⌛ Versioning

The versioning is transparent in the sense that we explicitly state which version of software is included, and it looks like this:

memgraph/memgraph-platform:2.5.0-memgraph2.4-lab2.2.2-mage1.3.5

and just by looking at each of the Memgraph Platform version, you can know which versions of software it contains without looking at details in release notes.

🐳 Docker build

To build docker image, you need to provide two build arguments:

  • TARGETARCH - a suffix of the specific local Memgraph debian version; for example if you have a local debian package memgraph-2.10-arm64.deb that you want to build platform for, use the following build argument: --build-arg="TARGETARCH=2.10-arm64".

  • NPM_PACKAGE_TOKEN - npm token to install private libraries that Memgraph Lab uses, set it up with the following argument: --build-arg="NPM_PACKAGE_TOKEN=ghp_6..."

  1. Run docker build --build-arg="TARGETARCH=..." --build-arg="NPM_PACKAGE_TOKEN=..." . -t memgraph-platform
  2. Run docker run -p 3000:3000 -p 7687:7687 memgraph-platform
  3. Go to http://localhost:3000 and connect to Memgraph database with Memgraph Lab in order to test it out

Back to top