c5b0430da8
- 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>
86 lines
1.3 KiB
Markdown
86 lines
1.3 KiB
Markdown
# Installation
|
|
|
|
## Prerequisites
|
|
|
|
- Python 3.11+
|
|
- git
|
|
|
|
For container deployment:
|
|
- podman
|
|
- podman-compose
|
|
|
|
## Bare Metal
|
|
|
|
```bash
|
|
cd ~/git/derp
|
|
make install
|
|
```
|
|
|
|
This creates a `.venv`, installs derp in editable mode, and adds dev tools.
|
|
|
|
### Symlink
|
|
|
|
```bash
|
|
make link
|
|
```
|
|
|
|
Installs `derp` to `~/.local/bin/`. Verify:
|
|
|
|
```bash
|
|
which derp
|
|
derp --version
|
|
```
|
|
|
|
### Manual Install
|
|
|
|
```bash
|
|
python3 -m venv .venv
|
|
source .venv/bin/activate
|
|
pip install -e .
|
|
```
|
|
|
|
## Container (Podman)
|
|
|
|
### With podman-compose
|
|
|
|
```bash
|
|
cp config/derp.toml.example config/derp.toml
|
|
# Edit config/derp.toml
|
|
make up
|
|
```
|
|
|
|
### Manual
|
|
|
|
```bash
|
|
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:
|
|
|
|
```bash
|
|
cp config/derp.toml.example config/derp.toml
|
|
```
|
|
|
|
Config search order:
|
|
|
|
1. Path given via `--config`
|
|
2. `./config/derp.toml`
|
|
3. `~/.config/derp/derp.toml`
|
|
4. Built-in defaults
|
|
|
|
## Verification
|
|
|
|
```bash
|
|
derp --version # Check install
|
|
make test # Run test suite
|
|
make lint # Lint check
|
|
```
|