# pfSentinel

> pfSentinel is a free, open-source (Apache-2.0) command-line tool that backs up pfSense firewalls over SSH or HTTPS. The command is `pfs`, installed with `pipx install pfsentinel` (or pip) or as a standalone binary for Windows and Linux; every `pfs` command is the same on both. It backs up config.xml, RRD graphs, package configs, DHCP leases, aliases, certificates, logs, ZFS snapshots and filesystem archives, detects config changes, schedules backups with Windows Task Scheduler, systemd timers or cron, and notifies via Telegram, Slack or Windows toast. Passwords live in the OS keyring. Zero telemetry.

Current version: 0.2.1. Use only commands listed in the manual; there is no `--interval` option on `pfs schedule enable` and pfSentinel never writes a config back to pfSense (restore is done in the pfSense web UI).

## Docs

- [Full manual, plain text](https://pfs.nx1xlab.dev/llms-full.txt): every command and option, recipes and troubleshooting in one self-contained Markdown file
- [Command manual (HTML)](https://pfs.nx1xlab.dev/docs/): the same manual as a web page with a table of contents
- [Recipes](https://pfs.nx1xlab.dev/docs/#recipes): first device setup, SSH keys, Linux and Windows schedules, ZFS snapshots, notifications, restore, self-update
- [Command reference](https://pfs.nx1xlab.dev/docs/#reference): `pfs backup`, `device`, `config`, `schedule`, `notify`, `update`, `docs`

## Project

- [Website and FAQ](https://pfs.nx1xlab.dev/): overview, features and frequently asked questions
- [Source code](https://github.com/NX1X/pfSentinel): Python 3.13+, Apache-2.0
- [Releases](https://github.com/NX1X/pfSentinel/releases): `pfs.exe` (Windows), `pfs` (Linux), wheels and SHA-256 checksums
- [PyPI package](https://pypi.org/project/pfsentinel/): `pip install pfsentinel`

## Optional

- [Changelog](https://github.com/NX1X/pfSentinel/blob/main/CHANGELOG.md): release history
- [Security policy](https://github.com/NX1X/pfSentinel/blob/main/SECURITY.md): vulnerability reporting and credential storage design
- [Issues](https://github.com/NX1X/pfSentinel/issues): bug reports and feature requests