Files

user c5b0430da8 docs: add podman-compose, update all project documentation

- docker-compose.yml for podman-compose deployment
- Makefile: add up/down/logs compose targets
- README: plugin table, container quickstart, make targets
- PROJECT: plugin categories, deployment matrix, design decisions
- ROADMAP: v0.1 done, v0.2 current, v0.3-v1.0 planned
- TASKS: current sprint with priorities
- TODO: full backlog organized by wave
- CHEATSHEET: reorganized by category (OSINT, Red Team, OPSEC)
- INSTALL: container deployment instructions
- DEBUG: container logs, hot-reload, DNS troubleshooting
- USAGE: all 19 commands documented

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

2026-02-15 01:46:21 +01:00

1.3 KiB

Raw Blame History

Installation

Prerequisites

Python 3.11+
git

For container deployment:

podman
podman-compose

Bare Metal

cd ~/git/derp
make install

This creates a .venv, installs derp in editable mode, and adds dev tools.

Symlink

make link

Installs derp to ~/.local/bin/. Verify:

which derp
derp --version

Manual Install

python3 -m venv .venv
source .venv/bin/activate
pip install -e .

Container (Podman)

With podman-compose

cp config/derp.toml.example config/derp.toml
# Edit config/derp.toml
make up

Manual

podman build -t derp .
podman run -d --name derp \
    -v ./config/derp.toml:/app/config/derp.toml:ro,Z \
    -v ./plugins:/app/plugins:ro,Z \
    derp --verbose

The image contains only the Python package. Config and plugins are bind-mounted at runtime, so edits on the host are picked up by !reload without rebuilding.

Configuration

Copy and edit the example config:

cp config/derp.toml.example config/derp.toml

Config search order:

Path given via --config
./config/derp.toml
~/.config/derp/derp.toml
Built-in defaults

Verification

derp --version          # Check install
make test               # Run test suite
make lint               # Lint check

1.3 KiB Raw Blame History