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>
This commit is contained in:
user
2026-02-15 01:46:21 +01:00
parent 2e2378d3ee
commit c5b0430da8
11 changed files with 351 additions and 80 deletions

View File

@@ -5,7 +5,11 @@
- Python 3.11+
- git
## Setup
For container deployment:
- podman
- podman-compose
## Bare Metal
```bash
cd ~/git/derp
@@ -14,7 +18,7 @@ make install
This creates a `.venv`, installs derp in editable mode, and adds dev tools.
## Symlink
### Symlink
```bash
make link
@@ -27,7 +31,7 @@ which derp
derp --version
```
## Manual Install
### Manual Install
```bash
python3 -m venv .venv
@@ -35,13 +39,34 @@ source .venv/bin/activate
pip install -e .
```
## Configuration
## Container (Podman)
Copy and edit the default config:
### With podman-compose
```bash
cp config/derp.toml ~/.config/derp/derp.toml
# Edit server, nick, channels
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:
@@ -50,3 +75,11 @@ Config search order:
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
```