Installation Instructions

Prerequisites

• Node.js 18+

• Adobe I/O CLI

Adobe Console preparation

Create a new project

Go to console.adobe.io and create a new project from template: "App Builder"

To required environment add:

• I/O Events

Installation

Step 1: Clone the repository

Step 2: Run npm install to install the dependencies

Step 3: Go to ( https://developer.adobe.com/console ) Project, select Environment, and click on the "Download All" button.

Step 4: Execute the aio app use <path-to-file> with the file you just downloaded. (Merge files if you already have a .env file)

Edit the .env file with your project details. Set the following variables:

ADOBE I/O RUNTIME CONFIGURATION

• Runtime authentication token (get from Adobe I/O Console)

AIO_runtime_auth=YOUR_RUNTIME_AUTH_TOKEN

• Your Adobe App Builder namespace (e.g., 1234567-your-app-name-stage)

AIO_runtime_namespace=YOUR_NAMESPACE

• Adobe I/O Runtime host (usually https://adobeioruntime.net)

AIO_runtime_apihost=https://adobeioruntime.net

ADOBE IMS AUTHENTICATION CONTEXT

• IMS Context Configuration (replace YOUR_CONTEXT_NAME with your actual context name)

• Get these values from Adobe I/O Console > Project > Credentials

• Client ID from your Adobe I/O Console project

AIO_ims_contexts_YOUR_CONTEXT_NAME_client__id=YOUR_CLIENT_ID

• Client secrets (JSON array format)

AIO_ims_contexts_YOUR_CONTEXT_NAME_client__secrets=["YOUR_CLIENT_SECRET"]

• Technical account email

AIO_ims_contexts_YOUR_CONTEXT_NAME_technical__account__email=[e-mail]

• Technical account ID

AIO_ims_contexts_YOUR_CONTEXT_NAME_technical__account__id=[e-mail]

• Required scopes (JSON array format)

AIO_ims_contexts_YOUR_CONTEXT_NAME_scopes=["openid","AdobeID","event_receiver_api","read_organizations"]

• IMS Organization ID

AIO_ims_contexts_YOUR_CONTEXT_NAME_ims__org__id=YOUR_IMS_ORG_ID@AdobeOrg

APPLICATION SPECIFIC CONFIGURATION

• Service API Key (usually same as client ID)

SERVICE_API_KEY=YOUR_SERVICE_API_KEY

NOTE - If the above parameters has been included in the .env file then there is no requirement for this configuration.

• Credentials encryption key (generate a random 32-character string)

CREDENTIALS_ENCRYPTION_KEY=YOUR_32_CHARACTER_ENCRYPTION_KEY

• Generate a random encryption key:

Use: openssl rand -hex 32

Or any 32-character random string

OAuth Configuration (Alternative Method)

OAUTH_CLIENT_ID=YOUR_CLIENT_ID

OAUTH_CLIENT_SECRET=YOUR_CLIENT_SECRET

OAUTH_TECHNICAL_ACCOUNT_ID=[e-mail]

OAUTH_TECHNICAL_ACCOUNT_EMAIL=[e-mail]

OAUTH_ORG_ID=YOUR_IMS_ORG_ID@AdobeOrg

OAUTH_SCOPES=AdobeID, openid, read_organizations, additional_info.projectedProductContext

NOTE - The above variables must be configured compulsorily in the .env file.

Step 5: Run aio app deploy to deploy the app.