Go to file
Noel Miller e36da208a8
fix: missed \ and updated README (#34)
* fix: missed \

* fix: moved variables into table and added EXTRA_BOOT_PARAMS

* Update README.md

Co-authored-by: Robert Sturla <robertsturla@outlook.com>

---------

Co-authored-by: Robert Sturla <robertsturla@outlook.com>
2024-02-25 14:19:17 +00:00
.devcontainer general fixes 2024-02-16 23:40:48 +00:00
.github feat(ci): Added ability to run the workflow manually and fix: general fixes (#17) 2024-02-20 17:36:12 -05:00
lorax_templates feat: Add Secure Boot Support and Remove Grub Entry for Test this Media (#28) 2024-02-23 18:10:17 +00:00
scripts fix: Ignore Valve Steam Deck hardware due to using EFI but having no keys enrolled by default and add extra boot parameters (#33) 2024-02-25 01:34:23 +00:00
xorriso feat: Add Secure Boot Support and Remove Grub Entry for Test this Media (#28) 2024-02-23 18:10:17 +00:00
.gitignore general fixes 2024-02-16 23:40:48 +00:00
Containerfile feat(ci): Added ability to run the workflow manually and fix: general fixes (#17) 2024-02-20 17:36:12 -05:00
LICENSE fix: Update LICENSE to Apache 2.0 2024-02-20 14:46:51 -06:00
Makefile fix: Ignore Valve Steam Deck hardware due to using EFI but having no keys enrolled by default and add extra boot parameters (#33) 2024-02-25 01:34:23 +00:00
README.md fix: missed \ and updated README (#34) 2024-02-25 14:19:17 +00:00
action.yml fix: missed \ and updated README (#34) 2024-02-25 14:19:17 +00:00

README.md

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.

Variable Description Default Value
ARCH Architecture for image to build x86_64
VERSION Fedora version of installer to build 39
IMAGE_REPO Repository containing the source container image ghcr.io/ublue-os
IMAGE_NAME Name of the source container image base-main
IMAGE_TAG Tag of the source container image VERSION
EXTRA_BOOT_PARAMS Extra params used by grub to boot the anaconda installer [empty]
VARIANT Source container variant* Kinoite
WEB_UI Enable Anaconda WebUI (experimental) false

Available options for VARIANT 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 kinoite

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
}