Skip to content

Commit

Permalink
Small documentation fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
msm-code committed Jun 8, 2024
1 parent e02a197 commit 93a04dc
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 4 deletions.
6 changes: 4 additions & 2 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,15 @@ 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
# 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
docker-compose exec web python3 -m mquery.db
```

- Good for testing mquery and production deployments on a single server
Expand All @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/how-to/install-native.md
Original file line number Diff line number Diff line change
Expand Up @@ -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+
Expand Down

0 comments on commit 93a04dc

Please sign in to comment.