To install MAGE through Docker or Docker Hub, you will only need
To install MAGE from source, you will need: Python3, Make, CMake, Clang, UUID, and Rust.
- Docker Hub
- Install from source
1. This is the only command you will need to make it run in your environment:
docker run -p 7687:7687 memgraph/memgraph-mage:latest
You can download specific version of MAGE. For example if you want to download version
you should run following command:
docker run -p 7687:7687 memgraph/memgraph-mage:0.1
From github you can download specific version, or you can download what is currently on
0. Download the MAGE source code from GitHub
git clone https://github.com/memgraph/mage.git && cd mage
1. Build the MAGE tagged Docker image with the following command:
docker build -t memgraph-mage .
2. Start Memgraph with the following command and enjoy MAGE:
docker run --rm -p 7687:7687 --name mage memgraph-mage
If you made any new changes while MAGE Docker container is running, you need to stop it and rebuild whole image.
1. Download the MAGE source code from
GitHub and run the
setup script. It
will generate a
dist directory with all the needed files.
python3 setup build
2. Copy the contents of the newly created
dist directory to
If you want to be quicker, you can specify a path for setup script to copy the built executables:
python3 setup build -p /usr/lib/memgraph/query_modules
3. Start Memgraph and enjoy MAGE!
Note that query modules are loaded into Memgraph on startup, so if your instance was already running, you will need to execute the following query to load them:
If your changes are not loaded, make sure to restart the instance by instancy by running
systemctl stop memgraph and
systemctl start memgraph.
If you want to find out more about loading query modules, visit this guide.
setup script offers you to set your local
mage/dist folder as default one for Memgraph configuration file
--query-modules-directory defined in
/etc/memgraph/memgraph.conf file with following step:
python3 setup modules_storage
This way Memgraph will be looking for query modules inside
mage/dist folder. Now you don't need to copy
mage/dist folder to
/usr/lib/memgraph/query_modules every time when you do