Comment on page
Create and Manage App Containers
Custom Branding
The process to create a custom-branded container in OXIDE can be outlined as follows:
- 1.Create a container configuration
- 1.Here’s where you define all container-level settings
- 2.Select one or more platforms that should share the configured settings
- 1.Some platforms have specific settings that also need to be configured (e.g. uploading a provisioning profile for iOS)
- 2.Optionally enable/disable container-level features
- 3.Trigger builds for each enabled platform
- 1.Select a container version
- 4.Download and/or distribute the containers
Visually, the main components relate as follows:
- Only container versions 23.2.1 or greater are supported in OXIDE. Please contact JourneyApps support if you require a custom-branded container for a older version.
- Configuring SSO for your app is not currently supported in OXIDE. Please see the SSO section below on details to request SSO.
- For iOS only: Apple requires that the iOS container is signed with a valid distribution certificate. See the Special Requirements for iOS Containers section.
Please see below for the requirements for the container icon:
- A 1024x1024 pixel icon in PNG format, not exceeding 1MB in size.
- Please note that the app icon should not be transparent nor have an alpha channel
Android limitation
As of container version 22.9.1, Android no longer supports custom launch screen images. This is in accordance with requirements that Android 12 introduced.
The launch screen on Android will show the container icon in a centered position, surrounded by a solid background color. The background color should be specified by providing a 2208x2208 pixel image in PNG format containing a solid color.
Please see below for the requirements for the launch screen image:
- A 2208x2208 pixel image in PNG format, not exceeding 1MB in size.
- The launch image typically consists of your company’s full logo (and slogan) on a solid color background. The logo is positioned in the center of the image and is ideally 745 pixels wide.
- Please note that the launch screen should have no alpha channel.
Click the + icon or trigger the Create container configuration action using the command palette.
What follows is a wizard through all settings that can be configured for a container:
Configure general settings for the container, including the Bundle ID and automatically creating new container builds when a new container version becomes available.
- Bundle ID
- Uniquely identifies the container on a device
- Recommended format is xxxx.xxxx.xxxx, e.g. com.orgname.appname, excluding any special characters since platforms have different requirements (see next point).
- Requirements:
- It must have at least two segments (one or more periods).
- Each segment must start with a letter.
- All characters must be alphanumeric or an underscore [a-zA-Z0-9_].
- May not contain Java Keywords.
- Must contain only alphanumeric characters (A–Z, a–z, and 0–9), hyphens (-), and periods (.)
- Must match the value in the
application-identifiervalue in the provisioning profile if supplied
- Windows:
- Must contain only alphanumeric characters (A–Z, a–z, and 0–9) and periods (.)
- Auto build new versions
- This relates to triggering builds. If enabled, when a new container version becomes available, a new build will be triggered for all included platforms.
- Enable new features
- If enabled, when new container features become available, they will automatically be enabled for new builds for supported platforms.
- Download link identifier
- Set an identifier for the configuration that is used in a long-lived link to download the latest versions of a container per platform.
- The format of these links is
https://appinstall.xyz/download/[org-name]-[download-link-identifier]/[platform]- Example:
https://appinstall.xyz/download/acme-inventory-app/android
Select all platforms that you’d like to create a container for and should share the settings defined in this container configuration. Some additional configuration options are specific to certain platforms - these are displayed when a platform is selected.
- Enable debug mode
- Generate unsigned IPA
- This will skip signing during the build process. If you select this option, you will need to sign the IPA manually before you can install the container.
- A provisioning profile is required if not checked (i.e. generating a signed build).
- Provisioning profile
- Upload the provisioning profile that you have created for the container using your Apple developer account. See more details in the Special Requirements for iOS Containers section.
- A general error notification should appear if the provisioning profile is expired (the
ExpirationDatefield in the provisioning profile is examined and compared to the current date).
Upload existing private key into OXIDE
If your container's provisioning profile was not created using OXIDE's Create iOS container private key CSR action (see this section for details), the private key associated with the iOS Distribution certificate which is embedded into the provisional profile needs to be uploaded into OXIDE. Trigger the Upload iOS Container private key action to upload it. The private key must be in PEM format.
- Enable debug mode
- This option is only available in version 23.7.1 or greater of the JourneyApps container
Note that some features are only available for certain platforms, and on some container versions.
For iOS, usage descriptions can also be customized here when a feature that supports these is enabled. See which features support these in the table here.
Configure the container name, icon and launch screen image.
- Container name
- The name displayed with the container icon (e.g. on your device’s app screen). This is typically your app’s name.
- Container icon
- Must be a png image with dimensions 1024x1024
- Launch screen image
- Must be a png image with dimensions 2208x2208
The fields in this section are optional. Link your container to one of your app’s deployments by entering a Company ID, or customize the URL scheme of the container.
- Company ID
- Links the container to one of your app’s deployments
- Required for SSO
- When specified, app users will not have to enter the Company ID when signing in with a JourneyApps username and password
- URL scheme
- Used by SSO
The fields in this section are optional. Configure advanced settings such as enabling exception domains and a proxy for your container.
- Enable HTTP exception domains
- Allows access to unsecured domains via HTTP
- Exception domains
- List of domains
- Must be a comma-separated list of domains, e.g. “foo.example.com,foo2.example.com”
- Enable HTTP proxy
- Funnel all network traffic through the provided proxy
- Proxy host
- Must be a single valid domain e.g. “sub.example.com”
- Proxy port
- Must be a number e.g. 9000
SSO configuration for your container needs to be completed by JourneyApps. Please reach out to JourneyApps Support to request SSO for your container and include the following details from your container configuration:
We will notify you when SSO has been configured. At that point, you can go ahead an trigger builds for the container configuration.
Once a container configuration has been finalized, container builds can be triggered. The build process produces the container that can be installed on a supported device.
Trigger the Create container build action:
- Select one of your enabled platforms
- Only your enabled platforms for the container configuration will be shown here.
- Select a container version
- A warning will be shown if any of the enabled container features are not supported in the selected container version.
Note: The build process for a container can take a while (typically around 10 or 20 minutes).
The Builds section will list all build processes and includes the build status: in progress, completed, or failed.
After a build succeeds, shareable links to download and install the container will become available.
Developers can configure a long-lived link that can be used to download the latest build per platform in a configuration by specifying a Download link identifier. See the General section. Once an identifier for the link has been set, and a build is available, the latest build can be downloaded by clicking on the corresponding platform pill (or right-click to copy a shareable link):
Containers can also be downloaded for a specific build. Click on the build artifact button to download it, or right-click to copy a shareable link (note: these links expire within 7 days):
The container configuration wizard contains several validations to minimize issues during the build process.
That said, if a build fails, our support team will be able to review its build logs to assist with troubleshooting. Please contact JourneyApps Support and include the following information:
- 1.Link to the app where the container was created
- 2.The build ID. This can be copied from the build summary by hovering over the ID field:
Last modified 1mo ago