IGEL App Creator Portal

With the IGEL App Creator Portal, you can create apps for IGEL OS 12 by using a recipe and, depending on the case, additional files, like binaries. The recipe contains the scripts and metadata files necessary to build an app that can be installed and run on the IGEL OS Base System. While some recipes are available directly on the IGEL Creator Portal, you can obtain further recipes from the IGEL community.

Legal Note

IGEL is not responsible for, nor grants a license to, the applications created via the App Creator Portal.
IT IS YOUR SOLE RESPONSIBILITY TO OBTAIN ALL NECESSARY RIGHTS TO THE COMPONENTS PRIOR TO CREATING AN APPLICATION.

For more information, see our Terms and Conditions:
https://www.igel.com/terms-conditions/

In addition, the App Creator Portal will sign your app and provide the corresponding certificate. When you deploy this certificate to the device, the IGEL OS Base System will allow the app to be installed. Please note there are two types of certificates:

If your company has IGEL Enterprise Edition licenses, you receive a certificate exclusively for your company. With a company certificate, the apps you have created can only be installed on your company’s devices.
If your company has one of the other licenses, you receive a Community certificate. With a Community certificate, your created apps can be installed on any device.

Access to the IGEL App Creator Portal

To log in to the IGEL App Creator Portal, you need an account and have the App Creator role or the Super Admin role assigned. This is done in the IGEL Customer Portal. For details, seeManaging Users and Roles in the IGEL Customer Portal.

Requirements

UMS 12.04 or higher
IGEL OS 12.5 or higher
The recipe for your app, if not already available in the App Creator Portal
Additional files, e.g. binaries, if required by your app

Login to the IGEL App Creator Portal

Go to https://appcreator.igel.com

Click Login.

Enter your IGEL credentials.

The landing page of the App Creator Portal is shown.

Every time the page refreshes, all data is cleared and a new isolated session is created in the backend.

Creating the App in the IGEL App Creator Portal

If you got stuck in the process and want to start from the beginning, click Restart.

1 Provide Recipe

You have the following options to provide a recipe for building your app:

Use a recipe that is already available on the App Creator Portal; see 1.1 Select Your Recipe
Upload a recipe from a local source as a ZIP file; see Uploading a Recipe as a ZIP File
Clone a recipe from a GIT repository; see Cloning a Recipe from a Git Repository

1.1 Select Your Recipe

Select the recipe you want to use.

If the app does not require any additional files, continue with 3 Create App. If additional files are required, continue with 2 Provide Files.

1.2 Provide your Recipe

Upload a Recipe as ZIP File

Metadata Requirements

Before you upload a package, you may want to check or edit the metadata contained in the following files:

app.json should contain the correct version and name for your app.
app.json must define a valid value for “version” while “public_version” must be empty or non-existent.
app.json must not contain variables. Example: "version": "%version%” is invalid while "version": "1.0.0” is valid.
igel/thirdparty.json must contain the names of the binaries used in your app.

You can find a comprehensive description of the metadata at https://github.com/IGEL-Community/IGEL-OS-APP-RECIPES/blob/main/utils/IGEL-SDK-Reference-Manual.pdf.

ZIP Format

Use a simple ZIP format without zip64 extensions or data descriptors.

Click Upload.

Drag and drop your file into the dropbox or use the file chooser.

The uploaded file is listed.

Click Upload.

Your package file is unzipped and parsed.

If no additional files are required, you are taken to 3 Create App.

If additional files are required, you are taken to 2 Provide Files.

Clone a Recipe via GIT

Click Clone.

Enter the following data and then click Clone.
- Clone Git Repository: The URL of the Git repository from which you want to fetch your recipe.
- Authentication Token: If the repository is private, enter the authentication token to access it. If it is public, leave this field empty.
- Entry Point: Subdirectory containing the sources for your recipe.

If no additional files are required, you are taken to 3 Create App.

If additional files are required, you are taken to 2 Provide Files.

2 Provide Files

This step is required if your app needs additional files, like binaries.

Source URL for Binaries

Some of the recipes provided by IGEL require binaries. The download URL is in the corresponding Readme.md under https://github.com/IGEL-Community/IGEL-OS-APP-RECIPES/tree/main/APP_Source/Apps > [YOUR APP]

Example: For the app Thunderbird, the full path to the Readme.md file is https://github.com/IGEL-Community/IGEL-OS-APP-RECIPES/blob/main/APP_Source/Apps/thunderbird/README.md.

Allowed File Types

The following file types are accepted:

.tar
.tgz
.zip
.ipkg
.gz
.deb.bz2

Drag and drop the files on the dropbox field or click on each field with a file name to use a file chooser for each file individually.

When the files are displayed, click Upload.

You are taken to 3 Create App.

3 Create App

In this step, your app package will be built.

Limited Number of Builds per Day

Please note that each user can only perform a limited number of app builds within 24 hours.

The number of remaining builds is shown on the panel to the left:

When a build is older than 24 hours, it is removed from the list of executed builds, and the number of remaining builds is increased by 1.

When the count of remaining builds has reached 0, the date and time of the next possible build is shown.

If you want to change your app’s version number, click Change and edit the version as desired. Ensure you use the semantic numbering format; for further information, see https://semver.org/.

Download the Terms of Use for the IGEL App Creator Portal, read the document, and confirm your agreement with the Terms of Use. This must be done once each session.

Click Create.

Your app is built.

You are taken to 4 Download App.

4 Download App

When the app has been built successfully, you can download the following files:

Certificate: This certificate is required for installing the app on your endpoint devices. For instructions on deploying certificate files (and other files) with the UMS, see Files - Registering Files on the IGEL UMS Server and Transferring Them to Devices
Build Logs: Log of the build process
System Logs: Log of the build process from the system point of view
App: Your app in .ipkg format. For instructions on importing the app into your UMS, see How to Export and Upload Apps to the IGEL UMS .

View Your User Details

→ To view your user details, click on the corresponding button.

Your user details are displayed in a dialog window.