3d9aa33ec4
Network control (CONNECT, DISCONNECT, RECONNECT, NICK, RAW), visibility (CHANNELS, CLIENTS, BACKLOG, VERSION), config management (REHASH, ADDNETWORK, DELNETWORK, AUTOJOIN), and NickServ operations (IDENTIFY, REGISTER, DROPCREDS). Total command count: 22. Adds stats()/db_size() to Backlog, add_network()/remove_network() to Router, and _connected_at timestamp to Client. 74 command tests. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
178 lines
4.6 KiB
Markdown
178 lines
4.6 KiB
Markdown
# Cheatsheet
|
|
|
|
## Run
|
|
|
|
```bash
|
|
bouncer -c config/bouncer.toml # start
|
|
bouncer -c config/bouncer.toml -v # start (debug)
|
|
bouncer --version # version
|
|
bouncer --help # help
|
|
```
|
|
|
|
## Podman
|
|
|
|
```bash
|
|
make build # build container image
|
|
make up # podman-compose up -d
|
|
make down # podman-compose down
|
|
make logs # podman logs -f bouncer
|
|
```
|
|
|
|
```bash
|
|
podman logs bouncer 2>&1 | grep -E 'INFO|WARN' # filtered logs
|
|
podman exec -it bouncer bash # shell into container
|
|
podman ps --filter name=bouncer # status
|
|
```
|
|
|
|
## Develop
|
|
|
|
```bash
|
|
make dev # install with dev deps into .venv
|
|
make test # pytest
|
|
make lint # ruff check
|
|
make fmt # black + ruff --fix
|
|
make run # run with config/bouncer.toml
|
|
make clean # rm .venv, build artifacts
|
|
```
|
|
|
|
## Client Auth
|
|
|
|
```
|
|
PASS <password> # authenticate (all networks)
|
|
```
|
|
|
|
## Bouncer Commands
|
|
|
|
### Inspection
|
|
|
|
```
|
|
/msg *bouncer HELP # list commands
|
|
/msg *bouncer STATUS # all network states
|
|
/msg *bouncer INFO libera # detailed network info
|
|
/msg *bouncer UPTIME # process uptime
|
|
/msg *bouncer NETWORKS # list networks
|
|
/msg *bouncer CREDS [network] # NickServ creds
|
|
/msg *bouncer CHANNELS [network] # joined channels + topics
|
|
/msg *bouncer CLIENTS # connected clients
|
|
/msg *bouncer BACKLOG [network] # message counts + DB size
|
|
/msg *bouncer VERSION # bouncer + Python version
|
|
```
|
|
|
|
### Network Control
|
|
|
|
```
|
|
/msg *bouncer CONNECT libera # start disconnected network
|
|
/msg *bouncer DISCONNECT libera # stop network
|
|
/msg *bouncer RECONNECT libera # restart with fresh identity
|
|
/msg *bouncer NICK libera newnick # change nick
|
|
/msg *bouncer RAW libera WHOIS user # send raw IRC command
|
|
```
|
|
|
|
### Config Management
|
|
|
|
```
|
|
/msg *bouncer REHASH # reload config file
|
|
/msg *bouncer ADDNETWORK name host=h port=N tls=yes nick=n channels=#a,#b
|
|
/msg *bouncer DELNETWORK name # remove network
|
|
/msg *bouncer AUTOJOIN net +#chan # add to autojoin
|
|
/msg *bouncer AUTOJOIN net -#chan # remove from autojoin
|
|
```
|
|
|
|
### NickServ
|
|
|
|
```
|
|
/msg *bouncer IDENTIFY libera # force IDENTIFY
|
|
/msg *bouncer REGISTER libera # trigger registration
|
|
/msg *bouncer DROPCREDS libera # delete all creds
|
|
/msg *bouncer DROPCREDS libera nick # delete one nick's creds
|
|
```
|
|
|
|
## Namespacing
|
|
|
|
```
|
|
#channel/network # channel on a specific network
|
|
nick/network # foreign nick on a specific network
|
|
own-nick # own nicks shown without suffix
|
|
```
|
|
|
|
```
|
|
/msg #libera/libera hello # send to #libera on libera network
|
|
/join #test/oftc # join #test on oftc
|
|
/join #a/libera,#b/oftc # comma-separated, different networks
|
|
```
|
|
|
|
## Connection States
|
|
|
|
```
|
|
DISCONNECTED -> CONNECTING -> REGISTERING -> PROBATION (15s) -> READY
|
|
```
|
|
|
|
| State | What happens |
|
|
|-------|-------------|
|
|
| CONNECTING | TCP + SOCKS5 + TLS handshake |
|
|
| REGISTERING | Random nick/user/realname sent to server |
|
|
| PROBATION | 15s wait, watching for K-line |
|
|
| READY | Switch to configured nick, join channels |
|
|
|
|
## Reconnect Backoff
|
|
|
|
```
|
|
5s -> 10s -> 30s -> 60s -> 120s -> 300s (cap)
|
|
```
|
|
|
|
## Config Skeleton
|
|
|
|
```toml
|
|
[bouncer]
|
|
bind / port / password
|
|
[bouncer.backlog]
|
|
max_messages / replay_on_connect
|
|
|
|
[proxy]
|
|
host / port
|
|
|
|
[networks.<name>] # repeatable
|
|
host / port / tls
|
|
nick / channels / autojoin
|
|
password # optional, IRC server PASS
|
|
```
|
|
|
|
## Files
|
|
|
|
| Path | Purpose |
|
|
|------|---------|
|
|
| `config/bouncer.toml` | Active config (gitignored) |
|
|
| `config/bouncer.example.toml` | Example template |
|
|
| `config/bouncer.db` | SQLite backlog (auto-created) |
|
|
|
|
## Backlog Queries
|
|
|
|
```sql
|
|
-- recent messages
|
|
SELECT * FROM messages ORDER BY id DESC LIMIT 20;
|
|
|
|
-- per-network counts
|
|
SELECT network, COUNT(*) FROM messages GROUP BY network;
|
|
|
|
-- last seen state
|
|
SELECT * FROM client_state;
|
|
```
|
|
|
|
## Source Layout
|
|
|
|
```
|
|
src/bouncer/
|
|
__main__.py # entry point, event loop
|
|
cli.py # argparse
|
|
config.py # TOML loader
|
|
irc.py # IRC message parse/format
|
|
namespace.py # /network encode/decode for multiplexing
|
|
proxy.py # SOCKS5 connector (local DNS, multi-IP)
|
|
network.py # server connection + state machine
|
|
client.py # client session handler
|
|
commands.py # 22 bouncer control commands (/msg *bouncer)
|
|
router.py # message routing + backlog trigger
|
|
server.py # TCP listener
|
|
backlog.py # SQLite store/replay/prune
|
|
```
|