Getting Started

Deploy CPI Developer Studio to your BTP Cloud Foundry subaccount in under 10 minutes.

Prerequisites

Step 1: Deploy the Docker Image

CPI Studio is distributed as a Docker image. Deploy it with a single command:

cf push cpi-developer-studio \
  --docker-image ghcr.io/nxgenz/cpi-studio:1.0.0 \
  --docker-username YOUR_GITHUB_USERNAME \
  -m 512M

When prompted, enter your Docker registry password (GitHub Personal Access Token with read:packages scope).

Step 2: Set Environment Variables

# License key (received after purchase)
cf set-env cpi-developer-studio LICENSE_KEY "CPIS-XXXX-XXXX-XXXX-XXXX"

# Flask secret (generate a random string)
cf set-env cpi-developer-studio FLASK_SECRET_KEY "$(openssl rand -hex 32)"

# Restage to apply
cf restage cpi-developer-studio

Step 3: Set Up BTP Authentication (XSUAA)

Instead of managing usernames/passwords, use your BTP identity provider:

a) Create the XSUAA service

# Download xs-security.json from our docs, then:
cf create-service xsuaa application cpi-studio-xsuaa -c xs-security.json
cf bind-service cpi-developer-studio cpi-studio-xsuaa
cf restage cpi-developer-studio

b) Assign roles in BTP Cockpit

  1. Go to Security → Role Collections
  2. You'll see three pre-created collections: CPI Studio Admin, CPI Studio Developer, CPI Studio Viewer
  3. Assign users from your identity provider to the appropriate collection

Tip: The "Sign in with BTP" button appears automatically on the login page when XSUAA is bound. Users are assigned roles based on their BTP Role Collection.

Step 4: Connect Your CPI Tenant

  1. Log in to CPI Studio
  2. Go to Settings → Connection
  3. Enter your CPI host URL, OAuth token URL, client ID, and client secret
  4. Click Test Connection to verify
  5. Save as a Tenant Profile for quick switching

That's it!

You're ready to browse iFlows, edit Groovy scripts, monitor message logs, and manage deployments — all from your browser.

Next: Configuration → Licensing →