This is a starting point Fedora Silverblue image designed to be customized to whatever you want, have GitHub build it for you, and then host it for you. You then just tell your computer to boot off of that image. GitHub keeps 90 days worth image backups for you, thanks Microsoft!

For more info, check out the uBlue homepage and the main uBlue repo

Getting started

See the Make Your Own -page in the documentation for quick setup instructions for setting up your own repository based on this template.

Don't worry, it only requires some basic knowledge about using the terminal and git.

Note

Everywhere in this repository, make sure to replace ublue-os/startingpoint with the details of your own repository. Unless you used create-ublue-image, in which case the previous repo identifier should already be your repo's details.

Customization

The easiest way to start customizing is by looking at and modifying recipe.yml. It's documented using comments and should be pretty easy to understand.

For the base-container field, you can use any other native container image. You will get all the features of that image, plus the ones added here! Check out the uBlue images list to decide what to use!

If you want to add custom configuration files, you can just add them in the etc directory. If you need to add other directories, you can look at the Containerfile to see how it's done. Writing to any directories under /var in Fedora Silverblue are not supported and will not work, as those are user-managed.

Installation

Warning

This is an experimental feature and should not be used in production, try it in a VM for a while! If you are rebasing and not doing a clean install do a touch ~/.config/ublue/firstboot-done to keep your flatpak configuration untouched BEFORE you rebase, otherwise we're going to mangle it (for science).

To rebase an existing Silverblue/Kinoite installation to the latest build:

sudo rpm-ostree rebase ostree-unverified-registry:ghcr.io/ublue-os/startingpoint:latest

This repository builds date tags as well, so if you want to rebase to a particular day's build:

sudo rpm-ostree rebase ostree-unverified-registry:ghcr.io/ublue-os/startingpoint:20221217

The latest tag will automatically point to the latest build. Note that when a new version of Fedora is released that the latest tag will get updated to that latest release automatically.

Just

The just task runner is included in main for further customization after first boot. The firstboot script copies the justfile from /etc/justfile to your home directory. After that run the following commands:

just - Show all tasks, more will be added in the future
just bios - Reboot into the system bios (Useful for dualbooting)
just changelogs - Show the changelogs of the pending update
Set up distroboxes for the following images:
- just distrobox-boxkit
- just distrobox-debian
- just distrobox-opensuse
- just distrobox-ubuntu
just setup-flatpaks - Install all of the flatpaks declared in recipe.yml
just setup-gaming - Install Steam, Heroic Game Launcher, OBS Studio, Discord, Boatswain, Bottles, and ProtonUp-Qt. MangoHud is installed and enabled by default, hit right Shift-F12 to toggle
just update - Update rpm-ostree, flatpaks, and distroboxes in one command

Check the just website for tips on modifying and adding your own recipes.

Verification

These images are signed with sisgstore's cosign. You can verify the signature by downloading the cosign.pub key from this repo and running the following command:

cosign verify --key cosign.pub ghcr.io/ublue-os/base

If you're forking this repo you should read the docs on keeping secrets in github. You need to generate a new keypair with cosign. The public key can be in your public repo (your users need it to check the signatures), and you can paste the private key in Settings -> Secrets -> Actions.