How to use SSL encryption

Memgraph uses SSL (Secure Sockets Layer) protocol for establishing an authenticated and encrypted connection to a database instance.

Docker

1. Start a Memgraph instance with docker run command including the -v mg_lib:/var/lib/memgraph and -v mg_etc:/etc/memgraph volumes.

2. Copy the SSL certificate inside of the Docker container or use Memgraph self-signed certificates (cert.pem and key.pem) located at /etc/memgraph/ssl/.

3. Change the configuration file to include the following configuration flags:

   --bolt-cert-file=<path>
   --bolt-key-file=<path>

4. Set the flags to the paths of your SSL certificate.

   If you are using the Memgraph self-signed certificate, set the configuration flags to:

   --bolt-cert-file=/etc/memgraph/ssl/cert.pem
   --bolt-key-file=/etc/memgraph/ssl/key.pem

5. Stop the Docker container, then start it again, including the volumes you used in step 1.

   If you are running memgraph-platform image, pass the configuration flag

   MGCONSOLE="--use-ssl=true":

   docker run -it -p 7687:7687 -p 3000:3000 -v mg_lib:/var/lib/memgraph -v mg_etc:/etc/memgraph -e MGCONSOLE="--use-ssl=true" memgraph/memgraph-platform

6. Open Memgraph Lab and switch to Connect Manually view, turn the SSL On and connect.

   

7. If you are using pymgclient to query the database with Python, add sslmode=mgclient.MG_SSLMODE_REQUIRE to the mgclient.connect

For other ways of connecting to Memgraph DB using SSL encryption, check the reference guide.

Linux

1. Run Memgraph.

2. Open the configuration file available at /etc/memgraph/memgraph.conf.

3. Change the configuration file to include the following configuration flags:

   --bolt-cert-file=<path>
   --bolt-key-file=<path>

4. Set the flags to the paths of your SSL certificate, or use Memgraph self-signed certificates (cert.pem and key.pem) located at /etc/memgraph/ssl/:

   --bolt-cert-file=/etc/memgraph/ssl/cert.pem
   --bolt-key-file=/etc/memgraph/ssl/key.pem

5. Restart Memgraph.

6. Open Memgraph Lab and switch to Connect Manually view, turn the SSL On and connect.

7. If you are using pymgclient to query the database with Python, add sslmode=mgclient.MG_SSLMODE_REQUIRE to the mgclient.connect

For other ways of connecting to Memgraph DB using SSL encryption, check the reference guide.