Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update README.md to properly reflect the usage of topgrade #104

Closed
wants to merge 2 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 4 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Universal Blue Update

Small update program written in python intended for use in Universal Blue, executes update scripts/tasks placed in `/etc/ublue-update.d` (make sure each script has exec perms)
Small update program written in python intended for use in Universal Blue, uses [`topgrade`](https://github.com/topgrade-rs/topgrade) for executing updates

Includes systemd timers and services for auto update

Expand Down Expand Up @@ -74,22 +74,10 @@ $ journalctl -exu 'ublue-update.service'

# Configuration

## Update Scripts
Update scripts are separated into two directories inside of `/etc/ublue-update.d`

### `/etc/ublue-update.d/user`

Update scripts are ran as user. Scripts included:
- per-user flatpak update scripts (uninstalling unused deps and repairing flatpak install for maintenence)
- distrobox update script
- fleek update script

### `/etc/ublue-update.d/system`

Update scripts are ran as root, these updates are meant to be system-wide. Scripts included:
- OS update script (depends on [`rpm-ostree`](https://github.com/coreos/rpm-ostree))
- system-wide flatpak update scripts (uninstalling unused deps and repairing flatpak install for maintenence)
## Updates

updates are executed using [`topgrade`](https://github.com/topgrade-rs/topgrade), with `/etc/ublue-update/topgrade-system.toml` and `/etc/ublue-update/topgrade-system.toml`
check [`topgrade`](https://github.com/topgrade-rs/topgrade)'s github for configuring updates

## Location

Expand Down
Loading