Update test-iso.yml

2024-03-05 19:08:26 +09:00 · 2024-03-05 19:07:11 +09:00 · 2024-03-05 18:56:17 +09:00 · 2024-03-04 16:42:27 +00:00 · 2024-03-04 16:31:48 +00:00 · 2024-02-29 19:49:22 +00:00
17 changed files with 954 additions and 863 deletions
--- a/.devcontainer/devcontainer.json
+++ b/.devcontainer/devcontainer.json
@ -0,0 +1,16 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/docker-existing-dockerfile
+{
+	"name": "Existing Dockerfile",
+	// "build": {
+	// 	"context": "..",
+	// 	"dockerfile": "../Containerfile",
+	// 	"args": {
+	// 		"version": "39"
+	// 	}
+	// },
+	"image": "ghcr.io/ublue-os/isogenerator:latest",
+	"overrideCommand": true,
+	"shutdownAction": "stopContainer",
+	"privileged": true
+}
--- a/.dockerignore
+++ b/.dockerignore
@ -0,0 +1,5 @@
+.devcontainer
+.git*
+*.md
+action.yml
+LICENSE
--- a/.github/workflows/build-container-image.yml
+++ b/.github/workflows/build-container-image.yml
@ -0,0 +1,188 @@
+---
+name: Build Container Image
+on:
+  merge_group:
+  pull_request:
+    branches:
+      - main
+    paths-ignore:
+      - '*.md'
+      - 'LICENSE'
+      - 'CODEOWNERS'
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+env:
+  IMAGE_NAME: "isogenerator"
+  IMAGE_REGISTRY: ghcr.io/${{ github.repository_owner }}
+
+jobs:
+  push-image:
+    name: Build and push container image
+    runs-on: ubuntu-22.04
+    permissions:
+      contents: read
+      packages: write
+    strategy:
+      fail-fast: false
+      matrix:
+        version: 
+          - 38
+          - 39
+          - 40
+        include:
+          - version: 39
+            is_latest_version: true
+            is_stable_version: true
+    steps:
+      # Checkout push-to-registry action GitHub repository
+      - name: Checkout Push to Registry action
+        uses: actions/checkout@v4
+
+      - name: Generate tags
+        id: generate-tags
+        shell: bash
+        run: |
+          # Generate a timestamp for creating an image version history
+          TIMESTAMP="$(date +%Y%m%d)"
+          VARIANT="${{ matrix.version }}"
+
+          COMMIT_TAGS=()
+          BUILD_TAGS=()
+
+          # Have tags for tracking builds during pull request
+          SHA_SHORT="${GITHUB_SHA::7}"
+          COMMIT_TAGS+=("pr-${{ github.event.number }}-${VARIANT}")
+          COMMIT_TAGS+=("${SHA_SHORT}-${VARIANT}")
+
+          if [[ "${{ matrix.is_latest_version }}" == "true" ]] && \
+             [[ "${{ matrix.is_stable_version }}" == "true" ]]; then
+              COMMIT_TAGS+=("pr-${{ github.event.number }}")
+              COMMIT_TAGS+=("${SHA_SHORT}")
+          fi
+
+          BUILD_TAGS=("${VARIANT}")
+
+          # Append matching timestamp tags to keep a version history
+          for TAG in "${BUILD_TAGS[@]}"; do
+              BUILD_TAGS+=("${TAG}-${TIMESTAMP}")
+          done
+
+          if [[ "${{ matrix.is_latest_version }}" == "true" ]] && \
+             [[ "${{ matrix.is_stable_version }}" == "true" ]]; then
+              BUILD_TAGS+=("${TIMESTAMP}")
+              BUILD_TAGS+=("latest")
+          fi
+
+          if [[ "${{ github.event_name }}" == "pull_request" ]]; then
+              echo "Generated the following commit tags: "
+              for TAG in "${COMMIT_TAGS[@]}"; do
+                  echo "${TAG}"
+              done
+              alias_tags=("${COMMIT_TAGS[@]}")
+          else
+              alias_tags=("${BUILD_TAGS[@]}")
+          fi
+
+          echo "Generated the following build tags: "
+          for TAG in "${BUILD_TAGS[@]}"; do
+              echo "${TAG}"
+          done
+
+          echo "alias_tags=${alias_tags[*]}" >> $GITHUB_OUTPUT
+      - name: Get current version
+        id: labels
+        run: |
+          ver=$(skopeo inspect docker://ghcr.io/ublue-os/${{ env.IMAGE_NAME }}:${{ matrix.version }} | jq -r '.Labels["org.opencontainers.image.version"]')
+          echo "VERSION=$ver" >> $GITHUB_OUTPUT
+
+      # Build metadata
+      - name: Image Metadata
+        uses: docker/metadata-action@v5
+        id: meta
+        with:
+          images: |
+            ${{ env.IMAGE_NAME }}
+
+          labels: |
+            io.artifacthub.package.readme-url=https://raw.githubusercontent.com/${{ github.repository }}/main/README.md
+            org.opencontainers.image.description=Used to generate ISO installers for OCI containers
+            org.opencontainers.image.title=${{ env.IMAGE_NAME }}
+            org.opencontainers.image.version=${{ steps.labels.outputs.VERSION }}
+
+      # Build image using Buildah action
+      - name: Build Image
+        id: build_image
+        uses: redhat-actions/buildah-build@v2
+        with:
+          containerfiles: |
+            ./Containerfile
+          # Postfix image name with -custom to make it a little more descriptive
+          # Syntax: https://docs.github.com/en/actions/learn-github-actions/expressions#format
+          image: ${{ env.IMAGE_NAME }}
+          tags: |
+            ${{ steps.generate-tags.outputs.alias_tags }}
+          build-args: |
+            VERSION=${{ matrix.version }}
+          labels: ${{ steps.meta.outputs.labels }}
+          oci: false
+
+      # Workaround bug where capital letters in your GitHub username make it impossible to push to GHCR.
+      # https://github.com/macbre/push-to-ghcr/issues/12
+      - name: Lowercase Registry
+        id: registry_case
+        uses: ASzc/change-string-case-action@v6
+        with:
+          string: ${{ env.IMAGE_REGISTRY }}
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      # Push the image to GHCR (Image Registry)
+      - name: Push To GHCR
+        uses: redhat-actions/push-to-registry@v2
+        id: push
+        env:
+          REGISTRY_USER: ${{ github.actor }}
+          REGISTRY_PASSWORD: ${{ github.token }}
+        with:
+          image: ${{ steps.build_image.outputs.image }}
+          tags: ${{ steps.build_image.outputs.tags }}
+          registry: ${{ steps.registry_case.outputs.lowercase }}
+          username: ${{ env.REGISTRY_USER }}
+          password: ${{ env.REGISTRY_PASSWORD }}
+          extra-args: |
+            --disable-content-trust
+
+      # Sign container
+      - uses: sigstore/cosign-installer@v3.4.0
+        if: github.event_name != 'pull_request'
+
+      - name: Sign container image
+        if: github.event_name != 'pull_request'
+        run: |
+          cosign sign -y --key env://COSIGN_PRIVATE_KEY ${{ steps.registry_case.outputs.lowercase }}/${{ steps.build_image.outputs.image }}@${TAGS}
+        env:
+          TAGS: ${{ steps.push.outputs.digest }}
+          COSIGN_EXPERIMENTAL: false
+          COSIGN_PRIVATE_KEY: ${{ secrets.SIGNING_SECRET }}
+
+  check:
+    name: Check build successful
+    if: ${{ !cancelled() }}
+    runs-on: ubuntu-latest
+    needs:
+      - push-image
+    steps:
+      - name: Exit on failure for main
+        if: ${{ needs.push-image.result == 'failure' || needs.push-image.result == 'skipped' }}
+        shell: bash
+        run: exit 1
+      - name: Exit
+        shell: bash
+        run: exit 0
--- a/.github/workflows/iso.yml
+++ b/.github/workflows/iso.yml
@ -1,112 +0,0 @@
-name: Create and publish an ISO
-
-on:
-  push:
-    branches:
-      - 'main'
-    tags:
-      - 'v*'
-  pull_request:
-
-  workflow_call:
-    inputs:
-      IMAGE_VERSION:
-        required: true
-        type: string
-      IMAGE_ARCH:
-        required: true
-        type: string
-      IMAGE_NAME:
-        required: true
-        type: string
-      IMAGE_REPO:
-        required: true
-        type: string
-      VARIANT:
-        required: true
-        type: string
-      BUILD_REPO:
-        required: false
-        type: string
-        default: JasonN3/container-installer
-      BUILD_REF:
-        required: false
-        type: string
-        default: main
-
-env:
-  IMAGE_VERSION: ${{ inputs.IMAGE_VERSION || '39' }}
-  IMAGE_ARCH: ${{ inputs.IMAGE_ARCH || 'x86_64' }}
-  IMAGE_NAME: ${{ inputs.IMAGE_NAME || 'base-main' }}
-  IMAGE_REPO: ${{ inputs.IMAGE_REPO || 'ghcr.io/ublue-os' }}
-  VARIANT: ${{ inputs.VARIANT || 'Silverblue' }}
-  CURR_REPO: ${{ inputs.BUILD_REPO || github.repository }}
-  CURR_REF: ${{ inputs.BUILD_REF || github.ref }}
-
-jobs:
-  build-and-push-iso:
-    runs-on: ubuntu-latest
-    container:
-      image: fedora:39
-      options: "--privileged"
-    permissions:
-      contents: read
-      packages: write
-    steps:
-      - name: Install make and git
-        run: dnf install -y make git
-
-      - name: Checkout repository
-        uses: actions/checkout@v4
-        with:
-          repository: ${{ env.CURR_REPO }}
-          ref: ${{ env.CURR_REF }}
-          submodules: recursive
-
-      - name: Install dependencies
-        run: make install-deps
-
-      - name: Lowercase Registry
-        id: registry_case
-        uses: ASzc/change-string-case-action@v6
-        with:
-          string: ${{ env.IMAGE_REPO }}
-
-      - name: Download image
-        run: |
-          make container/${IMAGE_NAME}-${IMAGE_VERSION} \
-            arch=${IMAGE_ARCH} \
-            version=${IMAGE_VERSION} \
-            image_repo=${{ steps.registry_case.outputs.lowercase }} \
-            image_name=${IMAGE_NAME} \
-            variant=${VARIANT}
-
-      - name: Create boot.iso
-        run: |
-          make boot.iso \
-            arch=${IMAGE_ARCH} \
-            version=${IMAGE_VERSION} \
-            image_repo=${{ steps.registry_case.outputs.lowercase }} \
-            image_name=${IMAGE_NAME} \
-            variant=${VARIANT}
-
-      - name: Create deploy.iso
-        run: |
-          make ${IMAGE_NAME}-${IMAGE_VERSION}.iso \
-            arch=${IMAGE_ARCH} \
-            version=${IMAGE_VERSION} \
-            image_repo=${{ steps.registry_case.outputs.lowercase }} \
-            image_name=${IMAGE_NAME} \
-            variant=${VARIANT}
-          mkdir end_iso
-          mv ${IMAGE_NAME}-${IMAGE_VERSION}.iso end_iso/
-
-      - name: Upload ISO as artifact
-        uses: actions/upload-artifact@v4
-        with:
-          name: ${{ env.IMAGE_NAME }}-${{ env.IMAGE_VERSION }}.iso
-          path: end_iso/*.iso
-          if-no-files-found: error
-          retention-days: 0
-          compression-level: 0
-          overwrite: true
--- a/.github/workflows/test-iso.yml
+++ b/.github/workflows/test-iso.yml
@ -0,0 +1,83 @@
+name: Test Generate ISO
+
+on:
+  merge_group:
+  pull_request:
+    branches:
+      - main
+    paths-ignore:
+      - 'Containerfile'
+      - '*.md'
+      - 'LICENSE'
+      - 'CODEOWNERS'
+  workflow_dispatch:
+
+jobs:
+  build-and-push-iso:
+    name: Build ISO
+    runs-on: self-hosted
+    container:
+      image: fedora:39
+      options: "--privileged"
+      volumes:
+        - "/:/host"
+    permissions:
+      contents: read
+      packages: write
+    strategy:
+      fail-fast: false
+      matrix:
+        version: [38, 39]
+        boot: [secureboot, insecure]
+        include:
+          - boot: secureboot
+            SECURE_BOOT_KEY_URL: 'https://github.com/ublue-os/akmods/raw/main/certs/public_key.der'
+            ENROLLMENT_PASSWORD: 'ublue-os'
+            SECURE_BOOT_STRING: '-secure'
+          - boot: insecure
+            SECURE_BOOT_KEY_URL: ''
+            ENROLLMENT_PASSWORD: ''
+            SECURE_BOOT_STRING: ''
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Build ISO
+        id: build-iso
+        uses: ./
+        with:
+          ARCH: 'x86_64'
+          IMAGE_NAME: 'base-main'
+          IMAGE_REPO: 'ghcr.io/ublue-os'
+          VARIANT: 'Kinoite'
+          VERSION: ${{ matrix.version }}
+          SECURE_BOOT_KEY_URL: ${{ matrix.SECURE_BOOT_KEY_URL }}
+          ENROLLMENT_PASSWORD: ${{ matrix.ENROLLMENT_PASSWORD }}
+
+      - name: Upload ISO as artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: base-main-${{ matrix.version }}${{ matrix.SECURE_BOOT_STRING }}.iso
+          path: |
+            ${{ steps.build-iso.outputs.iso-path }}
+            ${{ steps.build-iso.outputs.checksum-path }}
+          if-no-files-found: error
+          retention-days: 0
+          compression-level: 0
+          overwrite: true
+
+  check:
+    name: Check build successful
+    if: ${{ !cancelled() }}
+    runs-on: ubuntu-latest
+    needs:
+      - build-and-push-iso
+    steps:
+      - name: Exit on failure for main
+        if: ${{ needs.build-and-push-iso.result == 'failure' || needs.build-and-push-iso.result == 'skipped' }}
+        shell: bash
+        run: exit 1
+      - name: Exit
+        shell: bash
+        run: exit 0
--- a/.gitignore
+++ b/.gitignore
@ -8,5 +8,5 @@
 /original-pkgsizes.txt
 /final-pkgsizes.txt
 /lorax.conf
-/*.iso
+/output
 /*.log
--- a/28
+++ b/28
@ -0,0 +1,28 @@
+# Used by buildah build --build-arg to create multiple different versions of the image
+ARG VERSION=39
+
+FROM fedora:${VERSION}
+
+# Set version for the environment variables in the container.
+ARG VERSION=${VERSION}
+
+ENV ARCH="x86_64"
+ENV IMAGE_NAME="base-main"
+ENV IMAGE_REPO="ghcr.io/ublue-os"
+ENV IMAGE_TAG="${VERSION}"
+ENV VARIANT="Kinoite"
+ENV VERSION="${VERSION}"
+ENV WEB_UI="false"
+ENV SECURE_BOOT_KEY_URL=""
+ENV ENROLLMENT_PASSWORD="ublue-os"
+
+COPY ./ /isogenerator
+WORKDIR /isogenerator
+
+RUN dnf install -y make && \
+  make install-deps && \
+  dnf clean all
+
+VOLUME /isogenerator/output
+
+ENTRYPOINT /isogenerator/entrypoint.sh
--- a/875
+++ b/875
@ -1,674 +1,201 @@
-                    GNU GENERAL PUBLIC LICENSE
-                       Version 3, 29 June 2007
-
- Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
-                            Preamble
-
-  The GNU General Public License is a free, copyleft license for
-software and other kinds of works.
-
-  The licenses for most software and other practical works are designed
-to take away your freedom to share and change the works.  By contrast,
-the GNU General Public License is intended to guarantee your freedom to
-share and change all versions of a program--to make sure it remains free
-software for all its users.  We, the Free Software Foundation, use the
-GNU General Public License for most of our software; it applies also to
-any other work released this way by its authors.  You can apply it to
-your programs, too.
-
-  When we speak of free software, we are referring to freedom, not
-price.  Our General Public Licenses are designed to make sure that you
-have the freedom to distribute copies of free software (and charge for
-them if you wish), that you receive source code or can get it if you
-want it, that you can change the software or use pieces of it in new
-free programs, and that you know you can do these things.
-
-  To protect your rights, we need to prevent others from denying you
-these rights or asking you to surrender the rights.  Therefore, you have
-certain responsibilities if you distribute copies of the software, or if
-you modify it: responsibilities to respect the freedom of others.
-
-  For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must pass on to the recipients the same
-freedoms that you received.  You must make sure that they, too, receive
-or can get the source code.  And you must show them these terms so they
-know their rights.
-
-  Developers that use the GNU GPL protect your rights with two steps:
-(1) assert copyright on the software, and (2) offer you this License
-giving you legal permission to copy, distribute and/or modify it.
-
-  For the developers' and authors' protection, the GPL clearly explains
-that there is no warranty for this free software.  For both users' and
-authors' sake, the GPL requires that modified versions be marked as
-changed, so that their problems will not be attributed erroneously to
-authors of previous versions.
-
-  Some devices are designed to deny users access to install or run
-modified versions of the software inside them, although the manufacturer
-can do so.  This is fundamentally incompatible with the aim of
-protecting users' freedom to change the software.  The systematic
-pattern of such abuse occurs in the area of products for individuals to
-use, which is precisely where it is most unacceptable.  Therefore, we
-have designed this version of the GPL to prohibit the practice for those
-products.  If such problems arise substantially in other domains, we
-stand ready to extend this provision to those domains in future versions
-of the GPL, as needed to protect the freedom of users.
-
-  Finally, every program is threatened constantly by software patents.
-States should not allow patents to restrict development and use of
-software on general-purpose computers, but in those that do, we wish to
-avoid the special danger that patents applied to a free program could
-make it effectively proprietary.  To prevent this, the GPL assures that
-patents cannot be used to render the program non-free.
-
-  The precise terms and conditions for copying, distribution and
-modification follow.
-
-                       TERMS AND CONDITIONS
-
-  0. Definitions.
-
-  "This License" refers to version 3 of the GNU General Public License.
-
-  "Copyright" also means copyright-like laws that apply to other kinds of
-works, such as semiconductor masks.
-
-  "The Program" refers to any copyrightable work licensed under this
-License.  Each licensee is addressed as "you".  "Licensees" and
-"recipients" may be individuals or organizations.
-
-  To "modify" a work means to copy from or adapt all or part of the work
-in a fashion requiring copyright permission, other than the making of an
-exact copy.  The resulting work is called a "modified version" of the
-earlier work or a work "based on" the earlier work.
-
-  A "covered work" means either the unmodified Program or a work based
-on the Program.
-
-  To "propagate" a work means to do anything with it that, without
-permission, would make you directly or secondarily liable for
-infringement under applicable copyright law, except executing it on a
-computer or modifying a private copy.  Propagation includes copying,
-distribution (with or without modification), making available to the
-public, and in some countries other activities as well.
-
-  To "convey" a work means any kind of propagation that enables other
-parties to make or receive copies.  Mere interaction with a user through
-a computer network, with no transfer of a copy, is not conveying.
-
-  An interactive user interface displays "Appropriate Legal Notices"
-to the extent that it includes a convenient and prominently visible
-feature that (1) displays an appropriate copyright notice, and (2)
-tells the user that there is no warranty for the work (except to the
-extent that warranties are provided), that licensees may convey the
-work under this License, and how to view a copy of this License.  If
-the interface presents a list of user commands or options, such as a
-menu, a prominent item in the list meets this criterion.
-
-  1. Source Code.
-
-  The "source code" for a work means the preferred form of the work
-for making modifications to it.  "Object code" means any non-source
-form of a work.
-
-  A "Standard Interface" means an interface that either is an official
-standard defined by a recognized standards body, or, in the case of
-interfaces specified for a particular programming language, one that
-is widely used among developers working in that language.
-
-  The "System Libraries" of an executable work include anything, other
-than the work as a whole, that (a) is included in the normal form of
-packaging a Major Component, but which is not part of that Major
-Component, and (b) serves only to enable use of the work with that
-Major Component, or to implement a Standard Interface for which an
-implementation is available to the public in source code form.  A
-"Major Component", in this context, means a major essential component
-(kernel, window system, and so on) of the specific operating system
-(if any) on which the executable work runs, or a compiler used to
-produce the work, or an object code interpreter used to run it.
-
-  The "Corresponding Source" for a work in object code form means all
-the source code needed to generate, install, and (for an executable
-work) run the object code and to modify the work, including scripts to
-control those activities.  However, it does not include the work's
-System Libraries, or general-purpose tools or generally available free
-programs which are used unmodified in performing those activities but
-which are not part of the work.  For example, Corresponding Source
-includes interface definition files associated with source files for
-the work, and the source code for shared libraries and dynamically
-linked subprograms that the work is specifically designed to require,
-such as by intimate data communication or control flow between those
-subprograms and other parts of the work.
-
-  The Corresponding Source need not include anything that users
-can regenerate automatically from other parts of the Corresponding
-Source.
-
-  The Corresponding Source for a work in source code form is that
-same work.
-
-  2. Basic Permissions.
-
-  All rights granted under this License are granted for the term of
-copyright on the Program, and are irrevocable provided the stated
-conditions are met.  This License explicitly affirms your unlimited
-permission to run the unmodified Program.  The output from running a
-covered work is covered by this License only if the output, given its
-content, constitutes a covered work.  This License acknowledges your
-rights of fair use or other equivalent, as provided by copyright law.
-
-  You may make, run and propagate covered works that you do not
-convey, without conditions so long as your license otherwise remains
-in force.  You may convey covered works to others for the sole purpose
-of having them make modifications exclusively for you, or provide you
-with facilities for running those works, provided that you comply with
-the terms of this License in conveying all material for which you do
-not control copyright.  Those thus making or running the covered works
-for you must do so exclusively on your behalf, under your direction
-and control, on terms that prohibit them from making any copies of
-your copyrighted material outside their relationship with you.
-
-  Conveying under any other circumstances is permitted solely under
-the conditions stated below.  Sublicensing is not allowed; section 10
-makes it unnecessary.
-
-  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
-
-  No covered work shall be deemed part of an effective technological
-measure under any applicable law fulfilling obligations under article
-11 of the WIPO copyright treaty adopted on 20 December 1996, or
-similar laws prohibiting or restricting circumvention of such
-measures.
-
-  When you convey a covered work, you waive any legal power to forbid
-circumvention of technological measures to the extent such circumvention
-is effected by exercising rights under this License with respect to
-the covered work, and you disclaim any intention to limit operation or
-modification of the work as a means of enforcing, against the work's
-users, your or third parties' legal rights to forbid circumvention of
-technological measures.
-
-  4. Conveying Verbatim Copies.
-
-  You may convey verbatim copies of the Program's source code as you
-receive it, in any medium, provided that you conspicuously and
-appropriately publish on each copy an appropriate copyright notice;
-keep intact all notices stating that this License and any
-non-permissive terms added in accord with section 7 apply to the code;
-keep intact all notices of the absence of any warranty; and give all
-recipients a copy of this License along with the Program.
-
-  You may charge any price or no price for each copy that you convey,
-and you may offer support or warranty protection for a fee.
-
-  5. Conveying Modified Source Versions.
-
-  You may convey a work based on the Program, or the modifications to
-produce it from the Program, in the form of source code under the
-terms of section 4, provided that you also meet all of these conditions:
-
-    a) The work must carry prominent notices stating that you modified
-    it, and giving a relevant date.
-
-    b) The work must carry prominent notices stating that it is
-    released under this License and any conditions added under section
-    7.  This requirement modifies the requirement in section 4 to
-    "keep intact all notices".
-
-    c) You must license the entire work, as a whole, under this
-    License to anyone who comes into possession of a copy.  This
-    License will therefore apply, along with any applicable section 7
-    additional terms, to the whole of the work, and all its parts,
-    regardless of how they are packaged.  This License gives no
-    permission to license the work in any other way, but it does not
-    invalidate such permission if you have separately received it.
-
-    d) If the work has interactive user interfaces, each must display
-    Appropriate Legal Notices; however, if the Program has interactive
-    interfaces that do not display Appropriate Legal Notices, your
-    work need not make them do so.
-
-  A compilation of a covered work with other separate and independent
-works, which are not by their nature extensions of the covered work,
-and which are not combined with it such as to form a larger program,
-in or on a volume of a storage or distribution medium, is called an
-"aggregate" if the compilation and its resulting copyright are not
-used to limit the access or legal rights of the compilation's users
-beyond what the individual works permit.  Inclusion of a covered work
-in an aggregate does not cause this License to apply to the other
-parts of the aggregate.
-
-  6. Conveying Non-Source Forms.
-
-  You may convey a covered work in object code form under the terms
-of sections 4 and 5, provided that you also convey the
-machine-readable Corresponding Source under the terms of this License,
-in one of these ways:
-
-    a) Convey the object code in, or embodied in, a physical product
-    (including a physical distribution medium), accompanied by the
-    Corresponding Source fixed on a durable physical medium
-    customarily used for software interchange.
-
-    b) Convey the object code in, or embodied in, a physical product
-    (including a physical distribution medium), accompanied by a
-    written offer, valid for at least three years and valid for as
-    long as you offer spare parts or customer support for that product
-    model, to give anyone who possesses the object code either (1) a
-    copy of the Corresponding Source for all the software in the
-    product that is covered by this License, on a durable physical
-    medium customarily used for software interchange, for a price no
-    more than your reasonable cost of physically performing this
-    conveying of source, or (2) access to copy the
-    Corresponding Source from a network server at no charge.
-
-    c) Convey individual copies of the object code with a copy of the
-    written offer to provide the Corresponding Source.  This
-    alternative is allowed only occasionally and noncommercially, and
-    only if you received the object code with such an offer, in accord
-    with subsection 6b.
-
-    d) Convey the object code by offering access from a designated
-    place (gratis or for a charge), and offer equivalent access to the
-    Corresponding Source in the same way through the same place at no
-    further charge.  You need not require recipients to copy the
-    Corresponding Source along with the object code.  If the place to
-    copy the object code is a network server, the Corresponding Source
-    may be on a different server (operated by you or a third party)
-    that supports equivalent copying facilities, provided you maintain
-    clear directions next to the object code saying where to find the
-    Corresponding Source.  Regardless of what server hosts the
-    Corresponding Source, you remain obligated to ensure that it is
-    available for as long as needed to satisfy these requirements.
-
-    e) Convey the object code using peer-to-peer transmission, provided
-    you inform other peers where the object code and Corresponding
-    Source of the work are being offered to the general public at no
-    charge under subsection 6d.
-
-  A separable portion of the object code, whose source code is excluded
-from the Corresponding Source as a System Library, need not be
-included in conveying the object code work.
-
-  A "User Product" is either (1) a "consumer product", which means any
-tangible personal property which is normally used for personal, family,
-or household purposes, or (2) anything designed or sold for incorporation
-into a dwelling.  In determining whether a product is a consumer product,
-doubtful cases shall be resolved in favor of coverage.  For a particular
-product received by a particular user, "normally used" refers to a
-typical or common use of that class of product, regardless of the status
-of the particular user or of the way in which the particular user
-actually uses, or expects or is expected to use, the product.  A product
-is a consumer product regardless of whether the product has substantial
-commercial, industrial or non-consumer uses, unless such uses represent
-the only significant mode of use of the product.
-
-  "Installation Information" for a User Product means any methods,
-procedures, authorization keys, or other information required to install
-and execute modified versions of a covered work in that User Product from
-a modified version of its Corresponding Source.  The information must
-suffice to ensure that the continued functioning of the modified object
-code is in no case prevented or interfered with solely because
-modification has been made.
-
-  If you convey an object code work under this section in, or with, or
-specifically for use in, a User Product, and the conveying occurs as
-part of a transaction in which the right of possession and use of the
-User Product is transferred to the recipient in perpetuity or for a
-fixed term (regardless of how the transaction is characterized), the
-Corresponding Source conveyed under this section must be accompanied
-by the Installation Information.  But this requirement does not apply
-if neither you nor any third party retains the ability to install
-modified object code on the User Product (for example, the work has
-been installed in ROM).
-
-  The requirement to provide Installation Information does not include a
-requirement to continue to provide support service, warranty, or updates
-for a work that has been modified or installed by the recipient, or for
-the User Product in which it has been modified or installed.  Access to a
-network may be denied when the modification itself materially and
-adversely affects the operation of the network or violates the rules and
-protocols for communication across the network.
-
-  Corresponding Source conveyed, and Installation Information provided,
-in accord with this section must be in a format that is publicly
-documented (and with an implementation available to the public in
-source code form), and must require no special password or key for
-unpacking, reading or copying.
-
-  7. Additional Terms.
-
-  "Additional permissions" are terms that supplement the terms of this
-License by making exceptions from one or more of its conditions.
-Additional permissions that are applicable to the entire Program shall
-be treated as though they were included in this License, to the extent
-that they are valid under applicable law.  If additional permissions
-apply only to part of the Program, that part may be used separately
-under those permissions, but the entire Program remains governed by
-this License without regard to the additional permissions.
-
-  When you convey a copy of a covered work, you may at your option
-remove any additional permissions from that copy, or from any part of
-it.  (Additional permissions may be written to require their own
-removal in certain cases when you modify the work.)  You may place
-additional permissions on material, added by you to a covered work,
-for which you have or can give appropriate copyright permission.
-
-  Notwithstanding any other provision of this License, for material you
-add to a covered work, you may (if authorized by the copyright holders of
-that material) supplement the terms of this License with terms:
-
-    a) Disclaiming warranty or limiting liability differently from the
-    terms of sections 15 and 16 of this License; or
-
-    b) Requiring preservation of specified reasonable legal notices or
-    author attributions in that material or in the Appropriate Legal
-    Notices displayed by works containing it; or
-
-    c) Prohibiting misrepresentation of the origin of that material, or
-    requiring that modified versions of such material be marked in
-    reasonable ways as different from the original version; or
-
-    d) Limiting the use for publicity purposes of names of licensors or
-    authors of the material; or
-
-    e) Declining to grant rights under trademark law for use of some
-    trade names, trademarks, or service marks; or
-
-    f) Requiring indemnification of licensors and authors of that
-    material by anyone who conveys the material (or modified versions of
-    it) with contractual assumptions of liability to the recipient, for
-    any liability that these contractual assumptions directly impose on
-    those licensors and authors.
-
-  All other non-permissive additional terms are considered "further
-restrictions" within the meaning of section 10.  If the Program as you
-received it, or any part of it, contains a notice stating that it is
-governed by this License along with a term that is a further
-restriction, you may remove that term.  If a license document contains
-a further restriction but permits relicensing or conveying under this
-License, you may add to a covered work material governed by the terms
-of that license document, provided that the further restriction does
-not survive such relicensing or conveying.
-
-  If you add terms to a covered work in accord with this section, you
-must place, in the relevant source files, a statement of the
-additional terms that apply to those files, or a notice indicating
-where to find the applicable terms.
-
-  Additional terms, permissive or non-permissive, may be stated in the
-form of a separately written license, or stated as exceptions;
-the above requirements apply either way.
-
-  8. Termination.
-
-  You may not propagate or modify a covered work except as expressly
-provided under this License.  Any attempt otherwise to propagate or
-modify it is void, and will automatically terminate your rights under
-this License (including any patent licenses granted under the third
-paragraph of section 11).
-
-  However, if you cease all violation of this License, then your
-license from a particular copyright holder is reinstated (a)
-provisionally, unless and until the copyright holder explicitly and
-finally terminates your license, and (b) permanently, if the copyright
-holder fails to notify you of the violation by some reasonable means
-prior to 60 days after the cessation.
-
-  Moreover, your license from a particular copyright holder is
-reinstated permanently if the copyright holder notifies you of the
-violation by some reasonable means, this is the first time you have
-received notice of violation of this License (for any work) from that
-copyright holder, and you cure the violation prior to 30 days after
-your receipt of the notice.
-
-  Termination of your rights under this section does not terminate the
-licenses of parties who have received copies or rights from you under
-this License.  If your rights have been terminated and not permanently
-reinstated, you do not qualify to receive new licenses for the same
-material under section 10.
-
-  9. Acceptance Not Required for Having Copies.
-
-  You are not required to accept this License in order to receive or
-run a copy of the Program.  Ancillary propagation of a covered work
-occurring solely as a consequence of using peer-to-peer transmission
-to receive a copy likewise does not require acceptance.  However,
-nothing other than this License grants you permission to propagate or
-modify any covered work.  These actions infringe copyright if you do
-not accept this License.  Therefore, by modifying or propagating a
-covered work, you indicate your acceptance of this License to do so.
-
-  10. Automatic Licensing of Downstream Recipients.
-
-  Each time you convey a covered work, the recipient automatically
-receives a license from the original licensors, to run, modify and
-propagate that work, subject to this License.  You are not responsible
-for enforcing compliance by third parties with this License.
-
-  An "entity transaction" is a transaction transferring control of an
-organization, or substantially all assets of one, or subdividing an
-organization, or merging organizations.  If propagation of a covered
-work results from an entity transaction, each party to that
-transaction who receives a copy of the work also receives whatever
-licenses to the work the party's predecessor in interest had or could
-give under the previous paragraph, plus a right to possession of the
-Corresponding Source of the work from the predecessor in interest, if
-the predecessor has it or can get it with reasonable efforts.
-
-  You may not impose any further restrictions on the exercise of the
-rights granted or affirmed under this License.  For example, you may
-not impose a license fee, royalty, or other charge for exercise of
-rights granted under this License, and you may not initiate litigation
-(including a cross-claim or counterclaim in a lawsuit) alleging that
-any patent claim is infringed by making, using, selling, offering for
-sale, or importing the Program or any portion of it.
-
-  11. Patents.
-
-  A "contributor" is a copyright holder who authorizes use under this
-License of the Program or a work on which the Program is based.  The
-work thus licensed is called the contributor's "contributor version".
-
-  A contributor's "essential patent claims" are all patent claims
-owned or controlled by the contributor, whether already acquired or
-hereafter acquired, that would be infringed by some manner, permitted
-by this License, of making, using, or selling its contributor version,
-but do not include claims that would be infringed only as a
-consequence of further modification of the contributor version.  For
-purposes of this definition, "control" includes the right to grant
-patent sublicenses in a manner consistent with the requirements of
-this License.
-
-  Each contributor grants you a non-exclusive, worldwide, royalty-free
-patent license under the contributor's essential patent claims, to
-make, use, sell, offer for sale, import and otherwise run, modify and
-propagate the contents of its contributor version.
-
-  In the following three paragraphs, a "patent license" is any express
-agreement or commitment, however denominated, not to enforce a patent
-(such as an express permission to practice a patent or covenant not to
-sue for patent infringement).  To "grant" such a patent license to a
-party means to make such an agreement or commitment not to enforce a
-patent against the party.
-
-  If you convey a covered work, knowingly relying on a patent license,
-and the Corresponding Source of the work is not available for anyone
-to copy, free of charge and under the terms of this License, through a
-publicly available network server or other readily accessible means,
-then you must either (1) cause the Corresponding Source to be so
-available, or (2) arrange to deprive yourself of the benefit of the
-patent license for this particular work, or (3) arrange, in a manner
-consistent with the requirements of this License, to extend the patent
-license to downstream recipients.  "Knowingly relying" means you have
-actual knowledge that, but for the patent license, your conveying the
-covered work in a country, or your recipient's use of the covered work
-in a country, would infringe one or more identifiable patents in that
-country that you have reason to believe are valid.
-
-  If, pursuant to or in connection with a single transaction or
-arrangement, you convey, or propagate by procuring conveyance of, a
-covered work, and grant a patent license to some of the parties
-receiving the covered work authorizing them to use, propagate, modify
-or convey a specific copy of the covered work, then the patent license
-you grant is automatically extended to all recipients of the covered
-work and works based on it.
-
-  A patent license is "discriminatory" if it does not include within
-the scope of its coverage, prohibits the exercise of, or is
-conditioned on the non-exercise of one or more of the rights that are
-specifically granted under this License.  You may not convey a covered
-work if you are a party to an arrangement with a third party that is
-in the business of distributing software, under which you make payment
-to the third party based on the extent of your activity of conveying
-the work, and under which the third party grants, to any of the
-parties who would receive the covered work from you, a discriminatory
-patent license (a) in connection with copies of the covered work
-conveyed by you (or copies made from those copies), or (b) primarily
-for and in connection with specific products or compilations that
-contain the covered work, unless you entered into that arrangement,
-or that patent license was granted, prior to 28 March 2007.
-
-  Nothing in this License shall be construed as excluding or limiting
-any implied license or other defenses to infringement that may
-otherwise be available to you under applicable patent law.
-
-  12. No Surrender of Others' Freedom.
-
-  If conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License.  If you cannot convey a
-covered work so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you may
-not convey it at all.  For example, if you agree to terms that obligate you
-to collect a royalty for further conveying from those to whom you convey
-the Program, the only way you could satisfy both those terms and this
-License would be to refrain entirely from conveying the Program.
-
-  13. Use with the GNU Affero General Public License.
-
-  Notwithstanding any other provision of this License, you have
-permission to link or combine any covered work with a work licensed
-under version 3 of the GNU Affero General Public License into a single
-combined work, and to convey the resulting work.  The terms of this
-License will continue to apply to the part which is the covered work,
-but the special requirements of the GNU Affero General Public License,
-section 13, concerning interaction through a network will apply to the
-combination as such.
-
-  14. Revised Versions of this License.
-
-  The Free Software Foundation may publish revised and/or new versions of
-the GNU General Public License from time to time.  Such new versions will
-be similar in spirit to the present version, but may differ in detail to
-address new problems or concerns.
-
-  Each version is given a distinguishing version number.  If the
-Program specifies that a certain numbered version of the GNU General
-Public License "or any later version" applies to it, you have the
-option of following the terms and conditions either of that numbered
-version or of any later version published by the Free Software
-Foundation.  If the Program does not specify a version number of the
-GNU General Public License, you may choose any version ever published
-by the Free Software Foundation.
-
-  If the Program specifies that a proxy can decide which future
-versions of the GNU General Public License can be used, that proxy's
-public statement of acceptance of a version permanently authorizes you
-to choose that version for the Program.
-
-  Later license versions may give you additional or different
-permissions.  However, no additional obligations are imposed on any
-author or copyright holder as a result of your choosing to follow a
-later version.
-
-  15. Disclaimer of Warranty.
-
-  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
-APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
-HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
-OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
-THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
-IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
-ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-
-  16. Limitation of Liability.
-
-  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
-THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
-GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
-USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
-DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
-PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
-EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
-SUCH DAMAGES.
-
-  17. Interpretation of Sections 15 and 16.
-
-  If the disclaimer of warranty and limitation of liability provided
-above cannot be given local legal effect according to their terms,
-reviewing courts shall apply local law that most closely approximates
-an absolute waiver of all civil liability in connection with the
-Program, unless a warranty or assumption of liability accompanies a
-copy of the Program in return for a fee.
-
-                     END OF TERMS AND CONDITIONS
-
-            How to Apply These Terms to Your New Programs
-
-  If you develop a new program, and you want it to be of the greatest
-possible use to the public, the best way to achieve this is to make it
-free software which everyone can redistribute and change under these terms.
-
-  To do so, attach the following notices to the program.  It is safest
-to attach them to the start of each source file to most effectively
-state the exclusion of warranty; and each file should have at least
-the "copyright" line and a pointer to where the full notice is found.
-
-    <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) <year>  <name of author>
-
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see <https://www.gnu.org/licenses/>.
-
-Also add information on how to contact you by electronic and paper mail.
-
-  If the program does terminal interaction, make it output a short
-notice like this when it starts in an interactive mode:
-
-    <program>  Copyright (C) <year>  <name of author>
-    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
-    This is free software, and you are welcome to redistribute it
-    under certain conditions; type `show c' for details.
-
-The hypothetical commands `show w' and `show c' should show the appropriate
-parts of the General Public License.  Of course, your program's commands
-might be different; for a GUI interface, you would use an "about box".
-
-  You should also get your employer (if you work as a programmer) or school,
-if any, to sign a "copyright disclaimer" for the program, if necessary.
-For more information on this, and how to apply and follow the GNU GPL, see
-<https://www.gnu.org/licenses/>.
-
-  The GNU General Public License does not permit incorporating your program
-into proprietary programs.  If your program is a subroutine library, you
-may consider it more useful to permit linking proprietary applications with
-the library.  If this is what you want to do, use the GNU Lesser General
-Public License instead of this License.  But first, please read
-<https://www.gnu.org/licenses/why-not-lgpl.html>.
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
--- a/176
+++ b/176
@ -1,84 +1,132 @@
-arch = x86_64
-version = 39
-base_dir = $(shell pwd)
-image_repo = ghcr.io/ublue-os
-image_name = base-main
-image_tag = $(version)
-variant = Silverblue
-web_ui = false
+# Configuration vars
+## Formatting = UPPERCASE
+ARCH = x86_64
+VERSION = 39
+IMAGE_REPO = ghcr.io/ublue-os
+IMAGE_NAME = base-main
+IMAGE_TAG = $(VERSION)
+EXTRA_BOOT_PARAMS =
+VARIANT = Kinoite
+WEB_UI = false
+ENROLLMENT_PASSWORD = ublue-os
+SECURE_BOOT_KEY_URL =

-image_repo_escaped = $(subst /,\/,$(image_repo))
-image_repo_double_escaped = $(subst \,\\\,$(image_repo_escaped))
+# Generated vars
+## Formatting = _UPPERCASE
+_BASE_DIR = $(shell pwd)
+_IMAGE_REPO_ESCAPED = $(subst /,\/,$(IMAGE_REPO))
+_IMAGE_REPO_DOUBLE_ESCAPED = $(subst \,\\\,$(_IMAGE_REPO_ESCAPED))
+_VOLID = $(firstword $(subst -, ,$(IMAGE_NAME)))-$(ARCH)-$(IMAGE_TAG)

-ifeq ($(variant),'Server')
-lorax_args = --macboot --noupgrade
+ifeq ($(VARIANT),'Server')
+_LORAX_ARGS = --macboot --noupgrade
 else
-lorax_args = --nomacboot
+_LORAX_ARGS = --nomacboot
 endif

-ifeq ($(web_ui),true)
-lorax_args += -i anaconda-webui
+ifeq ($(WEB_UI),true)
+_LORAX_ARGS += -i anaconda-webui
 endif

-$(image_name)-$(version).iso: boot.iso container/$(image_name)-$(version) xorriso/input.txt 
-	xorriso -dialog on < $(base_dir)/xorriso/input.txt
+# Step 7: Move end ISO to root
+## Default action
+$(IMAGE_NAME)-$(IMAGE_TAG).iso: output/$(IMAGE_NAME)-$(IMAGE_TAG).iso
+	mv output/$(IMAGE_NAME)-$(IMAGE_TAG).iso $(IMAGE_NAME)-$(IMAGE_TAG).iso

+# Step 6: Build end ISO file
+output/$(IMAGE_NAME)-$(IMAGE_TAG).iso: boot.iso container/$(IMAGE_NAME)-$(IMAGE_TAG) xorriso/input.txt
+	mkdir $(_BASE_DIR)/output || true
+	xorriso -dialog on < $(_BASE_DIR)/xorriso/input.txt
+	implantisomd5 $(_BASE_DIR)/output/$(IMAGE_NAME)-$(IMAGE_TAG).iso
+
+# Step 1: Generate Lorax Templates
+lorax_templates/%.tmpl: lorax_templates/%.tmpl.in
+	sed 's/@IMAGE_NAME@/$(IMAGE_NAME)/'                        $(_BASE_DIR)/lorax_templates/$*.tmpl.in > $(_BASE_DIR)/lorax_templates/$*.tmpl
+
+	sed 's/@IMAGE_TAG@/$(IMAGE_TAG)/'                          $(_BASE_DIR)/lorax_templates/$*.tmpl > $(_BASE_DIR)/lorax_templates/$*.tmpl.tmp
+	mv $(_BASE_DIR)/lorax_templates/$*.tmpl{.tmp,}
+	
+	sed 's/@IMAGE_REPO_ESCAPED@/$(_IMAGE_REPO_DOUBLE_ESCAPED)/' $(_BASE_DIR)/lorax_templates/$*.tmpl > $(_BASE_DIR)/lorax_templates/$*.tmpl.tmp
+	mv $(_BASE_DIR)/lorax_templates/$*.tmpl{.tmp,}
+
+# Step 2: Build boot.iso using Lorax
 boot.iso: lorax_templates/set_installer.tmpl lorax_templates/configure_upgrades.tmpl
-	rm -Rf $(base_dir)/results
-	lorax -p $(image_name) -v $(version) -r $(version) -t $(variant) \
-          --isfinal --buildarch=$(arch) --volid=$(image_name)-$(arch)-$(version) \
-          $(lorax_args) \
+	rm -Rf $(_BASE_DIR)/results || true
+	rm /etc/rpm/macros.image-language-conf || true
+
+	# Set the enrollment password
+	sed 's/@ENROLLMENT_PASSWORD@/$(ENROLLMENT_PASSWORD)/' $(_BASE_DIR)/scripts/enroll-secureboot-key.sh.in > $(_BASE_DIR)/scripts/enroll-secureboot-key.sh
+
+	# Download the secure boot key
+	if [ -n "$(SECURE_BOOT_KEY_URL)" ]; then\
+    curl --fail -L -o $(_BASE_DIR)/sb_pubkey.der $(SECURE_BOOT_KEY_URL);\
+	fi
+
+	# Set the default menu entry to the first one
+	sed -i 's/set default="1"/set default="0"/' /usr/share/lorax/templates.d/99-generic/config_files/x86/grub2-bios.cfg
+	sed -i 's/set default="1"/set default="0"/' /usr/share/lorax/templates.d/99-generic/config_files/x86/grub2-efi.cfg
+
+	# Add Extra Boot Parameters to all menu entries
+	sed -i 's/linux @KERNELPATH@ @ROOT@ quiet/linux @KERNELPATH@ @ROOT@ quiet $(EXTRA_BOOT_PARAMS)/g' /usr/share/lorax/templates.d/99-generic/config_files/x86/grub2-bios.cfg
+	sed -i 's/linuxefi @KERNELPATH@ @ROOT@ quiet/linuxefi @KERNELPATH@ @ROOT@ quiet $(EXTRA_BOOT_PARAMS)/g' /usr/share/lorax/templates.d/99-generic/config_files/x86/grub2-efi.cfg
+
+	sed -i 's/linux @KERNELPATH@ @ROOT@ rd.live.check quiet/linux @KERNELPATH@ @ROOT@ rd.live.check quiet $(EXTRA_BOOT_PARAMS)/g' /usr/share/lorax/templates.d/99-generic/config_files/x86/grub2-bios.cfg
+	sed -i 's/linuxefi @KERNELPATH@ @ROOT@ rd.live.check quiet/linuxefi @KERNELPATH@ @ROOT@ rd.live.check quiet $(EXTRA_BOOT_PARAMS)/g' /usr/share/lorax/templates.d/99-generic/config_files/x86/grub2-efi.cfg
+
+	sed -i 's/linux @KERNELPATH@ @ROOT@ nomodeset quiet/linux @KERNELPATH@ @ROOT@ nomodeset quiet $(EXTRA_BOOT_PARAMS)/g' /usr/share/lorax/templates.d/99-generic/config_files/x86/grub2-bios.cfg
+	sed -i 's/linuxefi @KERNELPATH@ @ROOT@ nomodeset quiet/linuxefi @KERNELPATH@ @ROOT@ nomodeset quiet $(EXTRA_BOOT_PARAMS)/g' /usr/share/lorax/templates.d/99-generic/config_files/x86/grub2-efi.cfg
+
+	sed -i 's/linux @KERNELPATH@ @ROOT@ inst.rescue quiet/linux @KERNELPATH@ @ROOT@ inst.rescue quiet $(EXTRA_BOOT_PARAMS)/g' /usr/share/lorax/templates.d/99-generic/config_files/x86/grub2-bios.cfg
+	sed -i 's/linuxefi @KERNELPATH@ @ROOT@ inst.rescue quiet/linuxefi @KERNELPATH@ @ROOT@ inst.rescue quiet $(EXTRA_BOOT_PARAMS)/g' /usr/share/lorax/templates.d/99-generic/config_files/x86/grub2-efi.cfg
+
+	# Build boot.iso
+	lorax -p $(IMAGE_NAME) -v $(VERSION) -r $(VERSION) -t $(VARIANT) \
+          --isfinal --buildarch=$(ARCH) --volid=$(_VOLID) \
+          $(_LORAX_ARGS) \
          --repo /etc/yum.repos.d/fedora.repo \
          --repo /etc/yum.repos.d/fedora-updates.repo \
-          --add-template $(base_dir)/lorax_templates/set_installer.tmpl \
-		  --add-template $(base_dir)/lorax_templates/configure_upgrades.tmpl \
-          $(base_dir)/results/
-	mv $(base_dir)/results/images/boot.iso $(base_dir)/
+          --add-template $(_BASE_DIR)/lorax_templates/set_installer.tmpl \
+		  --add-template $(_BASE_DIR)/lorax_templates/configure_upgrades.tmpl \
+		  --add-template $(_BASE_DIR)/lorax_templates/secure_boot_key.tmpl \
+          $(_BASE_DIR)/results/
+	mv $(_BASE_DIR)/results/images/boot.iso $(_BASE_DIR)/

-container/$(image_name)-$(version):
-	mkdir container
-	podman pull $(image_repo)/$(image_name):$(image_tag)
-	podman save --format oci-dir -o $(base_dir)/container/$(image_name)-$(version) $(image_repo)/$(image_name):$(image_tag)
-	podman rmi $(image_repo)/$(image_name):$(image_tag)
+# Step 3: Download container image
+container/$(IMAGE_NAME)-$(IMAGE_TAG):
+	mkdir container || true
+	podman pull $(IMAGE_REPO)/$(IMAGE_NAME):$(IMAGE_TAG)
+	podman save --format oci-dir -o $(_BASE_DIR)/container/$(IMAGE_NAME)-$(IMAGE_TAG) $(IMAGE_REPO)/$(IMAGE_NAME):$(IMAGE_TAG)
+	podman rmi $(IMAGE_REPO)/$(IMAGE_NAME):$(IMAGE_TAG)

 install-deps:
-	dnf install -y lorax xorriso podman git rpm-ostree
-
-
-
-lorax_templates/%.tmpl: lorax_templates/%.tmpl.in
-	sed 's/@IMAGE_NAME@/$(image_name)/'                        $(base_dir)/lorax_templates/$*.tmpl.in > $(base_dir)/lorax_templates/$*.tmpl
-	sed 's/@IMAGE_REPO@/$(image_repo_escaped)/'                $(base_dir)/lorax_templates/$*.tmpl > $(base_dir)/lorax_templates/$*.tmpl.tmp
-	mv $(base_dir)/lorax_templates/$*.tmpl{.tmp,}
-	sed 's/@VERSION@/$(version)/'                              $(base_dir)/lorax_templates/$*.tmpl > $(base_dir)/lorax_templates/$*.tmpl.tmp
-	mv $(base_dir)/lorax_templates/$*.tmpl{.tmp,}
-	sed 's/@IMAGE_REPO_ESCAPED@/$(image_repo_double_escaped)/' $(base_dir)/lorax_templates/$*.tmpl > $(base_dir)/lorax_templates/$*.tmpl.tmp
-	mv $(base_dir)/lorax_templates/$*.tmpl{.tmp,}
-
-
-
-xorriso/input.txt: xorriso/gen_input.sh
-	bash $(base_dir)/xorriso/gen_input.sh | tee $(base_dir)/xorriso/input.txt
+	dnf install -y lorax xorriso podman git

+# Step 4: Generate xorriso script
 xorriso/%.sh: xorriso/%.sh.in
-	sed 's/@IMAGE_NAME@/$(image_name)/' $(base_dir)/xorriso/$*.sh.in > $(base_dir)/xorriso/$*.sh
-	sed 's/@VERSION@/$(version)/'       $(base_dir)/xorriso/$*.sh > $(base_dir)/xorriso/$*.sh.tmp
-	mv $(base_dir)/xorriso/$*.sh{.tmp,}
-	sed 's/@ARCH@/$(arch)/'             $(base_dir)/xorriso/$*.sh > $(base_dir)/xorriso/$*.sh.tmp
-	mv $(base_dir)/xorriso/$*.sh{.tmp,}
+	sed 's/@IMAGE_NAME@/$(IMAGE_NAME)/' $(_BASE_DIR)/xorriso/$*.sh.in > $(_BASE_DIR)/xorriso/$*.sh
+
+	sed 's/@IMAGE_TAG@/$(IMAGE_TAG)/'   $(_BASE_DIR)/xorriso/$*.sh > $(_BASE_DIR)/xorriso/$*.sh.tmp
+	mv $(_BASE_DIR)/xorriso/$*.sh{.tmp,}
+
+	sed 's/@ARCH@/$(ARCH)/'             $(_BASE_DIR)/xorriso/$*.sh > $(_BASE_DIR)/xorriso/$*.sh.tmp
+	mv $(_BASE_DIR)/xorriso/$*.sh{.tmp,}
+
+# Step 5: Generate xorriso input
+xorriso/input.txt: xorriso/gen_input.sh
+	bash $(_BASE_DIR)/xorriso/gen_input.sh | tee $(_BASE_DIR)/xorriso/input.txt


 clean:
-	rm -Rf $(base_dir)/container || true
-	rm -Rf $(base_dir)/debugdata || true
-	rm -Rf $(base_dir)/pkglists || true
-	rm -Rf $(base_dir)/results || true
-	rm -f $(base_dir)/lorax_templates/*.tmpl || true
-	rm -f $(base_dir)/xorriso/input.txt || true
-	rm -f $(base_dir)/xorriso/*.sh || true
-	rm -f $(base_dir)/{original,final}-pkgsizes.txt || true
-	rm -f $(base_dir)/lorax.conf || true
-	rm -f $(base_dir)/*.iso || true
-	rm -f $(base_dir)/*.log || true	
-	
+	rm -Rf $(_BASE_DIR)/container || true
+	rm -Rf $(_BASE_DIR)/debugdata || true
+	rm -Rf $(_BASE_DIR)/pkglists || true
+	rm -Rf $(_BASE_DIR)/results || true
+	rm -f $(_BASE_DIR)/lorax_templates/*.tmpl || true
+	rm -f $(_BASE_DIR)/xorriso/input.txt || true
+	rm -f $(_BASE_DIR)/xorriso/*.sh || true
+	rm -f $(_BASE_DIR)/{original,final}-pkgsizes.txt || true
+	rm -f $(_BASE_DIR)/lorax.conf || true
+	rm -f $(_BASE_DIR)/*.iso || true
+	rm -f $(_BASE_DIR)/*.log || true
 	
+.PHONY: clean	
--- a/README.md
+++ b/README.md
@ -1,2 +1,113 @@
-# container-installer
-Creates an ISO for installing a container image as an OS
+# 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](#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](#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 Universal Blue Silverblue ISO
+```bash
+docker run --rm --privileged --volume .:/isogenerator/output -e VERSION=39 -e IMAGE_NAME=silverblue-main -e IMAGE_TAG=latest -e VARIANT=Silverblue ghcr.io/ublue-os/isogenerator:39
+```
+```bash
+# Requires sudo to run
+sudo podman run --rm --privileged --volume .:/isogenerator/output -e VERSION=39 -e IMAGE_NAME=silverblue-main -e IMAGE_TAG=latest -e VARIANT=Silverblue ghcr.io/ublue-os/isogenerator:39
+```
+
+Creating Universal Blue Kinoite ISO
+```bash
+docker run --rm --privileged --volume .:/isogenerator/output -e VERSION=39 -e IMAGE_NAME=kinoite-main -e IMAGE_TAG=latest -e VARIANT=Kinoite ghcr.io/ublue-os/isogenerator:39
+```
+```bash
+# Requires sudo to run
+sudo podman run --rm --privileged --volume .:/isogenerator/output -e VERSION=39 -e IMAGE_NAME=kinoite-main -e IMAGE_TAG=latest -e VARIANT=Kinoite ghcr.io/ublue-os/isogenerator:39
+```
+
+## Customizing
+
+### Inputs
+
+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                  |
+| ENROLLMENT_PASSWORD | Password used to enroll secure boot key into BIOS\*\*        | isogenerator           |
+| SECURE_BOOT_KEY_URL | URL used to download your secure boot key for enrollment\*\* | \[empty\]              |
+
+\*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
+
+\*\*NOTE: ENROLLMENT_PASSWORD and SECURE_BOOT_KEY_URL are not required. They are only required if you are creating specific kernel modules or if you are using Universal Blue Kernel Modules.
+
+Our public key for our kmods is located here: https://github.com/ublue-os/akmods/raw/main/certs/public_key.der
+
+### Outputs
+
+This action outputs some useful values for you to use further on in your workflow.
+
+| Output | Description |
+| ------ | ----------- |
+| output-directory | The directory containing ISO and checksum files |
+| iso-path | The full path to the ISO file |
+| checksum-path | The full path to the checksum file |
+
+## 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
+```json
+{
+	"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
+```json
+{
+	"name": "Existing Dockerfile",
+	"build": {
+		"context": "..",
+		"dockerfile": "../Containerfile",
+		"args": {
+			"version": "39"
+		}
+	},
+	//"image": "ghcr.io/ublue-os/isogenerator:latest",
+	"overrideCommand": true,
+	"shutdownAction": "stopContainer",
+	"privileged": true
+}
+```
--- a/action.yml
+++ b/action.yml
@ -0,0 +1,142 @@
+name: Generate ISO
+description: Creates an ISO for installing an OSTree container
+
+inputs:
+  ARCH:
+    description: Architecture for image to build
+    required: true
+    default: x86_64
+  IMAGE_NAME:
+    description: Name of the source container image
+    required: true
+    default: base-main
+  IMAGE_REPO:
+    description: Repository containing the source container image
+    required: true
+    default: ghcr.io/ublue-os
+  VARIANT:
+    description: "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"
+    required: true
+    default: Kinoite
+  VERSION:
+    description: Fedora version of installer to build
+    required: true
+    default: "39"
+  IMAGE_TAG:
+    description: Tag of the source container image
+    required: false
+  EXTRA_BOOT_PARAMS:
+    description: Extra params used by grub to boot the anaconda installer
+    required: false
+  WEB_UI:
+    description: Enable Anaconda WebUI
+    required: true
+    default: "false"
+  ENROLLMENT_PASSWORD:
+    description: Used for supporting secure boot (requires SECURE_BOOT_KEY_URL to be defined)
+    required: false
+    default: "ublue-os"
+  SECURE_BOOT_KEY_URL:
+    description: Secure boot key that is installed from URL location
+    required: false
+  ACTION_REPO:
+    deprecationMessage: This variable is no longer used and will be removed in a future version
+    required: false
+  ACTION_REF:
+    deprecationMessage: This variable is no longer used and will be removed in a future version
+    required: false
+
+outputs:
+  output-directory:
+    value: ${{ steps.final.outputs.OUTPUT_DIR }}
+  iso-path: 
+    value: ${{ steps.final.outputs.ISO_PATH }}
+  checksum-path: 
+    value: ${{ steps.final.outputs.CHECKSUM_PATH }} 
+
+runs:
+  using: composite
+  steps:
+    - name: Cleanup host
+      shell: bash
+      run: |
+        if [[ -d /host ]]
+        then
+          df -h /host
+          # Remove Android Library
+          rm -Rf /host/usr/local/lib/android
+          # Remove .NET runtime
+          rm -Rf /host/usr/share/dotnet
+          # Remove Haskell runtime
+          rm -rf /host/opt/ghc
+          rm -rf /host/usr/local/.ghcup
+          chroot /host docker image prune --all --force
+          df -h /host
+        else
+          echo "Host must be mounted as /host in order to make more space"
+        fi
+        
+    - name: Install Make
+      shell: bash
+      run: dnf install -y make
+
+    - name: Install dependencies
+      shell: bash
+      working-directory: ${{ github.action_path }}
+      run: make install-deps
+
+    - name: Lowercase Registry
+      id: registry_case
+      uses: ASzc/change-string-case-action@v6
+      with:
+        string: ${{ inputs.IMAGE_REPO }}
+
+    - name: Download image
+      shell: bash
+      working-directory: ${{ github.action_path }}
+      run: |
+        make container/${{ inputs.IMAGE_NAME }}-${{ inputs.IMAGE_TAG || inputs.VERSION }} \
+          ARCH=${{ inputs.ARCH }} \
+          IMAGE_NAME=${{ inputs.IMAGE_NAME }} \
+          IMAGE_REPO=${{ steps.registry_case.outputs.lowercase }} \
+          IMAGE_TAG=${{ inputs.IMAGE_TAG || inputs.VERSION }} \
+          VARIANT=${{ inputs.VARIANT }} \
+          VERSION=${{ inputs.VERSION }} \
+          WEB_UI=${{ inputs.WEB_UI }}
+
+    - name: Create boot.iso
+      shell: bash
+      working-directory: ${{ github.action_path }}
+      run: |
+        make boot.iso \
+          ARCH=${{ inputs.ARCH }} \
+          IMAGE_NAME=${{ inputs.IMAGE_NAME }} \
+          IMAGE_REPO=${{ steps.registry_case.outputs.lowercase }} \
+          IMAGE_TAG=${{ inputs.IMAGE_TAG || inputs.VERSION }} \
+          VARIANT=${{ inputs.VARIANT }} \
+          VERSION=${{ inputs.VERSION }} \
+          WEB_UI=${{ inputs.WEB_UI }} \
+          EXTRA_BOOT_PARAMS=${{ inputs.EXTRA_BOOT_PARAMS }} \
+          SECURE_BOOT_KEY_URL=${{ inputs.SECURE_BOOT_KEY_URL }} \
+          ENROLLMENT_PASSWORD=${{ inputs.ENROLLMENT_PASSWORD }}
+
+    - name: Create deploy.iso and generate sha256 checksum
+      shell: bash
+      id: final
+      working-directory: ${{ github.action_path }}
+      run: |
+        make ${{ inputs.IMAGE_NAME }}-${{ inputs.IMAGE_TAG || inputs.VERSION }}.iso \
+          ARCH=${{ inputs.ARCH }} \
+          IMAGE_NAME=${{ inputs.IMAGE_NAME }} \
+          IMAGE_REPO=${{ steps.registry_case.outputs.lowercase }} \
+          IMAGE_TAG=${{ inputs.IMAGE_TAG || inputs.VERSION }} \
+          VARIANT=${{ inputs.VARIANT }} \
+          VERSION=${{ inputs.VERSION }} \
+          WEB_UI=${{ inputs.WEB_UI }}
+        mkdir end_iso
+        sha256sum ${{ inputs.IMAGE_NAME }}-${{ inputs.IMAGE_TAG || inputs.VERSION }}.iso > ./end_iso/${{ inputs.IMAGE_NAME }}-${{ inputs.IMAGE_TAG || inputs.VERSION }}-CHECKSUM
+        mv ${{ inputs.IMAGE_NAME }}-${{ inputs.IMAGE_TAG || inputs.VERSION }}.iso end_iso/
+        
+        echo "OUTPUT_DIR=$(realpath ./end_iso)" >> $GITHUB_OUTPUT
+        echo "ISO_PATH=$(realpath ./end_iso/${{ inputs.IMAGE_NAME }}-${{ inputs.IMAGE_TAG || inputs.VERSION }}.iso)" >> $GITHUB_OUTPUT
+        echo "CHECKSUM_PATH=$(realpath ./end_iso/${{ inputs.IMAGE_NAME }}-${{ inputs.IMAGE_TAG || inputs.VERSION }}-CHECKSUM)" >> $GITHUB_OUTPUT
--- a/entrypoint.sh
+++ b/entrypoint.sh
@ -0,0 +1,17 @@
+#!/bin/bash
+
+set -eu
+
+# pre-create loop devices manually. In containers we can't use losetup for that.
+mknod -m 0660 /dev/loop0 b 7 0 2>/dev/null || true
+
+make output/${IMAGE_NAME}-${IMAGE_TAG}.iso \
+	ARCH=${ARCH} \
+	VERSION=${VERSION} \
+	IMAGE_REPO=${IMAGE_REPO} \
+	IMAGE_NAME=${IMAGE_NAME} \
+	IMAGE_TAG=${IMAGE_TAG} \
+	VARIANT=${VARIANT} \
+	WEB_UI=${WEB_UI} \
+	SECURE_BOOT_KEY_URL=${SECURE_BOOT_KEY_URL} \
+	ENROLLMENT_PASSWORD=${ENROLLMENT_PASSWORD}
--- a/lorax_templates/configure_upgrades.tmpl.in
+++ b/lorax_templates/configure_upgrades.tmpl.in
@ -1,7 +1,7 @@
 append usr/share/anaconda/interactive-defaults.ks "%post --erroronfail"
-append usr/share/anaconda/interactive-defaults.ks "sed -i 's/container-image-reference=.*/container-image-reference=ostree-image-signed:docker:\/\/@IMAGE_REPO_ESCAPED@\/@IMAGE_NAME@:@VERSION@/' /ostree/deploy/default/deploy/*.origin"
+append usr/share/anaconda/interactive-defaults.ks "sed -i 's/container-image-reference=.*/container-image-reference=ostree-image-signed:docker:\/\/@IMAGE_REPO_ESCAPED@\/@IMAGE_NAME@:@IMAGE_TAG@/' /ostree/deploy/default/deploy/*.origin"
 append usr/share/anaconda/interactive-defaults.ks "%end"

 append usr/share/anaconda/post-scripts/configure_upgrades.ks "%post --erroronfail"
-append usr/share/anaconda/post-scripts/configure_upgrades.ks "sed -i 's/container-image-reference=.*/container-image-reference=ostree-image-signed:docker:\/\/@IMAGE_REPO_ESCAPED@\/@IMAGE_NAME@:@VERSION@/' /ostree/deploy/default/deploy/*.origin"
+append usr/share/anaconda/post-scripts/configure_upgrades.ks "sed -i 's/container-image-reference=.*/container-image-reference=ostree-image-signed:docker:\/\/@IMAGE_REPO_ESCAPED@\/@IMAGE_NAME@:@IMAGE_TAG@/' /ostree/deploy/default/deploy/*.origin"
 append usr/share/anaconda/post-scripts/configure_upgrades.ks "%end"
--- a/lorax_templates/secure_boot_key.tmpl
+++ b/lorax_templates/secure_boot_key.tmpl
@ -0,0 +1,9 @@
+append usr/share/anaconda/interactive-defaults.ks "%post --logfile=/root/ks-post.log --erroronfail --nochroot"
+append usr/share/anaconda/interactive-defaults.ks "set -m"
+append usr/share/anaconda/interactive-defaults.ks "/run/install/repo/enroll-secureboot-key.sh"
+append usr/share/anaconda/interactive-defaults.ks "%end"
+
+append usr/share/anaconda/post-scripts/secure_boot_key.ks "%post --logfile=/root/ks-post.log --erroronfail --nochroot"
+append usr/share/anaconda/post-scripts/secure_boot_key.ks "set -m"
+append usr/share/anaconda/post-scripts/secure_boot_key.ks "/run/install/repo/enroll-secureboot-key.sh"
+append usr/share/anaconda/post-scripts/secure_boot_key.ks "%end"
--- a/lorax_templates/set_installer.tmpl.in
+++ b/lorax_templates/set_installer.tmpl.in
@ -1 +1 @@
-append usr/share/anaconda/interactive-defaults.ks "ostreecontainer --url=/run/install/repo/@IMAGE_NAME@-@VERSION@ --transport=oci --no-signature-verification"
+append usr/share/anaconda/interactive-defaults.ks "ostreecontainer --url=/run/install/repo/@IMAGE_NAME@-@IMAGE_TAG@ --transport=oci --no-signature-verification"
--- a/scripts/enroll-secureboot-key.sh.in
+++ b/scripts/enroll-secureboot-key.sh.in
@ -0,0 +1,25 @@
+#!/bin/sh
+
+set -oue pipefail
+
+readonly ENROLLMENT_PASSWORD=@ENROLLMENT_PASSWORD@
+readonly SECUREBOOT_KEY="/run/install/repo/sb_pubkey.der"
+
+if [[ ! -d "/sys/firmware/efi" ]]; then
+	echo "EFI mode not detected. Skipping key enrollment."
+	exit 0
+fi
+
+if [[ ! -f "${SECUREBOOT_KEY}" ]]; then
+	echo "Secure boot key not provided: ${SECUREBOOT_KEY}"
+	exit 0
+fi
+
+SYS_ID="$(cat /sys/devices/virtual/dmi/id/product_name)"
+if [[ ":Jupiter:Galileo:" =~ ":$SYS_ID:" ]]; then
+	echo "Steam Deck hardware detected. Skipping key enrollment."
+	exit 0
+fi
+
+mokutil --timeout -1 || :
+echo -e "${ENROLLMENT_PASSWORD}\n${ENROLLMENT_PASSWORD}" | mokutil --import "${SECUREBOOT_KEY}" || :
--- a/xorriso/gen_input.sh.in
+++ b/xorriso/gen_input.sh.in
@ -1,15 +1,19 @@
 #!/bin/bash

 echo "-indev $(pwd)/boot.iso"
-echo "-outdev $(pwd)/@IMAGE_NAME@-@VERSION@.iso"
+echo "-outdev $(pwd)/output/@IMAGE_NAME@-@IMAGE_TAG@.iso"
 echo "-boot_image any replay"
-echo "-volid @IMAGE_NAME@-@ARCH@-@VERSION@"
 echo "-joliet on"
 echo "-compliance joliet_long_names"
+if [ -f $(pwd)/sb_pubkey.der ]; then
+	echo "-map $(pwd)/sb_pubkey.der sb_pubkey.der"
+	echo "-chmod 0444 /sb_pubkey.der"
+fi
+echo "-map $(pwd)/scripts/enroll-secureboot-key.sh enroll-secureboot-key.sh"
+echo "-chmod 0777 enroll-secureboot-key.sh"
 cd container
-for file in $(find @IMAGE_NAME@-@VERSION@)
-do
-    echo "-map $(pwd)/${file} ${file}"
-    echo "-chmod 0444 ${file}"
+for file in $(find @IMAGE_NAME@-@IMAGE_TAG@); do
+	echo "-map $(pwd)/${file} ${file}"
+	echo "-chmod 0444 ${file}"
 done
-echo "-end"
+echo "-end"
Author	SHA1	Message	Date
Morgan	6ef674397a	Update test-iso.yml	2024-03-05 19:08:26 +09:00
Morgan	b5410c1668	Update test-iso.yml	2024-03-05 19:07:11 +09:00
Morgan	7ae9eae9fd	Update test-iso.yml	2024-03-05 18:56:17 +09:00
Noel Miller	766300bd98	fix: Container versions are not being set properly (#53 ) * fix: Container versions are not being set properly * fix: replaced build-action action * fix: removed extra } * fix: Fixed name of env variable * fix: added checkout command	2024-03-04 16:42:27 +00:00
Noel Miller	10487bbf5b	chore: Remove CODEOWNERS (#54 ) We are replacing codeowners with prow or possibly a different tool.	2024-03-04 16:31:48 +00:00
Robert Sturla	c5f825fd3e	chore: remove ACTION_REF and ACTION_REPO action inputs (#49 ) * Remove ACTION_REF and ACTION_REPO action inputs * Remove duplicate github. * Remove inputs from test-iso.yml workflow * I highly doubt this will work, but let's try it anyway * Let's try a different approach. Don't clone the repo at all, as it should already be there. Let's just set the working directory. * Do not introduce a breaking change * Say the unused variables will be removed soon	2024-02-29 19:49:22 +00:00
Robert Sturla	aa4aecdc7e	chore: remove dnf cache and unused files from built image (#26 ) * chore: add a `dnf clean all` step after installing deps * chore: only copy the required files to the image * fix: add scripts to the image * Switch to .dockerignore file --------- Co-authored-by: Noel Miller <4983138+noelmiller@users.noreply.github.com>	2024-02-29 19:49:12 +00:00
Robert Sturla	e2fbaa438c	feat: add action outputs (#47 ) * Create and document action outputs * Use outputs in upload artifact step	2024-02-29 17:01:08 +00:00
Robert Sturla	ec1f755ae3	chore: small refactoring to CI build matrix jobs (#48 ) chore: small refactoring so the build matrix job names make a bit more sense	2024-02-29 16:55:37 +00:00
Noel Miller	7a19c2dbe1	fix: sets default password in action (#46 )	2024-02-29 00:02:51 +00:00
Noel Miller	acbe229a3d	fix: removed override language macro that sets language to english (#44 ) The default is all languages and not just english.	2024-02-28 19:46:09 +00:00
Noel Miller	3822a95314	feat: Add Test Media Capability (#43 ) * feat: Allow users to override secure boot key and password when using container or action * fix: follow redirects * chore: update docs * fix: added comments and removed additional \n * fix: removed defaults * fix: added conditional for adding public key * chore(ci): Added additional test for secure boot * chore(ci): fixed up workflows to match production * fix(ci): added workflow dispatch to test * fix(ci): fixed version and added IMAGE_TAG * chore(ci): changed to bluefin to test both 38 and 39 secure boot * chore(ci): added required variables to entrypoint * chore(ci): added merge_group and added paths-ignore * chore(ci): updated description * chore(ci): set to Silverblue since we are testing Bluefin * chore(ci): Fixed secure boot key not found error Received error in anaconda when check was hit, need to set as a soft failure to exit the script early without stopping anaconda installation. * chore: fixed formatting * chore: fixed whitespace * chore(ci): Removed duplicate test * chore: fix whitespace * chore(ci): fixed test and removed upload to Github Artifacts * chore: updated README * feat: Re-enable Test Media Feature	2024-02-28 00:28:38 +00:00
Noel Miller	f70e8ea027	feat: Allow users to override secure boot key and password (#40 ) * feat: Allow users to override secure boot key and password when using container or action * fix: follow redirects * chore: update docs * fix: added comments and removed additional \n * fix: removed defaults * fix: added conditional for adding public key * chore(ci): Added additional test for secure boot * chore(ci): fixed up workflows to match production * fix(ci): added workflow dispatch to test * fix(ci): fixed version and added IMAGE_TAG * chore(ci): changed to bluefin to test both 38 and 39 secure boot * chore(ci): added required variables to entrypoint * chore(ci): added merge_group and added paths-ignore * chore(ci): updated description * chore(ci): set to Silverblue since we are testing Bluefin * chore(ci): Fixed secure boot key not found error Received error in anaconda when check was hit, need to set as a soft failure to exit the script early without stopping anaconda installation. * chore: fixed formatting * chore: fixed whitespace * chore(ci): Removed duplicate test * chore: fix whitespace * chore(ci): fixed test and removed upload to Github Artifacts * chore: updated README * fix: set password to ublue default * fix: changed enrollment password in containerfile	2024-02-28 00:06:38 +00:00
Benjamin Sherman	3401b10c56	fix: make loop device during container build of ISO (#41 ) * fix: make loop device during container build of ISO This creates the loop device during container runtime which allows lorax to build the ISO and not need to rely on a host provided device file. Fixes: #22 * chore: updated readme --------- Co-authored-by: Noel Miller <noelmiller@protonmail.com>	2024-02-27 18:06:33 +00:00
Robert Sturla	99a54d2869	chore: remove unused rpm-ostree package (#27 ) chore: remove unused rpm-ostree dependency Co-authored-by: Noel Miller <4983138+noelmiller@users.noreply.github.com>	2024-02-27 02:47:28 +00:00
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
Kyle Gospodnetich	ff58b2d122	fix: Ignore Valve Steam Deck hardware due to using EFI but having no keys enrolled by default and add extra boot parameters (#33 ) * fix: Ignore Valve Steam Deck hardware due to using EFI but having no keys enrolled by default. * fix: add extra boot parameters to fix steam deck resolution issue --------- Co-authored-by: Noel Miller <noelmiller@protonmail.com>	2024-02-25 01:34:23 +00:00
Benjamin Sherman	bdbcfde826	fix: use correct secureboot AKMOD_PRIVKEY_20230518 (#31 ) The very short-lived key AKMOD_PRIVKEY_20230517 was accidentally included here instead of the proper one. This correct key is the one we actually use to sign akmods (and also is used by bazzite to sign the whole kernel). So we definitely need this to be correct.	2024-02-23 20:42:02 -08:00
Noel Miller	337e31c744	feat: add creation of sha256 checksum (#30 ) * feat: add creation of sha256 checksum * fix: use it use no directory as part of the check	2024-02-24 00:55:44 +00:00
Noel Miller	bf4d1368fc	feat: Add Secure Boot Support and Remove Grub Entry for Test this Media (#28 ) * chore: First pass of adding secure boot key enrollment * feat: Add secure boot support * feat: Removed Test this media grub entry and set default to install * fix: simplify secureboot scripts --------- Co-authored-by: Kyle Gospodnetich <me@kylegospodneti.ch>	2024-02-23 18:10:17 +00:00
Jorge O. Castro	c6b30c9210	Merge pull request #21 from ublue-os/volid_length fix: make volid shorter to fit within 32 char	2024-02-21 16:09:33 -05:00
Jason N.	a988f74523	fix: only get first portion of image_name	2024-02-21 15:46:27 -05:00
Jason N.	5e5ce9e754	fix: make volid shorter to fit within 32 char	2024-02-21 15:25:11 -05:00
Noel Miller	42d68772a0	feat(ci): Added ability to run the workflow manually and fix: general fixes (#17 )	2024-02-20 17:36:12 -05:00
Noel Miller	c2436908ed	Merge pull request #20 from ublue-os/fix_license fix: Update LICENSE to Apache 2.0	2024-02-20 20:54:46 +00:00
Noel Miller	3999189402	fix: Update LICENSE to Apache 2.0	2024-02-20 14:46:51 -06:00
Jason N	a8cdedd915	Merge pull request #7 from ublue-os/jasonn3-fixes fix: General Fixes	2024-02-20 19:08:10 +00:00
Jason N.	b3e24eabda	fix: match action defaults	2024-02-20 13:13:56 -05:00
Jason N.	2168717533	fix: expand name	2024-02-20 11:55:52 -05:00
Jason N.	441364b76e	use var	2024-02-20 10:59:35 -05:00
Jason N.	6e7bef7806	don't include tag	2024-02-20 10:45:01 -05:00
Jason N.	ea1a7c9623	free up extra space	2024-02-20 10:25:29 -05:00
Jason N.	fe7443ffcc	fix: remove target	2024-02-19 22:21:27 -05:00
Jason N.	8faf73deaa	remove duplicate text and upgrade build version	2024-02-19 20:56:42 -05:00
Jason N	d4eb37fc5f	doc: copy variant description from action	2024-02-19 18:17:27 -05:00
Jason N.	0a69cfe2e9	fix: only run test on PR	2024-02-19 12:41:39 -05:00
Jason N.	0f9cb8812c	fix: always push for testing and include variant in ISO name	2024-02-19 12:38:14 -05:00
Jason N.	a0cfe4e05a	single quotes	2024-02-19 12:34:01 -05:00
Jason N.	1a58c12608	fix: don't push the iso during testing	2024-02-19 12:32:42 -05:00
Jason N.	e7172778d0	doc: re-order to put steps in order	2024-02-19 12:18:37 -05:00
Jason N.	cda1689641	doc: update VARIANT description to include how to find options	2024-02-19 12:18:18 -05:00
Jason N.	5ab0abdb2f	make pr check requirements easier	2024-02-19 10:15:22 -05:00
Jason N.	c720fb3dc5	move codeowners	2024-02-19 14:39:03 +00:00
Jason N.	31b6b39b23	allow multiple output locations	2024-02-19 14:20:08 +00:00
Jason N.	2290aa6209	missing inputs	2024-02-18 20:03:42 +00:00
Jason N.	50bf71eab5	fixes	2024-02-18 19:53:12 +00:00
Jason N.	2c16c58fbc	test action in root	2024-02-18 19:43:20 +00:00
Jason N.	91141ce742	fix: add checkout to right workflow	2024-02-18 19:39:31 +00:00
Jason N.	73b0799030	checkout before run	2024-02-18 19:38:08 +00:00
Jason N.	6ab23f79d2	reference file directly	2024-02-18 19:30:20 +00:00
Jason N.	96b1379d6c	update workflow	2024-02-18 19:12:30 +00:00
Jason N.	c48c28120b	general fixes	2024-02-16 23:40:48 +00:00
Noel Miller	70bc2264ba	fix: tags not properly being set in ostree remote (#6 ) * fix: tags are now properly set in remote after install * refactor: kinoite variant is better as a default except for silverblue * refactor: use docker to build ISO --------- Co-authored-by: Benjamin Sherman <benjamin@holyarmy.org>	2024-02-16 14:45:19 -06:00
Kyle Gospodnetich	8e91767f92	Merge pull request #5 from ublue-os/fixup-workflow fix: added workflow_dispatch and fixed workflow	2024-02-15 23:52:51 -08:00
Noel Miller	2226162399	fix: added workflow_dispatch and fixed workflow	2024-02-16 01:13:04 -06:00
Kyle Gospodnetich	1f0777c206	Merge pull request #4 from ublue-os/create_dockerfile feat: Adding Dockerfile to simplify development	2024-02-15 23:00:42 -08:00
Noel Miller	0a258a446a	feat: Adding Dockerfile to simplify development	2024-02-15 17:15:47 -06:00
HikariKnight	d78c52a68f	Revert "Merge pull request #3 from ublue-os/bsherman-patch-1" This reverts commit `aba2f56ebd`, reversing changes made to `6f3480e2ea`.	2024-02-15 21:45:20 +01:00
Jorge O. Castro	aba2f56ebd	Merge pull request #3 from ublue-os/bsherman-patch-1 fix: use image_tag not version	2024-02-15 15:12:14 -05:00
Benjamin Sherman	f32ce26fa7	fix: use image_tag not version Hopefully	2024-02-15 14:11:54 -06:00