Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/raimue/flaticron
flaticron sends mail notifications for pending Flatpak updates.
https://github.com/raimue/flaticron
automation bash flatpak mail-notification monitoring scripts sysadmin update-checker
Last synced: 21 days ago
JSON representation
flaticron sends mail notifications for pending Flatpak updates.
- Host: GitHub
- URL: https://github.com/raimue/flaticron
- Owner: raimue
- License: lgpl-2.1
- Created: 2024-03-28T16:40:05.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-03-28T23:00:52.000Z (8 months ago)
- Last Synced: 2024-10-04T21:55:57.002Z (about 1 month ago)
- Topics: automation, bash, flatpak, mail-notification, monitoring, scripts, sysadmin, update-checker
- Language: Shell
- Homepage: https://raimue.blog/2024/03/28/flaticron-send-mail-notifications-for-pending-flatpak-updates/
- Size: 28.3 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
# flaticron
flaticron sends daily mail reminders about pending updates for applications and runtimes installed by [Flatpak](https://flatpak.org/). It is similar to the tools apticron[^apticron] for apt on Debian and porticron[^porticron] for portage on Gentoo.
# Prerequisites
flaticron uses [mailx(1)](https://manpages.debian.org/testing/bsd-mailx/mailx.1.en.html) and assumes you have setup an MTA such as exim4 or postfix to send mail. The recommended setup is a satellite system with an external smarthost as mail relay.
# Installation
## Debian
Download the Debian package from the [latest release](https://github.com/raimue/flaticron/releases/) and install it locally:
```
wget https://github.com/raimue/flaticron/releases/download/v0.1/flaticron_0.1_all.deb
sudo apt install ./flaticron_0.1_all.deb
```
## Manual installation from git repository
Install dependencies:
```
# Build dependencies
sudo apt install git
# Runtime dependencies
sudo apt install flatpak bash
```
Install flaticron:
```
git clone https://github.com/raimue/flaticron.git
cd flaticron
sudo make install
```
# Quick start
## System installation
If you use the recommended system-wide installation, no special setup is necessary. Make sure you receive mail for the user *root* by configuring your address in /etc/aliases accordingly. As an alternative, set the mail address for your user in the config file at `/etc/flaticron/flaticron.conf`.
For automatic daily update checks, enable the systemd timer in the system-wide installation:
```
sudo systemctl enable --now flaticron.timer
```
For a manual run, just run the `flaticron` script to send a mail. Alternatively, use the `--stdout` argument on command line to view the report directly in your terminal:
```
flaticron --stdout
```
## User installation
If you prefer `flatpak --user`, you can configure the email address for your user in the config file in ~/.config/flaticron/flaticron.conf. Otherwise it will be delivered to the local mailbox,
```
EMAIL="[email protected]"
```
Then enable the systemd timer unit for your user session:
```
systemctl --user enable --now flaticron.timer
```
## Additional custom Flatpak installations
If you are using [custom Flatpak installations](https://docs.flatpak.org/en/latest/tips-and-tricks.html#adding-a-custom-installation) with `flatpak --installation=extra`, you can also enable system-wide systemd timers with template units.
To enable the systemd timer unit for a custom installation named "extra":
```
sudo systemctl enable --now [email protected]
```
# Detailed usage
The systemd timers as provided with flaticron run once a day by default.
If you prefer classic cron over systemd, you can also add a manual command to the crontab:
```
flaticron
--config Read this additional config file
--stdout Print the report to standard output instead of sending mail
--user Show only pending updates for user installation
--system Show only pending updates for system installation
--installation=NAME Show only pending updates for a non-default system-wide installation
--help Show this help text
```
By default, flaticron operates the same as flatpak and reports pending updates for both the system and user installation. If you install applications and runtimes to the Flatpak user installation, simply run the command as your own user. If you use the recommended system-wide installation, you can run the flaticron command from your crontab or use the provided systemd units.
flaticron is configured with builtin defaults, which can be overriden from the following configuration files. They are read in this order, in which later files may override earlier options:
- /etc/flaticron/flaticron.conf
- ${XDG\_CONFIG\_HOME}/flaticron/flaticron.conf (by default $HOME/.config/flaticron/flaticron.conf)
Look at the system-wide file for the detailed description of available options.
# Packaging
While this repository contains supporting files to package flaticron for Debian, it can also be used on any other distribution. You are welcome to package flaticron for your Linux distribution of choice.
# License
flaticron is published under the same license as the Flatpak framework. See COPYING for the full license text.
SPDX-License-Identifier: LGPL-2.1-or-later
# References
[^apticron]: https://salsa.debian.org/debian/apticron
[^porticron]: https://github.com/gentoo/porticron
[modeline]: # ( vim: set et sw=2 ts=2 tw=0 wrap: )