username/bouncer
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: rewrite all documentation for stealth connect and current state

Browse Source 
Update README, PROJECT, ROADMAP, TASKS, TODO, USAGE, CHEATSHEET,
INSTALL, and DEBUG to reflect stealth connect, probation window,
markov nick generation, local DNS resolution, and multi-IP failover.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
user
2026-02-19 18:31:20 +01:00
parent 845496f1b3
commit a58848395c
9 changed files with 402 additions and 141 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
docs/INSTALL.md
View File

@@ -12,7 +12,8 @@ cd ~/git/bouncer
make dev
```
This creates `.venv/`, installs dependencies, and registers the `bouncer` command.
This creates `.venv/`, installs all dependencies, and registers the `bouncer`
command via editable install.
## Verify
@@ -26,17 +27,46 @@ bouncer --version
cp config/bouncer.example.toml config/bouncer.toml
```
Edit `config/bouncer.toml` with your network details. At minimum, set:
Edit `config/bouncer.toml`. Required settings:
- `bouncer.password` -- client authentication password
- `networks.<name>.host` -- IRC server hostname
- `networks.<name>.nick` -- your IRC nickname
- `networks.<name>.channels` -- channels to auto-join
| Key | Description |
|-----|-------------|
| `bouncer.password` | Password for client authentication |
| `networks.<name>.host` | IRC server hostname |
| `networks.<name>.nick` | Your desired IRC nick |
Optional but recommended:
| Key | Default | Description |
|-----|---------|-------------|
| `networks.<name>.tls` | `false` | Enable TLS to IRC server |
| `networks.<name>.port` | `6667`/`6697` | Server port (auto-set by tls) |
| `networks.<name>.channels` | `[]` | Channels to auto-join |
| `networks.<name>.autojoin` | `true` | Join channels after probation |
## Symlink
The `make dev` editable install registers `bouncer` in `.venv/bin/`. To make it available system-wide:
To make `bouncer` available system-wide:
```bash
ln -sf ~/git/bouncer/.venv/bin/bouncer ~/.local/bin/bouncer
```
Verify:
```bash
which bouncer
```
## Dependencies
Installed automatically by `make dev`:
| Package | Purpose |
|---------|---------|
| `python-socks[asyncio]` | Async SOCKS5 proxy support |
| `aiosqlite` | Async SQLite for backlog |
| `ruff` | Linter (dev) |
| `black` | Formatter (dev) |
| `pytest` | Tests (dev) |
| `pytest-asyncio` | Async test support (dev) |