How to install mquery

Supported installation and deployment methods:

• docker-compose.yml
• docker-compose.dev.yml
• bare metal
• kubernetes

Docker compose

Quick build & run with docker compose.

git clone --recurse-submodules https://github.com/CERT-Polska/mquery.git
cd mquery
mkdir samples
# now set SAMPLES_DIR to a directory with your files, and INDEX_DIR to
# empty directory for database files to live in. By default database will
# expect files in ./samples directory, and keep index in ./index.
vim .env
docker-compose up --scale daemon=3  # this will take a while

• Good for testing mquery and production deployments on a single server
• Poor for development

Docker compose (dev)

Docker compose dedicated for developers.

git clone --recurse-submodules https://github.com/CERT-Polska/mquery.git
cd mquery
# now set SAMPLES_DIR to a directory with your files, and INDEX_DIR to
# empty directory for database files to live in. By default database will
# expect files in ./samples directory, and keep index in ./index.
vim .env
docker-compose -f docker-compose.dev.yml up  # this will take a while

• Good for development - all file changes will be picked up automatically.
• Poor for production

Bare metal

• Read How to: Install mquery natively (without docker)

Kubernetes

Not strictly supported, but production ready - it’s used internally in a few places, including CERT.PL.