diff --git a/README.md b/README.md index 0c54a51..c811c0d 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,23 @@ # bling -[![build-ublue](https://github.com/ublue-os/bling/actions/workflows/build.yml/badge.svg)](https://github.com/ublue-os/bling/actions/workflows/build.yml) +[![build-ublue](https://github.com/blue-build/modules/actions/workflows/build.yml/badge.svg)](https://github.com/blue-build/modules/actions/workflows/build.yml) This repository containes modules to use in recipe.yml. See list of modules in [./modules](./modules/) ## Usage You can add this to your Containerfile to copy the modules from this image over: + ```dockerfile -COPY --from=ghcr.io/ublue-os/bling:latest /modules /tmp/modules/ +COPY --from=ghcr.io/blue-build/modules:latest /modules /tmp/modules/ ``` ## Verification These images are signed with sisgstore's [cosign](https://docs.sigstore.dev/cosign/overview/). You can verify the signature by downloading the `cosign.pub` key from this repo and running the following command: + ```sh -cosign verify --key cosign.pub ghcr.io/ublue-os/bling +cosign verify --key cosign.pub ghcr.io/blue-build/modules ``` ## See what is in this image @@ -25,7 +27,7 @@ cosign verify --key cosign.pub ghcr.io/ublue-os/bling NOTE: This makes it so you need to extract everything from the base image! ```sh -podman save ghcr.io/ublue-os/bling:latest -o bling.tar +podman save ghcr.io/blue-build/modules:latest -o bling.tar tar xf bling.tar && rm bling.tar tar xf *.tar ``` @@ -35,6 +37,7 @@ This should extract the image in a way that you can see everything in it! ### Using [Dive](https://github.com/wagoodman/dive) This method allows you to inspect the image through a TUI + ```sh -dive ghcr.io/ublue-os/bling:latest +dive ghcr.io/blue-build/modules:latest ``` diff --git a/modules.json b/modules.json index 5f78a3e..4bd69c9 100644 --- a/modules.json +++ b/modules.json @@ -1,13 +1,13 @@ [ - "https://raw.githubusercontent.com/ublue-os/bling/main/modules/akmods/module.yml", - "https://raw.githubusercontent.com/ublue-os/bling/main/modules/bling/module.yml", - "https://raw.githubusercontent.com/ublue-os/bling/main/modules/default-flatpaks/module.yml", - "https://raw.githubusercontent.com/ublue-os/bling/main/modules/files/module.yml", - "https://raw.githubusercontent.com/ublue-os/bling/main/modules/fonts/module.yml", - "https://raw.githubusercontent.com/ublue-os/bling/main/modules/gschema-overrides/module.yml", - "https://raw.githubusercontent.com/ublue-os/bling/main/modules/rpm-ostree/module.yml", - "https://raw.githubusercontent.com/ublue-os/bling/main/modules/script/module.yml", - "https://raw.githubusercontent.com/ublue-os/bling/main/modules/signing/module.yml", - "https://raw.githubusercontent.com/ublue-os/bling/main/modules/systemd/module.yml", - "https://raw.githubusercontent.com/ublue-os/bling/main/modules/yafti/module.yml" + "https://raw.githubusercontent.com/blue-build/modules/main/modules/akmods/module.yml", + "https://raw.githubusercontent.com/blue-build/modules/main/modules/bling/module.yml", + "https://raw.githubusercontent.com/blue-build/modules/main/modules/default-flatpaks/module.yml", + "https://raw.githubusercontent.com/blue-build/modules/main/modules/files/module.yml", + "https://raw.githubusercontent.com/blue-build/modules/main/modules/fonts/module.yml", + "https://raw.githubusercontent.com/blue-build/modules/main/modules/gschema-overrides/module.yml", + "https://raw.githubusercontent.com/blue-build/modules/main/modules/rpm-ostree/module.yml", + "https://raw.githubusercontent.com/blue-build/modules/main/modules/script/module.yml", + "https://raw.githubusercontent.com/blue-build/modules/main/modules/signing/module.yml", + "https://raw.githubusercontent.com/blue-build/modules/main/modules/systemd/module.yml", + "https://raw.githubusercontent.com/blue-build/modules/main/modules/yafti/module.yml" ] diff --git a/modules/akmods/module.yml b/modules/akmods/module.yml index 2aadaa5..3a50ab1 100644 --- a/modules/akmods/module.yml +++ b/modules/akmods/module.yml @@ -1,10 +1,10 @@ name: akmods shortdesc: The akmods module is a tool used for managing and installing kernel modules built by Universal Blue. -readme: https://raw.githubusercontent.com/ublue-os/bling/main/modules/akmods/README.md +readme: https://raw.githubusercontent.com/blue-build/modules/main/modules/akmods/README.md example: | type: akmods install: - openrazer - openrgb - v4l2loopback - - winesync \ No newline at end of file + - winesync diff --git a/modules/bling/module.yml b/modules/bling/module.yml index 267058c..73c0eaf 100644 --- a/modules/bling/module.yml +++ b/modules/bling/module.yml @@ -1,6 +1,6 @@ name: bling shortdesc: The bling module can be used to pull in small "bling" into your image. -readme: https://raw.githubusercontent.com/ublue-os/bling/main/modules/bling/README.md +readme: https://raw.githubusercontent.com/blue-build/modules/main/modules/bling/README.md example: | type: bling install: @@ -9,4 +9,4 @@ example: | # - dconf-update-service # a service unit that updates the dconf db on boot # - gnome-vrr # enables gnome-vrr for your image # - laptop # installs TLP and configures your system for laptop usage - # - flatpaksync # allows synchronization of user-installed flatpaks, see separate documentation section \ No newline at end of file + # - flatpaksync # allows synchronization of user-installed flatpaks, see separate documentation section diff --git a/modules/default-flatpaks/module.yml b/modules/default-flatpaks/module.yml index de91979..5e2d9dc 100644 --- a/modules/default-flatpaks/module.yml +++ b/modules/default-flatpaks/module.yml @@ -1,6 +1,6 @@ name: default-flatpaks shortdesc: The default-flatpaks module can be used to install or uninstall flatpaks from a configurable remote on every boot. -readme: https://raw.githubusercontent.com/ublue-os/bling/main/modules/default-flatpaks/README.md +readme: https://raw.githubusercontent.com/blue-build/modules/main/modules/default-flatpaks/README.md example: | modules: # configured multiple times to highlight how options are overridden - type: default-flatpaks @@ -35,4 +35,4 @@ example: | user: # repo-name will overwrite the previously-configured repo-name for the user remote repo-name: flathub-user - repo-title: "Flathub (User) \ No newline at end of file + repo-title: "Flathub (User) diff --git a/modules/files/README.md b/modules/files/README.md index 57c0c67..96d1fcb 100644 --- a/modules/files/README.md +++ b/modules/files/README.md @@ -3,5 +3,5 @@ The `files` module simplifies the process of copying files to the image during the build time. These files are sourced from the `config/files` directory, which is located at `/tmp/config/files` inside the image. :::note -If you want to place any files in `/etc/`, you should place them in `/usr/etc/` instead, which will be used to generate `/etc/` on a booted system. That is the proper directory for "system" configuration templates on atomic Fedora distros, whereas `/etc/` is meant for manual overrides and editing by the machine's admin AFTER installation! See issue https://github.com/ublue-os/startingpoint/issues/28. -::: \ No newline at end of file +If you want to place any files in `/etc/`, you should place them in `/usr/etc/` instead, which will be used to generate `/etc/` on a booted system. That is the proper directory for "system" configuration templates on atomic Fedora distros, whereas `/etc/` is meant for manual overrides and editing by the machine's admin AFTER installation! See issue https://github.com/blue-build/legacy-template/issues/28. +::: diff --git a/modules/files/module.yml b/modules/files/module.yml index c482ff8..15508ba 100644 --- a/modules/files/module.yml +++ b/modules/files/module.yml @@ -1,9 +1,9 @@ name: files shortdesc: The files module simplifies the process of copying files to the image during the build time. -readme: https://raw.githubusercontent.com/ublue-os/bling/main/modules/files/README.md +readme: https://raw.githubusercontent.com/blue-build/modules/main/modules/files/README.md example: | type: files files: - usr: /usr # usr: file/folder inside config/files/ to copy (config/files/usr/ in the repository) - # /usr: destination on the final system \ No newline at end of file + # /usr: destination on the final system diff --git a/modules/gschema-overrides/module.yml b/modules/gschema-overrides/module.yml index ea513c5..c6a27b3 100644 --- a/modules/gschema-overrides/module.yml +++ b/modules/gschema-overrides/module.yml @@ -1,6 +1,6 @@ name: gschema-overrides shortdesc: The `gschema-overrides` module can be used for including system-setting overrides for GTK-based desktop environments. -readme: https://raw.githubusercontent.com/ublue-os/bling/main/modules/gschema-overrides/README.md +readme: https://raw.githubusercontent.com/blue-build/modules/main/modules/gschema-overrides/README.md example: | type: gschema-overrides include: diff --git a/modules/script/module.yml b/modules/script/module.yml index 26bba3a..13ba00e 100644 --- a/modules/script/module.yml +++ b/modules/script/module.yml @@ -1,7 +1,7 @@ name: script shortdesc: The script module can be used to run arbitrary scripts at image build time. -readme: https://raw.githubusercontent.com/ublue-os/bling/main/modules/script/README.md +readme: https://raw.githubusercontent.com/blue-build/modules/main/modules/script/README.md example: | type: script scripts: - - myscript.sh # will run config/scripts/myscript.sh \ No newline at end of file + - myscript.sh # will run config/scripts/myscript.sh diff --git a/modules/systemd/module.yml b/modules/systemd/module.yml index 9a0a16e..03b79e0 100644 --- a/modules/systemd/module.yml +++ b/modules/systemd/module.yml @@ -1,6 +1,6 @@ name: systemd shortdesc: The systemd module streamlines the management of systemd units during image building. -readme: https://raw.githubusercontent.com/ublue-os/bling/main/modules/systemd/README.md +readme: https://raw.githubusercontent.com/blue-build/modules/main/modules/systemd/README.md example: | type: systemd system: @@ -20,4 +20,4 @@ example: | masked: - example.service # Masked (does not run for the user, under any circumstances) unmasked: - - example.service # Unmasked (runs for the user, even if previously masked) \ No newline at end of file + - example.service # Unmasked (runs for the user, even if previously masked) diff --git a/modules/yafti/README.md b/modules/yafti/README.md index 4b9d3ed..9730c55 100644 --- a/modules/yafti/README.md +++ b/modules/yafti/README.md @@ -4,4 +4,4 @@ The [`yafti`](https://github.com/ublue-os/yafti) module can be used to install [ Optionally, a list of Flatpak names and IDs can be included under `custom-flatpaks:`. These will be enabled by default under their own section on the Flatpak installation screen of `yafti`. -A default version of the `yafti` configuration file, `yafti.yml`, is supplied by this module. To make your own, create the file at `/usr/share/ublue-os/firstboot/yafti.yml`. The default version of the file can be found [here](https://github.com/ublue-os/bling/blob/main/modules/yafti/yafti.yml). \ No newline at end of file +A default version of the `yafti` configuration file, `yafti.yml`, is supplied by this module. To make your own, create the file at `/usr/share/ublue-os/firstboot/yafti.yml`. The default version of the file can be found [here](https://github.com/blue-build/modules/blob/main/modules/yafti/yafti.yml).