Skip to content

[DOC] - How to Install MailLogSentinel on Debian 12/13 #21

Description

@monozoide

🎯 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

  1. Prerequisites: Debian 12/13, sudo, Postfix, Python 3, python3-venv, pip.
  2. Install: apt update; create venv; install dependencies; clone repository.
  3. Minimal configuration to read Postfix logs.
  4. Create example systemd units:
    • deploy/systemd/maillogsentinel.service
    • deploy/systemd/maillogsentinel.timer (hourly or daily)
  5. Enable & start:
    • sudo systemctl daemon-reload
    • sudo systemctl enable --now maillogsentinel.service maillogsentinel.timer
  6. Verification:
    • systemctl status maillogsentinel.service
    • journalctl -u maillogsentinel.service --no-pager | tail -n 50
    • systemctl list-timers | grep maillogsentinel
  7. Outputs to mention: where the CSV is written; how the email report is sent/stubbed.
  8. Docs placement: create docs/install_debian13.md (and optionally docs/install_debian12.md); link from READMEQuick Start”.

📂 Expected deliverables

  • Text written in Markdown
  • Screenshots/examples if applicable
  • Links to external resources
  • Review by a test user

📋 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).

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Projects

Status
Done
Status
Done

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions