Rename to sigcal-bot

- package src/sigcal_bot, distribution and CLI sigcal-bot
- environment variables SIGCAL_BOT_*
- database file, container names, user agents, logs and QR device name
- docs and changelog updated
This commit is contained in:
2026-11-18 17:06:40 +00:00
parent f6d0db664e
commit add77f6cb8
23 changed files with 56 additions and 56 deletions
+9 -9
View File
@@ -111,14 +111,14 @@ the phone must scan, and the server has no browser. Either:
ssh -L 8080:localhost:8080 you@server
```
Then open <http://localhost:8080/v1/qrcodelink?device_name=signal-cal-bot>
Then open <http://localhost:8080/v1/qrcodelink?device_name=sigcal-bot>
in your local browser and scan it from
**Signal → Settings → Linked devices → +**.
- **Fetch the QR as a file.** On the server:
```bash
curl -s "http://localhost:8080/v1/qrcodelink?device_name=signal-cal-bot" \
curl -s "http://localhost:8080/v1/qrcodelink?device_name=sigcal-bot" \
-o /tmp/link-qr.png
```
@@ -199,8 +199,8 @@ https.
### 3. Verify, preview, run
```bash
docker compose run --rm bot python -m signal_cal_bot --check # config + account
docker compose run --rm bot python -m signal_cal_bot --dump # rendered posts, no sending
docker compose run --rm bot python -m sigcal_bot --check # config + account
docker compose run --rm bot python -m sigcal_bot --dump # rendered posts, no sending
docker compose up -d bot
docker compose logs -f bot
```
@@ -209,10 +209,10 @@ docker compose logs -f bot
| Command | Purpose |
|---|---|
| `signal-cal-bot --config config.toml` | Run the loop |
| `signal-cal-bot --once` | Run a single tick and exit |
| `signal-cal-bot --dump` | Print rendered posts for the feed; uses a temporary DB, sends nothing |
| `signal-cal-bot --check` | Validate config and confirm the Signal account is linked |
| `sigcal-bot --config config.toml` | Run the loop |
| `sigcal-bot --once` | Run a single tick and exit |
| `sigcal-bot --dump` | Print rendered posts for the feed; uses a temporary DB, sends nothing |
| `sigcal-bot --check` | Validate config and confirm the Signal account is linked |
All commands accept `--log-level` (or `LOG_LEVEL`).
@@ -258,7 +258,7 @@ All commands accept `--log-level` (or `LOG_LEVEL`).
| Follow logs | `docker compose logs -f bot` |
| Apply config changes | edit `config.toml`, then `docker compose restart bot` |
| Update code | `git pull && docker compose up -d --build` |
| Reset duplicate/seen state | stop bot, delete `data/signal-cal-bot.sqlite3`, start (re-seeds silently) |
| Reset duplicate/seen state | stop bot, delete `data/sigcal-bot.sqlite3`, start (re-seeds silently) |
| Clear image cache | `rm -rf cache/images` |
| Back up | `signal-data/` (linked-device keys) and `config.toml` |