mirror of https://github.com/isjerryxiao/pacroller.git synced 2024-12-23 22:59:24 +08:00

The "Unattended Upgrades" for Arch Linux.

Find a file

Jerry b7f162f637 update known_output for dkms		2023-09-19 16:46:36 +08:00
src/pacroller	update known_output for dkms	2023-09-19 16:46:36 +08:00
.gitignore	push to github	2021-01-15 23:30:01 +08:00
LICENSE	push to github	2021-01-15 23:30:01 +08:00
pacroller.service	better communicate the reason of inhibition	2021-04-08 11:40:28 +00:00
pacroller.timer	add Persistent to timer, hopefully fixes #2	2021-02-09 10:32:59 +08:00
README.md	add telegram message notification support	2023-05-30 00:23:33 +10:00
setup.py	release v0.1.8	2023-09-03 15:15:14 +08:00

README.md

Pacroller

The "Unattended Upgrades" for Arch Linux.

Concept

Parsing the output of pacman and pacman.log, searching for known patterns and notifying the user whether there is a potential error. Currently the design is regex-based, any output that is unable to match a set of regex is reported back to the user.

Installation

yay -S pacroller

Usage

pacroller has the following subcommands

run [-d --debug]
    start an upgrade
    if the upgrade fails or pacroller determines that human action is required,
    pacroller writes an exception to the status database, and refuses to run again
    without resetting its failure status.
status [-v --verbose] [-m --max <number>]
    print details of a previously successful upgrade
reset
    reset the current failure status
test-mail
    send test mails to all configured notification destinations

There is also a systemd timer for scheduled automatic upgrades.

Configuration

Pacroller reads /etc/pacroller/config.json on startup.

custom sync commands

Pacroller can be configured to use custom sync commands, which allows the usage of a different set of mirrors when syncing the database. Enable the "custom_sync" option and write your custom /etc/pacroller/sync.sh.

needrestart

If the "needrestart" option is enabled, needrestart should be called after a successful upgrade.

hold packages

Put your hold packages in a json keyval {package name: regex}, where the regex should have at least one matching group. If pacroller observes any changes of the matching group or the hold package is to be removed, it refuses to upgrade further.

ignored pacnew

A list of pacnew files that are silently ignored during parsing, any other pacnews will trigger a warning and prevent further upgrades.

custom pacman hooks and packages

Custom pacman hooks and packages output matching is configurable via /etc/pacroller/known_output_override.py.

check systemd status

The "systemd-check" option allows pacroller to check fo degraded systemd services before an upgrade.

check news from archinux.org

Automatically checks news before upgrade, unless "news-check" is set to false.

clear package cache

Pacroller wipes /var/cache/pacman/pkg after a successful upgrade if the option "clear_pkg_cache" is set.

save pacman output

Every time an upgrade is performed, the pacman output is stored into /var/log/pacroller. This can be configured via the "save_stdout" keyword.

Notification

When configuring your notification system, please note that pacroller will not send any notification if stdin is a tty (can be overridden by the --interactive switch). Notification will be sent through all configured methods when it requires manual inspection. Currently, two notification methods are supported: SMTP and telegram

SMTP

Configure /etc/pacroller/smtp.json to receive email notifications.

Configure /etc/pacroller/telegram.json to receive telegram notifications.

Limitations

Your favourite package may not be supported, however it's easy to add another set of rules.
Restarting the whole system after a kernel upgrade is not implemented.
Human interaction is required occasionally.