/xs-update-manjaro

Update script for Manjaro

Primary LanguageShell

xs-update-manjaro

ReadMe for Beta/Dev (Switch to Stable)

Table of Contents

↕

Summary

This is a highly configurable, non-interactive script for automating updates for Manjaro Linux. It supports updating the following:

  • Main system packages (via pacman)
  • AUR packages (via an AUR helper)
  • Flatpak packages

Status Notifications are currently supported on the following Desktop Environments:

Suggested Usage and Disclaimer:

No warranty or guarantee is included or implied. Use at your own risk.

Please do not use this script blindly. You should have a firm understanding of how to manually update your computer before using this. You can learn about updating your computer at the following:

This is not a replacement for manually updating/maintaining your own computer, but a supplement. This script automates what it can, but updates needing manual steps (for example, merging .pacnew files) will still need those. Some of the manual steps have been incorporated into this script, but your system(s) may require additional manual steps depending on what packages you have installed.

Always have external bootable media (like a flash drive with manjaro on it) available in case the system becomes unbootable.

Execution Overview

↕

Overview of what the script does from start to finish. Some steps may be slightly out of order for readability.

Initialization

↕
  • Define main functions
  • Load Config
  • Determine notification function (config: enable, manual selection)
  • Initialize logging (config: location)
  • Load Persistent data (config: location)
  • Export Config and Persistent data files
  • Perform checks:
    • Ensure only 1 instance is running
    • Wait up to 5 minutes for network connection
    • Check for script updates (config: enable, branch)
    • Wait up to 5 minutes for any already running instances of pacman/pikaur/apacman
    • Check for and remove db.lck
  • Start background notification process
  • Package cache cleanup (see Cleanup Tasks for details)

Update Official Repos

↕

  • Update mirrorlist (config: frequency)

    • pacman-mirrors [--geoip || -c $main_country_str]
    • Upon failure, falls back to pacman-mirrors -g

  • Update package signature keys (config: frequency)

    • pacman-key --refresh-keys

  • Check if packages are too old for script to update

    • Does not support installs with xproto<=7.0.31-1

  • Update repo databases, download package updates

  • Apply manual package changes (config: enable)

    • If pacman<5.2, switch to pacman-static
    • Required removal of known conflicting packages
    • If these actions fail, remaining repo and AUR packages are skipped

  • Update System packages

    • pacman -S --needed --noconfirm archlinux-keyring manjaro-keyring manjaro-system

  • Check for package database errors (config: enable)

    • For every package with errors:
      • create missing files/desc
      • reinstall with pacman -S --noconfirm --overwrite=* packagename

  • Update packages from Official Repos

    • pacman -Syyu[u] --needed --noconfirm [--ignore $main_ignorepkgs_str]
    • If this fails, AUR updates are skipped

Update AUR packages

↕

Cleanup Tasks

↕

  • All cleanup operations (config: enable)

    • Remove orphan packages (config: enable)

      • pacman -Rnsc $(pacman -Qtdq) --noconfirm

    • Package cache cleanup

      • Clean AUR package cache (config: enable)
        • rm -rf /var/cache/apacman/pkg/*
        • rm -rf /var/cache/pikaur/pkg/*
      • Clean AUR build cache (config: enable)
        • rm -rf /var/cache/pikaur/aur_repos/*
        • rm -rf /var/cache/pikaur/build/*
      • Clean pacman package cache

Update Flatpak

↕
  • Update flatpak packages (config: frequency)
    • flatpak update -y

Final Actions

↕
  • Stop background notification process
  • Determine final message
  • Reboot proceedure if critical system packages were updated (config: enable)
  • Final message after non-critical update (config: duration)
  • Stop auto-update service and quit

Supported Automatic Repair and Manual Changes

↕

Automatic repair

This script supports detecting and repairing the following potential issues:

Manual Changes

Every once in a while, updating Manjaro requires manual package changes to allow updates to succeed. This script supports automatically performing the following:

  • Removal: pyqt5-common<=5.13.2-1, engrampa-thunar-plugin<=1.0-2
  • Setup and use pacman-static if pacman<5.2

The oldest fresh install this script has successfully updated is Manjaro Xfce 17.1.7 (as of July of 2020). Oldest KDE and Gnome fresh installs are unknown, and not tested.

Installation and Requirements

↕

Dependencies:

This script requires these external tools/commands:

  • coreutils, pacman, pacman-mirrors, grep, ping

Installation

  1. Move script files to these locations:
ElectrodeXS.png         -> /usr/share/pixmaps/
auto-update.sh          -> /usr/share/xs/
xs-autoupdate.service   -> /etc/systemd/system/
xs-updatehelper.desktop -> /etc/xdg/autostart/

  1. Make sure auto-update.sh is allowed to execute as a program

  2. Enable running the auto-update script at startup (optional):

  • sudo systemctl enable xs-autoupdate
  1. You can manually run the script with either:
  • sudo systemctl start xs-autoupdate (start in background)
  • sudo /usr/share/xs/auto-update.sh (watch logs in real-time)

Supported AUR Helpers:

↕

If you want the script to automatically update packages from the AUR, it will need one of the following:

pikaur (recommended)

You can install pikaur with another AUR helper, or install it directly with the following:

sudo pacman -S --needed base-devel git
git clone https://aur.archlinux.org/pikaur.git
cd pikaur
makepkg -fsri

Features:

Drawbacks:

  • Does not support automatically importing PGP keys
  • (workaround: pass --skippgpcheck custom flag to packages that need it)
apacman (deprecated)

You can install apacman (deprecated) with the following:

git clone https://aur.archlinux.org/apacman.git
pushd apacman
makepkg -si --noconfirm
popd
rm -rf apacman
#Replace old apacman with my fork with fixes
sudo wget "https://raw.githubusercontent.com/lectrode/apacman/master/apacman" -O "/usr/bin/apacman"
sudo chmod +x "/usr/bin/apacman"

Features:

  • Automatically imports PGP keys for packages

Drawbacks:

  • No longer maintained upstream
  • Does not support newer AUR packages
  • Cannot pass custom makepkg flags
  • Support will be removed in future version of script

Configuration

=Overview=

  • By default settings are located at /etc/xs/auto-update.conf

  • Settings file is (re)generated on every run

  • Older settings will be converted to preserve preferences

  • True and False are 1 and 0 respectively

  • Settings location can be changed by exporting xs_autoupdate_conf environment variable

    • This needs absolute path and filename
    • Warning: whichever file is specified will be overwritten whenever the script runs
=Sample configuration file=
  • NOTE: Blank line at end may be required for last line to be parsed
aur_1helper_str=auto
aur_aftercritical_bool=0
aur_update_freq=3
aur_devel_freq=6
cln_1enable_bool=1
cln_aurbuild_bool=0
cln_aurpkg_bool=1
cln_orphan_bool=1
cln_paccache_num=1
flatpak_update_freq=3
main_country_str=
main_ignorepkgs_str=
main_logdir_str=/var/log/xs
main_perstdir_str=
main_testsite_str=www.google.com
notify_1enable_bool=1
notify_errors_bool=1
notify_function_str=auto
notify_lastmsg_num=20
notify_vsn_bool=0
reboot_1enable_num=0
reboot_delayiflogin_bool=1
reboot_delay_num=120
reboot_ignoreusers_str=nobody lightdm sddm gdm
reboot_notifyrep_num=10
repair_db01_bool=1
repair_manualpkg_bool=1
repair_pikaur01_bool=1
self_1enable_bool=1
self_branch_str=stable
update_downgrades_bool=1
update_keys_freq=30
update_mirrors_freq=1
zflag:dropbox,tor-browser=--skippgpcheck
=Custom makepkg flags for specific AUR packages=
  • Requires pikaur
  • You can add as many entries as you need
  • All packages listed in one line will be updated at the same time
  • Format: zflag:package1,package2=--flag1,--flag2,--flag3

Individual Settings

aur_1helper_str
  • Default: auto
  • Specifies which AUR helper to use to update AUR packages
  • Current valid values are: auto,none,all,pikaur,apacman
  • auto will use an available AUR helper with the following preference: pikaur > apacman
  • all will run every supported AUR helper found in this order: pikaur, apacman
  • none will not use any AUR helper
aur_aftercritical_bool
  • Default: 0 (False)
  • If set to false, script will skip AUR package updates after critical main system packages have been updated
  • If set to true, script will proceed to update AUR packages, regardless of critical main package updates
aur_update_freq
  • Default: 3
  • Every X days, update AUR packages (-1 disables all AUR updates, including devel)
aur_devel_freq
  • Default: 6
  • Every X days, update "devel" AUR packages (any package that ends in -git, -svn, etc) (-1 to disable)
  • This setting only applies if AUR packages are updated with pikaur
cln_1enable_bool
  • Default: 1 (True)
  • If set to false, disables all cleanup steps
cln_aurpkg_bool
  • Default: 1 (True)
  • If this is True, all packages built from the AUR will be deleted when finished
cln_aurbuild_bool
  • Default: 1 (True)
  • If this is True, all AUR package build folders will be deleted when finished
cln_orphan_bool
  • Default: 1 (True)
  • If this is True, obsolete dependencies will be uninstalled when finished
cln_paccache_num
  • Default: 0
  • Specifies the number of official built packages to keep in cache
  • If set to "-1" all official packages will be kept (cache is usually /var/cache/pacman/pkg)
flatpak_update_freq
  • Default: 3
  • Every X days, check for Flatpak package updates (-1 to disable)
notify_1enable_bool
  • Default: 1 (True)
  • If true, enables status notifications via notify-send to active users
notify_function_str
  • Default: auto
  • Specifies which notification method to use
  • Current valid values are: auto,gdbus,desk,send
    • auto: will automatically select the best method
    • gdbus: uses gdbus to create notifications (works on Xfce, Gnome)
    • desk: uses notify-desktop to create notifications (works on Xfce, KDE, and Gnome)
    • send: uses legacy notify-send to create notifications (works on Xfce)
  • Note: if auto or desk is specified, and an AUR helper is configured, and KDE is detected, script will attempt to install notify-desktop-git to provide this functionality
notify_lastmsg_num
  • Default: 20
  • Specifies how long (in seconds) the final "System update finished" notification is visible before it expires.
  • The "Kernel and/or drivers were updated" message does not expire, regardless of this setting
  • Requires notify_1enable_bool to be True
notify_errors_bool
  • Default: 1 (True)
  • If true, script attempts to detect errors. If any, includes message "Some packages encountered errors" in notification
notify_vsn_bool
  • Default: 0 (False)
  • If true, the version number of the script will be included in notifications
main_ignorepkgs_str
  • Default: (blank)
  • Packages (if any) to ignore, separated by spaces (these are in addition to those stored in pacman.conf)
main_logdir_str
  • Default: /var/log/xs
  • Defines the directory where the log will be output
main_perstdir_str
  • Default: (blank)
  • Defines the directory where persistent timestamps are stored. If blank, uses main_logdir_str
main_country_str
  • Default: (blank)
  • If blank, pacman-mirrors --geoip is used
  • Countries separated by commas from which to pull updates
  • See output of pacman-mirrors -l for supported values
main_testsite_str
  • Default: www.google.com
  • Script checks if there is internet access by attempting to ping this address
  • Can also be an IP address
reboot_1enable_num
  • Default: 0
  • -1: Disable script reboot in all cases
  • 0: Allow script reboot only if rebooting normally may not be possible (system may be in critical state after systemd update)
  • 1: Always allow script to reboot after critical system packages have been updated
reboot_delayiflogin_bool
  • Default: 1 (True)
  • If true, the reboot will be delayed only if a user is logged in. If false, there will always be a delay
reboot_delay_num
  • Default: 120
  • Delay in seconds to wait before rebooting the computer
reboot_notifyrep_num
  • Default: 10
  • Reboot notification is updated every X seconds
  • Works best if reboot_delay_num is evenly divisible by this
reboot_ignoreusers_str
  • Default: nobody lightdm sddm gdm
  • List of users separated by spaces
  • These users will not trigger the reboot delay even if they are logged on
repair_db01_bool
  • Default: 1 (True)
  • If true, the script will detect and attempt to repair missing "desc"/"files" files in package database
  • NOTE: It does this by creating the missing files and re-installing the package(s) with overwrite=* specified
repair_manualpkg_bool
  • Default: 1 (True)
  • If true, script will check for and perform critical package changes required for continued updates
  • See Automatic Repair for specific package changes the script supports
repair_pikaur01_bool
  • Default: 1 (True)
  • If true, the script will attempt to re-install pikaur if it is not functioning
  • NOTE: Specifically needed if python is updated
self_1enable_bool
  • Default: 1 (True)
  • If true, script checks for updates for itself ("self-updates")
self_branch_str
  • Default: stable
  • Script update branch (requires self_1enable_bool be True)
  • Current valid values are: stable, beta
update_downgrades_bool
  • Default: 1 (True)
  • If true, allows pacman to downgrade packages if remote packages are a lesser version than installed
update_mirrors_freq
  • Default: 0
  • Every X days, refreshes mirror list before checking for package updates (-1 to disable)
update_keys_freq
  • Default: 30
  • Every X days, runs pacman-key --refresh-keys before checking for package updates (-1 to disable)