Breadcrumbs

How to add Apps and other Modifcations to Your IGEL OS Installation Image

You can modify the IGEL OS image before it is installed on your devices by the IGEL OS Creator (OSC). This includes adding apps, certificates, licenses, and files for Corporate ID (CI) to the image to be installed with the IGEL OS Creator (OSC). This is an alternative to the standard method of installing the IGEL OS Base System initially and then adding the required apps from the IGEL App Portal. It is suitable for air-gapped scenarios, for instance.

Use this tool with caution. Installing an OSC image overwrites existing operating system installations and data partitions on the target device.

Requirements

  • A Linux machine for creating your OSC image

  • xorriso must be installed on your OSC image creation machine

  • A device on which your OSC image can be tested

Getting Started with the OSC Modification Tool

The OSC modification tool resides in the subdirectory <OSC DIRECTORY>/pxe_data/, e. g. osc-12.9.0+2/pxe_data/.

To specify the files you want to add to the IGEL OS image, place the relevant files in directories and provide their paths using the appropriate parameters.

  1. Go to app.igel.com/software > IGEL OS Creator and download the version you want.



  1. Unzip the file, enter the created directory, and go to the subdirectory pxe_data

Example:

unzip osc-12.9.0+3.zip
cd osc-12.9.0+3/
cd pxe_data



  1. Make the tool modify_osc_image executable.

chmod a+x modify_osc_image



  1. To get familiar with the tool, print out the version or check out the help.


    • ./modify_osc_image -v



    • ./modify_osc_image -h


Adding Apps

Ensure that Your Modifications Are Preserved During the Installation via OSC

For IGEL OS 12.9.0 PR 3 or higher:

Use the parameter --disable-migrate-old-settings to override the settings of Migrate old settings in the OSC. For details, see the Parameter Reference.

For IGEL OS 12.9.0 through 12.9.0 PR 2:

When you run the OSC to install your modified ISO file on your device, make sure that Migrate old settings is disabled. Otherwise, your modifications will be lost.

Required Files

Put the following files into separate directories that can be reached by the OSC modification tool:

  • The original ISO image

  • The .ipkg files of the apps to be added to the image

  • The app certificate file(s)

  • If the app requires an add-on license, provide the path to the relevant license file

Syntax 

./modify_osc_image --iso <PATH_TO_THE_ISO_FILE> --apps-path <PATH_TO_THE_APP_PACKAGES> --cmty-certs-path <PATH_TO_THE_APP_CERTIFICATE> --cmty-im-certs-path <PATH_TO_THE_INTERMEDIATE_APP_CERTIFICATE>  --lic-path <PATH_TO_THE_ADDON_LICENSES>

Example 

/modify_osc_image --iso osc-12.9.0+3.iso --apps-path osc_apps/ --cmty-certs-path osc_cmty_certificates/ --lic-path osc_licenses/


Example in Unattended Mode

To create an IGEL OS image that will be installed in unattended mode, note the following:

  • The EULA is presented in the terminal in which you started modify_osc_image. If you press a key, the EULA is shown in your default text editor. To accept the EULA, enter y in the terminal.

  • The OSC installer runs automatically, without a user having to confirm.

  • To define if the device should shut down or reboot on installation, set --after-install accordingly:

    • To make the device reboot after installation, use --after-install reboot

    • To make the device shut down after installation, use --after-install shutdown

/modify_osc_image --iso osc-12.9.0+3.iso --apps-path osc_apps/ --cmty-certs-path osc_cmty_certificates/ --lic-path osc_licenses/ --after-install shutdown


Parameter Reference

Mandatory Parameters

Use Case

Parameter

Argument

Meaning

Adding apps

--iso

<file>

Path to the input ISO file

--apps-path

<directory>

Path containing the .ipkg apps to add to the ISO

Optional Parameters

Use Case

Parameter

Argument

Meaning/Notes

Adding app certificates

--cmty-certs-path

<directory>

Path containing the CA certificates for apps

--cmty-im-certs-path

<directory>

Path containing intermediate certificates for apps

Configuring unattended mode

--after-install

<action> (reboot|shutdown)

Action after installation: reboot or shutdown

--unattended-mode

none

Enable unattended mode (flag, no value needed)

Overriding the setting of Migrate old settings to ensure the image modifications will not be canceled

--disable-migrate-old-settings

none

Please note that this parameter is available with IGEL OS 12.9.0 PR3 and higher.

Also note that this parameter is enabled silently when a setup.ini or files in --cmty-certs-path, --cmty-im-certs-path, or --ci-path are present

Adding generic certificates

--cert-path

<directory>

Path containing certificates, according to your use case, e. g., certificates for browsers, SSO, or VDI sessions

Adding licenses

--lic-path

<directory>

Path containing licenses

Adding pre-configured settings

--settings

<file>

Path to the pre-configured settings file setup.ini

Adding Files for Corporate Identity (CI)

--ci-path

<directory>

Please note that this function is available with IGEL OS 12.9.0 PR3 and higher.

Path containing corporate identity files.

You can customize the following GUI components of IGEL OS by providing image files:

  • Start button

  • Start menu

  • Taskbar background

  • Screensaver

  • Bootsplash

  • Background image

After installation, the files are available on the device under /wfs/ci/

Help and Version Parameters

Parameter

Argument

Meaning

-v, --version

none

Display the version of this script

-h, --help

none

Display the tool’s help