isogenerator/README.md

3.3 KiB

UBlueOS ISO Generator

This action is used to generate the ISO images for UBlueOS.

Makefile

A Makefile is provided for ease of use. There are separate targets for each file generated, however make can be used to generate the final image and make clean can be used to clean up the workspace.

See Customizing for information about customizing the image that gets created.

Container

A container with the necessary tools already installed is provided at ghcr.io/ublue-os/isogenerator:latest

To use the container file, run docker run --privileged --volume .:/isogenerator/output ghcr.io/ublue-os/isogenerator.

This will create an ISO with the baked in defaults of the container image.

See Customizing for information about customizing the image that gets created. The variable can either be defined as environment variables or as command arguments. Examples:

Creating Bluefin GTS ISO

docker run --rm --privileged --volume .:/isogenerator/output -e VERSION=38 -e IMAGE_NAME=bluefin -e IMAGE_TAG=gts -e VARIANT=Silverblue ghcr.io/ublue-os/isogenerator:38

Creating Bazzite Latest ISO

docker run --rm --privileged --volume .:/isogenerator/output -e VERSION=39 -e IMAGE_NAME=bazzite -e IMAGE_TAG=latest -e VARIANT=Kinoite ghcr.io/ublue-os/isogenerator:39

Customizing

The following variables can be used to customize the create image.

  • ARCH
    Architecture for image to build
    Default Value: x86_64
  • VERSION
    Fedora version of installer to build
    Default Value: 39
  • IMAGE_REPO
    Repository containing the source container image
    Default Value: ghcr.io/ublue-os
  • IMAGE_NAME
    Name of the source container image
    Default Value: base-main
  • IMAGE_TAG
    Tag of the source container image
    Default Value: VERSION
  • VARIANT
    Source container variant Available options can be found by running dnf provides system-release. Variant will be the third item in the package name. Example: fedora-release-kinoite-39-34.noarch will be kinonite
    Default Value: Silverblue
  • WEB_UI
    Enable Anaconda WebUI
    Default Value: false

VSCode Dev Container

There is a dev container configuration provided for development. By default it will use the existing container image available at ghcr.io/ublue-os/isogenerator, however, you can have it build a new image by editing .devcontainer/devcontainer.json and replacing image with build. Ctrl+/ can be used to comment and uncomment blocks of code within VSCode.

The code from VSCode will be available at /workspaces/isogenerator once the container has started.

Privileged is required for access to loop devices for lorax.

Use existing image

{
	"name": "Existing Dockerfile",
	// "build": {
	// 	"context": "..",
	// 	"dockerfile": "../Containerfile",
	// 	"args": {
	// 		"version": "39"
	// 	}
	// },
	"image": "ghcr.io/ublue-os/isogenerator:latest",
	"overrideCommand": true,
	"shutdownAction": "stopContainer",
	"privileged": true
}

Build a new image

{
	"name": "Existing Dockerfile",
	"build": {
		"context": "..",
		"dockerfile": "../Containerfile",
		"args": {
			"version": "39"
		}
	},
	//"image": "ghcr.io/ublue-os/isogenerator:latest",
	"overrideCommand": true,
	"shutdownAction": "stopContainer",
	"privileged": true
}