Skip to content

Commit 2c534cf

Browse files
updated README
1 parent 6a35086 commit 2c534cf

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
# Docker MCRIT
2+
[![Test](https://github.com/danielplohmann/docker-mcrit/actions/workflows/test.yml/badge.svg)](https://github.com/danielplohmann/docker-mcrit/actions/workflows/test.yml)
3+
24
Dockerized Setup for the MinHash-based Code Recognition and Investigation Toolkit (MCRIT).
35

46
## Summary
57

6-
This repository should enable you to quickly run a production-ready deployment of [MCRIT](https://github.com/danielplohmann/mcrit) including its frontend [MCRITweb](https://github.com/danielplohmann/mcritweb) with minimal effort through a pre-configured Docker setup.
8+
This repository intends to enable you to quickly run a production-ready deployment of [MCRIT](https://github.com/danielplohmann/mcrit) including its frontend [MCRITweb](https://github.com/fkie-cad/mcritweb) with minimal effort through a pre-configured Docker setup.
9+
The latest commit on this repository will always hold references to the most recent versions of the front- and backend, and stable milestone releases will be marked as such.
710

811
## Setup
912

@@ -18,7 +21,7 @@ should build the MCRIT server and worker as well as the MCRITweb images, pull im
1821
The data produced and stored by the services are found in `./storage`:
1922

2023
* `./storage/mcritweb` contains the sqlite DB for the web application and cached data, such as matching reports in JSON format
21-
* `./storage/mongodb` contains all collections and indices, allowing it to persist across instance rebuilds.
24+
* `./storage/mongodb` contains all collections and indices, allowing it to persist across MCRIT web instance rebuilds and updates.
2225

2326
### Setup for HTTP(S)
2427

@@ -45,10 +48,9 @@ Note that running in development mode will not start up NGINX, meaning you can r
4548
## Usage
4649

4750
For an explanation of the usage of MCRIT itself, please refer to the respective repositories for
48-
* [MCRIT](https://github.com/danielplohmann/mcrit) (backend, API, client, plugins)
49-
* [MCRITweb](https://github.com/danielplohmann/mcritweb) (frontend)
51+
* backend: [MCRIT](https://github.com/danielplohmann/mcrit) (documentation in preparation)
52+
* frontend: [MCRITweb](https://github.com/fkie-cad/mcritweb) ([documentation](https://github.com/fkie-cad/mcritweb/tree/master/documentation))
5053

5154
## History
5255

53-
MCRIT was officially released as version 1.0.0 at Botconf 2023.
54-
Links for the slides, presentation video, and paper will follow once available.
56+
MCRIT was officially released as version 1.0.0 at Botconf 2023 ([paper](https://journal.cecyf.fr/ojs/index.php/cybin/article/view/45), [slides](https://www.botconf.eu/wp-content/uploads/2023/04/2023-15-Plohmann_MCRIT.pdf), [video](https://www.youtube.com/watch?v=kvBHbXZZq2c&list=PL8fFmUArVzKhanPzq5HlGAUHhzRB3qDLE&index=24&ab_channel=botconfeu))

0 commit comments

Comments
 (0)