From 93a04dcf6763b40f3c0b4511fd4aef81b04d334d Mon Sep 17 00:00:00 2001 From: msm Date: Sat, 8 Jun 2024 17:49:21 +0200 Subject: [PATCH 1/2] Small documentation fixes --- INSTALL.md | 6 ++++-- README.md | 2 +- docs/how-to/install-native.md | 2 +- 3 files changed, 6 insertions(+), 4 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 25c2ec2f..a8ad18c7 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -12,7 +12,7 @@ Supported installation and deployment methods: Quick build & run with [docker compose](https://docs.docker.com/compose/). ``` -git clone --recurse-submodules https://github.com/CERT-Polska/mquery.git +git clone 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 @@ -20,6 +20,7 @@ mkdir samples # expect files in ./samples directory, and keep index in ./index. vim .env docker-compose up --scale daemon=3 # this will take a while +docker-compose exec web python3 -m mquery.db ``` - Good for testing mquery and production deployments on a single server @@ -30,13 +31,14 @@ docker-compose up --scale daemon=3 # this will take a while Docker compose dedicated for developers. ``` -git clone --recurse-submodules https://github.com/CERT-Polska/mquery.git +git clone 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 +docker-compose exec dev-web python3 -m mquery.db ``` - Good for development - all file changes will be picked up automatically. diff --git a/README.md b/README.md index 9ba5ee41..27918c9e 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Public instance will be created soon, stay tuned... The easiest way to do this is with `docker-compose`: ``` -git clone --recurse-submodules https://github.com/CERT-Polska/mquery.git +git clone https://github.com/CERT-Polska/mquery.git cd mquery vim .env # optional - change samples and index directory locations docker-compose up --scale daemon=3 # building the images will take a while diff --git a/docs/how-to/install-native.md b/docs/how-to/install-native.md index 504ff494..dad31690 100644 --- a/docs/how-to/install-native.md +++ b/docs/how-to/install-native.md @@ -82,7 +82,7 @@ You can also compile it yourself: ```shell cd /opt -git clone --recurse-submodules https://github.com/CERT-Polska/ursadb.git +git clone https://github.com/CERT-Polska/ursadb.git cd /opt/ursadb mkdir build; cd build cmake -D CMAKE_BUILD_TYPE=Release .. # requires gcc 7+ From d1b8da2d9abbc5edfd3e76cb12d107571277adb4 Mon Sep 17 00:00:00 2001 From: msm Date: Sat, 8 Jun 2024 18:27:10 +0200 Subject: [PATCH 2/2] Small documentation fixes --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 27918c9e..c54125c5 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,7 @@ git clone https://github.com/CERT-Polska/mquery.git cd mquery vim .env # optional - change samples and index directory locations docker-compose up --scale daemon=3 # building the images will take a while +docker-compose exec web python3 -m mquery.db ``` The web interface should be available at `http://localhost`.