orochi

(โ˜… 275)

The Volatility Collaborative GUI

  • .deepsource.toml
  • .dockerignore
  • .editorconfig
  • .env.sample
  • .gitattributes
  • .gitignore
  • .pre-commit-config.yaml
  • .pylintrc
  • CHANGELOG.md
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • CONTRIBUTORS.txt
  • docker-compose-swarm.yml
  • docker-compose.override.yml.example
  • docker-compose.yml
  • LICENSE
  • manage.py
  • pyproject.toml
  • pytest.ini
  • README.md
  • SECURITY.md
  • setup.cfg
  • tailwind.config.js
  • tailwindcss
  • uv.lock
  • version.py

# Installation Guide

1. Get the code
git clone https://github.com/LDO-CERT/orochi

Downloads the entire project code from GitHub to your computer.

cd orochi

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
sudo docker-compose up

Runs the command against the services defined in the compose file.

docker-compose pull

Runs the command against the services defined in the compose file.

docker-compose build

Runs the command against the services defined in the compose file.

docker-compose up

Runs the command against the services defined in the compose file.

docker ps -a

Type this command into your terminal and run it.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install .

Installs the package published on PyPI directly โ€” no need to clone the source.

python manage.py runserver

Starts the Django development server.

โœ… If it runs without errors and prints output in the terminal, it worked.
// repository documentation