PhronIQ

Get started with API Gateway (local evaluation)

Mon, 01 Jan 0001 00:00:00 +0000

This guide walks through standing up a local evaluation stack on a workstation with Docker Compose, and signing in to both the Admin Console and the Developer Portal for the first time.

This is not the production install. The local stack is for trying the product on one machine. A production deployment runs on Kubernetes from an offline bundle that includes every image and its own installation guide; it is delivered with your licence. To arrange an installation, email hello@phron.tech.

Get started with Enterprise Service Bus

Mon, 01 Jan 0001 00:00:00 +0000

Prerequisites

Docker and Docker Compose (v2.23 or later)
A PhronIQ deployment package and licence key (see below)

Start the stack

ESB ships as a licensed artifact, not as source. After your order, PhronIQ delivers a deployment package — the esb container image plus the docker-compose.yml bundle — and a PhronIQ-signed licence key.

Unpack the deployment package and change into its directory.
Install the licence key before the first start: point licence.file in config.yaml at the key file you were issued (or set ESB_LICENCE_FILE / ESB_LICENCE_KEY). The daemon verifies the key at startup and refuses to start without one (licence-missing). The Deployment guide’s Licence key section has the details.
Start the stack:

docker compose up -d

This starts:

Getting started with FormulAI

Mon, 01 Jan 0001 00:00:00 +0000

Enterprise Agent Platform — Build, run, and manage AI workflows with human-in-the-loop approval.

Roles

Role	Permissions	Use Case
Admin	Full access: models, tools, analytics, all workspaces	Platform setup, monitoring, configuration
Operator	Create and edit use cases, run executions, read memory, export documents	Build and run AI workflows
Reviewer	Run executions, read memory, export documents	Run and check AI outputs

Your administrator assigns roles. Within a workspace, members also hold a workspace role (viewer, member, admin or owner) that controls what they can see and change there.

IssueTracker user guide

Mon, 01 Jan 0001 00:00:00 +0000

Overview

IssueTracker is a comprehensive project management platform with advanced features for issue tracking, compliance management, change management, and real-time collaboration.

Quick Start

Getting Started

Access the Platform
- Navigate to your Instance URL
- Log in with your credentials
- Select or create a workspace
Dashboard Overview

Web Application Firewall user guide

Mon, 01 Jan 0001 00:00:00 +0000

Use this guide to understand the WAF Console, its role-based pages, and the workflows for protecting and investigating traffic.

In-app help: click the ? icon in the top header from any page to open this guide inside the Console, filtered to what’s relevant to your role.

Option 1: OIDC SSO (recommended for production)

Click Sign in with SSO on the login page.
Select your organization’s identity provider.
Complete your organization’s authentication flow. You’re redirected back to the Console already signed in.

OIDC providers are configured by a security_admin/owner under Settings → OIDC (see Settings).

API Gateway administrator guide

Mon, 01 Jan 0001 00:00:00 +0000

The Admin Console (http://localhost:5173 locally) is where platform admins configure environments, publish and govern APIs, manage traffic policies and certificates, run canary/blue-green rollouts, and monitor the gateway. This guide covers every tab in the console.

All actions require an Admin Token (see Getting Started). Most actions additionally require that your token’s role grants access to the specific environment you’re acting on — see Permissions below.

Console layout

The top bar (config bar) holds the Control Plane URL, an optional Sign in with SSO field (shown only when no token is set), and the Admin Token field itself, with a Sign Out button to clear it.

Web Application Firewall operator guide

Mon, 01 Jan 0001 00:00:00 +0000

This guide describes the operator workflow across the WAF console’s operations and tuning pages. All pages are under /dashboard/ in the management UI.

Prerequisites

A tenant and environment must be selected in the top-bar picker before any page loads operational data.

Pages & Workflows

1. Managed Rules — `/dashboard/managed-rules`

Manage rule packages, view CRS coverage, configure anomaly thresholds, and manage false-positive exclusions.

Workflow:

Packages tab — Browse installed rule packages (OWASP CRS, etc.).
Coverage tab — View per-package rule seeding rate and compatibility status.
CRS Config tab — Toggle CRS on/off, set mode (detect/block), paranoia level, and inbound/outbound anomaly thresholds.
Exclusions tab — Add/remove false-positive exclusions by rule ID, tag, target variable, or route scope.

2. DDoS Operations — `/dashboard/ddos`

View active DDoS mitigations, anomaly campaigns, and configure rate-limit thresholds.

Connect a system

Mon, 01 Jan 0001 00:00:00 +0000

Wire an external system into ESB as a route that the mediation engine can invoke. A route binds a service + operation to an outbound endpoint over a supported protocol. This guide covers choosing a protocol, referencing credentials (never pasting plaintext), testing connectivity, and deploying.

Prerequisites

A running ESB (see Getting Started).
A target system reachable from the ESB container.
For protocol UI setup: the Connectors view in the admin console.
A stored secret reference for any credential the endpoint needs (the Secret References page in the admin console, backed by Vault, environment variables or AWS as configured in enterprise.secrets.provider).

Step 1 — Choose a protocol

ESB supports the connector protocols listed below. Pick by what the remote system speaks:

API Gateway developer portal guide

Mon, 01 Jan 0001 00:00:00 +0000

The Developer Portal (http://localhost:5174 locally) is where API consumers browse the API catalog, register applications, request access, and manage the API keys and subscriptions those applications use.

Signing in

See Getting Started for the first-login walkthrough.

Local/development deployments: email-only, passwordless login. Enter Email and optional Display Name, click Log In. Dev-only — this is explicitly disabled in production deployments, where real identity verification is required instead.
Session behavior: your session token is valid for 8 hours. It’s stored both as an httpOnly cookie and in the browser session. If a request comes back unauthorized, the portal automatically signs you out and returns you to the login screen — there’s no separate “your session expired” message, just a return to the login form (see Troubleshooting for what this looks like).
Sign Out is available from the top navigation once logged in.

Once signed in you land on the Catalog view. The top navigation offers: Catalog, My Applications, Create Application, Test, and Developer Onboarding, plus your name/email and Sign Out.

Troubleshoot API Gateway

Mon, 01 Jan 0001 00:00:00 +0000

This guide covers common failure modes in both the Admin Console and the Developer Portal, grounded in how the backend actually reports errors. Both apps show errors the same way: a red status banner with a role=“alert” message, immediately below the form or panel where the action was triggered — the banner text is almost always the backend’s raw error message.

General principles

Errors are surfaced verbatim. Both UIs render err.message from the failed API call directly into the error banner, so the wording you see in the console/portal is close to the literal backend error string.
No client-side rollback. In the Admin Console’s Quick Publish/Wizard flows, each step (environment → upstream → API → version → route → policies → activation) runs sequentially and reports ✓ as it succeeds. If a later step fails, the earlier steps are not undone — you’ll have a partially-created set of resources. Use the APIs tab’s Browse APIs panel to see exactly what exists, and either finish the remaining steps manually (Policies tab, etc.) or clean up.
A generic 500 doesn’t always mean “server broken.” Two specific admin console actions — activating a configuration version and publishing a route — return a 500-level error even when the underlying cause is a user-fixable validation problem (e.g. an invalid configuration snapshot). If you get an unexpected server error immediately after changing a route/policy, re-check your configuration for validity (try Preflight on the APIs tab first) before assuming an infrastructure problem.

Admin Console

“Admin Token is required” / actions are grayed out

You haven’t entered a token yet, or you cleared it with Sign Out. Paste a token or use Sign in with SSO. See Getting Started.

PhronIQ

Get started with API Gateway (local evaluation)

Get started with Enterprise Service Bus

Prerequisites

Start the stack

Getting started with FormulAI

Table of Contents

Roles

IssueTracker user guide

Overview

Contents

Quick Start

Getting Started

Web Application Firewall user guide

Table of Contents

Option 1: OIDC SSO (recommended for production)

API Gateway administrator guide

Console layout

Web Application Firewall operator guide

Prerequisites

Pages & Workflows

1. Managed Rules — `/dashboard/managed-rules`

2. DDoS Operations — `/dashboard/ddos`

Connect a system

Prerequisites

Step 1 — Choose a protocol

API Gateway developer portal guide

Signing in

Troubleshoot API Gateway

General principles

Admin Console

“Admin Token is required” / actions are grayed out

PhronIQ

Get started with API Gateway (local evaluation)

Get started with Enterprise Service Bus

Prerequisites

Start the stack

Getting started with FormulAI

Table of Contents

Roles

IssueTracker user guide

Overview

Contents

Quick Start

Getting Started

Web Application Firewall user guide

Table of Contents

First Login

Option 1: OIDC SSO (recommended for production)

API Gateway administrator guide

Console layout

Web Application Firewall operator guide

Prerequisites

Pages & Workflows

1. Managed Rules — /dashboard/managed-rules

2. DDoS Operations — /dashboard/ddos

Connect a system

Prerequisites

Step 1 — Choose a protocol

API Gateway developer portal guide

Signing in

Troubleshoot API Gateway

General principles

Admin Console

“Admin Token is required” / actions are grayed out

1. Managed Rules — `/dashboard/managed-rules`

2. DDoS Operations — `/dashboard/ddos`