diff --git a/README.md b/README.md index b0a3627..9b35001 100644 --- a/README.md +++ b/README.md @@ -4,29 +4,16 @@ Small update program written in golang intended for use in Universal Blue, updat Includes systemd timers and services for auto update -# Usage +# Installation -## Installation - -You can add this to your image by simply pulling down and installing the rpm: - -``` -COPY --from=ghcr.io/ublue-os/ublue-update:latest /rpms/ublue-upd.rpm /tmp/rpms/ -RUN rpm-ostree install /tmp/rpms/ublue-upd.rpm -``` - -If you are on an image derived from uBlue main: - -``` -COPY --from=ghcr.io/ublue-os/ublue-update:latest /rpms/ublue-upd.rpm /tmp/rpms/ -RUN rpm-ostree override remove ublue-os-update-services && rpm-ostree install /tmp/rpms/ublue-upd.rpm -``` +There will eventually be a COPR with the RPM +In the meantime it's possible to build the binary statically and copy the files (binary, polkit rules, and systemd units) refer to [How do I build this](#How-do-I-build-this?) for more info > **Note** > If you are on an image derived from uBlue main, you will need to remove or disable automatic updates with rpm-ostreed, to do this, you need to remove or change this line in the config file: `AutomaticUpdatePolicy=stage` (set to `none` if you don't want to remove the line) -## Command Line +# Command Line To run a complete system update, it's recommended to use systemd: @@ -37,7 +24,7 @@ $ systemctl start ublue-upd.service This allows for passwordless system updates (user must be in `wheel` group) -### Run updates from command line (not recommended) +## Run updates from command line (not recommended) ``` $ sudo ublue-upd @@ -65,14 +52,14 @@ Flags: Use "ublue-upd [command] --help" for more information about a command. ``` -## Troubleshooting +# Troubleshooting You can check the ublue-update logs by running this command: ``` $ journalctl -exu 'ublue-upd.service' ``` -## How do I build this? +# How do I build this? 1. `just build` will build this project and place the binary in `output/ublue-upd` 1. `sudo ./output/ublue-upd` will run a system update