🎯 Type of documentation
Examples/Tutorials
🐛 Identified user problem
There is no concise step-by-step installation guide for Debian 12 (Bookworm) and Debian 13 (Trixie).
This creates onboarding friction: newcomers can’t reliably install, launch, and verify MailLogSentinel in ≤ 15 minutes.
The goal is to provide a guide (docs/install_debian13.md; optionally docs/install_debian12.md) covering prerequisites, installation,
systemd service & timer setup, and basic verification with copyable commands and expected outputs.
📍 Target audience
Beginner-to-intermediate Linux users running Postfix on Debian 12/13, plus first-time contributors who want to try MailLogSentinel on a fresh VM or VPS.
📋 Suggested content outline
- Prerequisites: Debian 12/13,
sudo, Postfix, Python 3, python3-venv, pip.
- Install:
apt update; create venv; install dependencies; clone repository.
- Minimal configuration to read Postfix logs.
- Create example
systemd units:
deploy/systemd/maillogsentinel.service
deploy/systemd/maillogsentinel.timer (hourly or daily)
- Enable & start:
sudo systemctl daemon-reload
- sudo systemctl enable --now maillogsentinel.service maillogsentinel.timer
- Verification:
systemctl status maillogsentinel.service
journalctl -u maillogsentinel.service --no-pager | tail -n 50
systemctl list-timers | grep maillogsentinel
- Outputs to mention: where the CSV is written; how the email report is sent/stubbed.
- Docs placement: create
docs/install_debian13.md (and optionally docs/install_debian12.md); link from README “Quick Start”.
📂 Expected deliverables
📋 Files to modify
docs/install_debian13.md, README.md (Quick Start link, deploy/systemd/maillogsentinel.service (example), deploy/systemd/maillogsentinel.timer (example)
✅ How to validate the result
- Follow the guide on a fresh Debian 13 (Trixie) or Debian 12 (Bookworm) VM.
- Provide either a screenshot or pasted output for:
systemctl status maillogsentinel.service (active or recently triggered by timer)
journalctl -u maillogsentinel.service --no-pager | tail -n 50
systemctl list-timers | grep maillogsentinel
- Confirm where the CSV is generated and how the email report is sent (or stubbed).
- No application logic changes (documentation + example
systemd units only).
🎯 Type of documentation
Examples/Tutorials
🐛 Identified user problem
There is no concise step-by-step installation guide for Debian 12 (Bookworm) and Debian 13 (Trixie).
This creates onboarding friction: newcomers can’t reliably install, launch, and verify
MailLogSentinelin ≤ 15 minutes.The goal is to provide a guide (
docs/install_debian13.md; optionallydocs/install_debian12.md) covering prerequisites, installation,systemdservice & timer setup, and basic verification with copyable commands and expected outputs.📍 Target audience
Beginner-to-intermediate Linux users running Postfix on Debian 12/13, plus first-time contributors who want to try MailLogSentinel on a fresh VM or VPS.
📋 Suggested content outline
sudo,Postfix,Python 3,python3-venv,pip.apt update;create venv; install dependencies; clone repository.systemdunits:deploy/systemd/maillogsentinel.servicedeploy/systemd/maillogsentinel.timer(hourly or daily)sudo systemctl daemon-reloadsystemctl status maillogsentinel.servicejournalctl -u maillogsentinel.service --no-pager | tail -n 50systemctl list-timers | grep maillogsentineldocs/install_debian13.md(and optionallydocs/install_debian12.md); link from README “Quick Start”.📂 Expected deliverables
📋 Files to modify
docs/install_debian13.md, README.md (Quick Start link, deploy/systemd/maillogsentinel.service (example), deploy/systemd/maillogsentinel.timer (example)
✅ How to validate the result
systemctl status maillogsentinel.service(active or recently triggered by timer)journalctl -u maillogsentinel.service --no-pager | tail -n 50systemctl list-timers | grep maillogsentinelsystemdunits only).