Install Memgraph Lab and connect to a database

We recommend you use the Memgraph Platform and get the complete streaming graph application platform that includes:

• Memgraph - the database that holds your data
• Memgraph Lab - visual user interface for running queries and visualizing graph data
• mgconsole - command-line interface for running queries
• MAGE - graph algorithms and modules library

After running the image, mgconsole will open in the terminal while Memgraph Lab is available on http://localhost:3000.

If you want to install Memgraph Lab as a desktop application, check out the installation instructions for Windows, macOS and Linux, and if you have a public Memgraph database instance you can access the Lab web application at https://lab.memgraph.com/ (opens in a new tab).

Install Memgraph Lab desktop application

sudo dpkg -i MemgraphLab-x.x.x.deb

CREATE (u:User {name: "Alice"})-[:Likes]->(m:Software {name: "Memgraph"});

MATCH p=()-[]->() RETURN p;

Run Memgraph Lab with Docker

Run the Memgraph Lab Docker image using the following command:

docker run -d -p 3000:3000  --name lab memgraph/lab

Once the container is up you can access Memgraph Lab on localhost:3000 (opens in a new tab).

Issues when connecting to Memgraph

Memgraph Lab detects if Memgraph is running on localhost:7687 by default for the Quick Connect. The environment variables that are responsible for Quick Connect working as expected are QUICK_CONNECT_MG_HOST, QUICK_CONNECT_MG_PORT and QUICK_CONNECT_MG_IS_ENCRYPTED. The handling of the QUICK_CONNECT_MG_HOST environment variable differs based on the operating system:

• Mac or Windows: The host.docker.internal hostname allows Docker containers to connect to the host machine. Set this as the value for QUICK_CONNECT_MG_HOST when running Lab on Mac or Windows to enable connection to Memgraph running on the host:

  docker run -d -p 3000:3000 -e QUICK_CONNECT_MG_HOST=host.docker.internal --name lab memgraph/lab

• Linux: There's no need to set QUICK_CONNECT_MG_HOST as it defaults to localhost, assuming Memgraph is running locally on the host machine.

You can also use the QUICK_CONNECT_MG_PORT environment variable to specify the quick connect port number, e.g. - e QUICK_CONNECT_MG_PORT=7688.

Environment variables

Configure Memgraph Lab using the following environment variables when running it through Docker, including Docker Compose:

When running Memgraph Lab using Docker, configure the environment variables to adjust settings. Use the Docker run command as follows to set these variables:

docker run -d -p 3000:3000 --name lab -e QUERY_MAX_LEN=10000 -e MODULE_NAME_MAX_LEN=2500 memgraph/lab

For Docker Compose, define the same environment variables within the environment section of your service configuration in the docker-compose.yml file:

environment:
  - QUERY_MAX_LEN=10000
  - MODULE_NAME_MAX_LEN=2500