Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix/small doc fixes #391

Merged
merged 2 commits into from
Sep 13, 2024
Merged

Fix/small doc fixes #391

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
93a04dc
Small documentation fixes
msm-code Jun 8, 2024
d1b8da2
Small documentation fixes
msm-code Jun 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions INSTALL.md
View file
Open in desktop
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
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,11 @@ 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
docker-compose exec web python3 -m mquery.db
```

The web interface should be available at `http://localhost`.
Expand Down
2 changes: 1 addition & 1 deletion docs/how-to/install-native.md
View file
Open in desktop
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
Loading