npm run build
npm run serve
That will build the action code inside an express app, with src/express.js as entry point watching any changes. In parallel it will rerun the express server if src files change.
These are pages that match
/<lang>/docs/*or/<lang>/playlists/*
At a minimum, you need to create a file at build/.local.env in this repo, that contails below, then run npm run serve
EXL_API_HOST=https://experienceleague.adobe.com
see description of this env variables in the
Application environment variablessection.
These are pages from AEMaaCS, like homepage, perspectives ..etc. AKA non-docs and non-playlist pages. You DO NOT need this if you are just working on docs or playlists.
This setup simulates an authenticated request, coming from Edge Delivery Services intended to render from AEM.
- get your local development access token from Cloud Manager Developer Console (see docs below)
- Add file
build/.local.envthat should have the contents below (replace<token>with your token and<aem author>with the author url)see description of these env variables in the
Application environment variablessection.
AEM_AUTHOR_URL=<aem author>
OWNER=adobe-experience-league
REPO=exlm
BRANCH=main
# get your local development access token from Cloud Manager Developer Console
ACCESS_TOKEN=<token>
see cloud manager documentation on Developer Console and access
- Navigate to Cloud Manager (If you dont have access to Cloud Manager, contact your program Admin)
- Find your Program (again, contact your admin for program Name)
- Find your environment
- Navigate to the Developer Console for that environment
- Click on
integrationTab - Click on
Get Local Development Token
Developer tokens are short lived and should only be used for local testing/debugging.
This is specifically for the khoros action.
in local, and lower environments, iPaaS is used to proxy to khoros services.
The khoros action is available locally at localhost:3030/khoros/<proxy path here> when you run npm run serve
this local setup requires the follwoing env variables to be added to build/.local.env
please reach out to the dev team for these values
KHOROS_ORIGIN=<the ipass origin used to proxy to khoros>
KHOROS_API_SECRET=<the khoros dev env API secret>
IMS_ORIGIN=<the ims origin to auth agains, use the stage origin>
IMS_CLIENT_ID=<the ims client id used to obtain a token to access iPaaS>
IMS_CLIENT_SECRET=<the ims client secret used to obtain a token to access iPaaS>
IMS_AUTHORIZATION_CODET=<the ims client auth code used to obtain a token to access iPaaS>
IPASS_API_KEY=<the ipass api key for dev iPaaS service for the given KHOROS_ORIGIN>
see description of these env variables in the
Application environment variablessection.
Please note, on Prod, iPaaS is not used, the khoros endpoint is called directly.
The action is built and deployed by a github workflow.
To deploy the action manually use the App Builder CLI. The Getting Started guide for AIO Runtime provides detailed steps to setup a local environment.
If you want to test this action on your own runtime application, it is recommended to deploy the current work-in-progress into a separate package, e.g. using your username. Remember, the branch name will be used by the automated deployment. To change the package name, modify the app.config.yaml.
aio app deploy
The action requires the follwoing environment variables/secrets to be set:
see github docs for how to add those: https://docs.github.com/en/actions/learn-github-actions/variables#creating-configuration-variables-for-a-repository
| Name | Type | required for Prod? | description |
|---|---|---|---|
AIO_RUNTIME_AUTH |
secret | yes | used to deploy the action |
AIO_RUNTIME_NAMESPACE |
secret | yes | used to deploy the action |
| Name | Type | required for Prod? | description |
|---|---|---|---|
OWNER |
var | yes | this repo owner, sent to AEM for AEM content |
REPO |
var | yes | this repo name, sent to AEM for AEM content |
BRANCH |
var | yes | this repo branch, sent to AEM for AEM content |
AEM_AUTHOR_URL |
var | yes | AEM author instance url to get content from |
KHOROS_ORIGIN |
secret | yes | the origin used to proxy khoros requests |
KHOROS_API_SECRET |
secret | yes | the API secret used for khoros requests |
IMS_ORIGIN |
secret | yes | the IMS origin to call for IMS authentication |
IMS_CLIENT_ID |
secret | no | the IMS client id to use for IMS authentication |
IMS_CLIENT_SECRET |
secret | no | the IMS client secret to use for IMS authentication |
IMS_AUTHORIZATION_CODE |
secret | no | the IMS auth code to use for IMS authentication |
IPASS_API_KEY |
secret | no | the API KEY for iPaaS - for khoros API in lower environments |
EXL_API_HOST |
var | no | https://experienceleague.adobe.com |
FEATURE_FLAGS |
var | no | comma separated feature flags that affect converter behavior |
IMS_CLIENT_ID,IMS_CLIENT_SECRET,IMS_AUTHORIZATION_CODEandIPASS_API_KEYare not required for prod and are maked so because we do not use iPaaS in prod, which requires IMS authenticationIMS_CLIENT_IDis required in all envs sincve we need it for IMS token validation
if your converter returns a result such as:
{
"code": "Ir5gfWfUoG33dvMb7nPAu2c6ckH7ocQg",
"error": "Response is not valid 'message/http'."
}
The action activation likely failed, to debug, you need to run your action with header: X-OW-EXTRA-LOGGING: on.
To get activation/application logs, you can run:
aio runtime activation log --last- logs the last activation logaio runtime activation result --last- logs last activation resultaio app logs- application logs