Skip to content

Commit 5d10fa6

Browse files
author
Davide Arcuri
committed
update README
1 parent 5982cac commit 5d10fa6

File tree

1 file changed

+7
-15
lines changed

1 file changed

+7
-15
lines changed

README.md

+7-15
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@ Orochi - The Volatility Collaborative GUI
1919
- [Orochi](#orochi)
2020
- [Table of Contents](#table-of-contents)
2121
- [About Orochi](#about-orochi)
22-
- [Orochi Architecture](#orochi-architecture)
2322
- [Fastest way to try Orochi](#fastest-way-to-try-orochi)
23+
- [Orochi architecture](#orochi-architecture)
2424
- [Getting started](#getting-started)
2525
- [Installation](#installation)
2626
- [Quick Start Guide](#quick-start-guide)
27-
- [User Guide](#user-guide)
28-
- [Admin Guide](#admin-guide)
29-
- [API Guide](#api-guide)
27+
- [User guide](#user-guide)
28+
- [Admin guide](#admin-guide)
29+
- [API guide](#api-guide)
3030
- [Deploy to Swarm](#deploy-to-swarm)
3131
- [Community](#community)
3232
- [Contributing](#contributing)
@@ -41,7 +41,7 @@ Orochi is an open source framework for collaborative forensic memory dump analys
4141

4242
## Fastest way to try Orochi
4343

44-
For people who prefer to install and try first and then read the guide:
44+
For people who prefer to install and try first and then read the guide:
4545
```
4646
sudo sysctl -w vm.max_map_count=262144
4747
git clone https://github.com/LDO-CERT/orochi.git
@@ -55,13 +55,11 @@ Browse http://127.0.0.1:8000 and access with admin//admin
5555
## Orochi architecture
5656

5757
- uses [Volatility 3](https://github.com/volatilityfoundation/volatility3): the world’s most widely used framework for extracting digital artifacts from volatile memory (RAM) samples.
58-
- saves Volatility results in [ElasticSearch](https://github.com/elastic/elasticsearch)
5958
- distributes loads among nodes using [Dask](https://github.com/dask/dask)
6059
- uses [Django](https://github.com/django/django) as frontend
6160
- uses [Postgresql](https://github.com/postgres/postgres) to save users, analysis metadata such status and errors.
6261
- uses [MailHog](https://github.com/mailhog/MailHog) to manage the users registration emails
6362
- uses [Redis](https://github.com/redis/redis) for cache and websocket for notifications
64-
- [Kibana](https://github.com/elastic/kibana) interface is provided for ElasticSearch maintenance (checking indexes, deleting if something hangs)
6563
- all framework is provided as [docker-compose](https://github.com/docker/) images
6664

6765
## Getting started
@@ -77,8 +75,6 @@ Using Docker-compose you can start multiple dockers and link them together.
7775
cd orochi
7876
```
7977

80-
- ElasticSearch container likes [big mmap count](https://www.elastic.co/guide/en/elasticsearch/reference/current/vm-max-map-count.html) so from shell do `sysctl -w vm.max_map_count=262144` otherwise docker image of Elastic would not start. To set this value permanently, add `vm.max_map_count=262144` in /etc/sysctl.conf.
81-
8278
In case you are running docker on Windows you can do `wsl -d docker-desktop sysctl -w vm.max_map_count=262144` from PowerShell.
8379

8480
- You need to set some useful variables that docker-compose will use for [configure the environment](https://cookiecutter-django.readthedocs.io/en/latest/developing-locally-docker.html#configuring-the-environment)
@@ -99,7 +95,6 @@ Using Docker-compose you can start multiple dockers and link them together.
9995
USE_DOCKER=yes
10096
IPYTHONDIR=/app/.ipython
10197
REDIS_URL=redis://redis:6379/0
102-
ELASTICSEARCH_URL=http://es01:9200
10398
DASK_SCHEDULER_URL=tcp://scheduler:8786
10499
```
105100

@@ -119,25 +114,23 @@ Using Docker-compose you can start multiple dockers and link them together.
119114

120115
- Now it's time to fire up the images!
121116
```
122-
docker-compose up
117+
docker-compose up
123118
```
124119

125120

126121
- When finished - it takes a while - you can check the status of images:
127122
```
128123
docker ps -a
129124
```
130-
125+
131126
````
132127
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
133128
40b14376265d ghcr.io/ldo-cert/orochi_django:latest "/entrypoint /start" 6 hours ago Up 6 hours 0.0.0.0:8000->8000/tcp, :::8000->8000/tcp orochi_django
134129
016533025d9b redis:6.2.5 "docker-entrypoint.s…" 6 hours ago Up 6 hours 0.0.0.0:6379->6379/tcp, :::6379->6379/tcp orochi_redis
135130
2cada5c22475 mailhog/mailhog:v1.0.1 "MailHog" 6 hours ago Up 6 hours 1025/tcp, 0.0.0.0:8025->8025/tcp, :::8025->8025/tcp orochi_mailhog
136131
3e56e4f5b58e ghcr.io/ldo-cert/orochi_postgres:latest "docker-entrypoint.s…" 6 hours ago Up 6 hours 0.0.0.0:5432->5432/tcp, :::5432->5432/tcp orochi_postgres
137132
0bb7f1a293ef daskdev/dask:2021.10.0-py3.9 "tini -g -- /usr/bin…" 6 hours ago Up 6 hours 0.0.0.0:8786-8787->8786-8787/tcp, :::8786-8787->8786-8787/tcp orochi_scheduler
138-
581925199a67 kibana:7.14.2 "/bin/tini -- /usr/l…" 6 hours ago Up 6 hours 0.0.0.0:5601->5601/tcp, :::5601->5601/tcp orochi_kib01
139133
10049fb631a4 ghcr.io/ldo-cert/orochi_worker:latest "tini -g -- /usr/bin…" 6 hours ago Up 6 hours orochi_worker_2
140-
749371fdc91f elasticsearch:7.14.2 "/bin/tini -- /usr/l…" 6 hours ago Up 6 hours 0.0.0.0:9200->9200/tcp, :::9200->9200/tcp, 9300/tcp orochi_es01
141134
8e144a0c8972 ghcr.io/ldo-cert/orochi_worker:latest "tini -g -- /usr/bin…" 6 hours ago Up 6 hours orochi_worker_1
142135
143136
```
@@ -183,7 +176,6 @@ Applications links:
183176
- Orochi homepage: http://127.0.0.1:8000
184177
- Orochi admin: http://127.0.0.1:8000/admin
185178
- Mailhog: http://127.0.0.1:8025
186-
- Kibana: http://127.0.0.1:5601
187179
- Dask: http://127.0.0.1:8787
188180

189181
### User guide

0 commit comments

Comments
 (0)