# Configure

This page explains how to configure the Kameleo Engine using an appsettings.json file, environment variables, or command-line flags, and the precedence between them.

# Prerequisites

Kameleo installed (see Installation)
Ability to run the Engine binary (headless or via Desktop)
Text editor for creating appsettings.json (optional)

# 1. Choose a configuration method

You can supply values via (choose any combination):

File: appsettings.json
Environment variables
Command-line flags (key=value)

Use the method that matches your deployment style (local dev, CI, container, etc.).

Mix & match

You can keep stable defaults in the file and override the PAT via environment variables or flags. Precedence (highest wins): flags > environment variables > appsettings.json.

# 2. Create `appsettings.json` (optional)

Location:

Platform	Path
Windows	%APPDATA%\Kameleo
macOS	~/Library/Application Support/Kameleo
Docker (Linux)	`/data`
Docker (Windows)	`C:\data`

Minimal example:

{
    "ListeningHost": "+",
    "ListeningPort": 5050,
    "Verbose": 1
}

Complete key list and defaults are available at Configuration options

# 3. Generate a personal access token (PAT)

A personal access token (PAT) authenticates the Engine with your Kameleo account. You must either provide a valid PAT every time the Engine starts (suited for automation scenarios) or login using the GUI once to access your account.

Open https://login.kameleo.io/PAT in your browser and sign in.
Click Generate new token.
Copy the token immediately — it is shown only once.
Store the token securely (e.g., in a secrets manager or environment variable). Do not commit it to source control.

Token visibility

The token value is displayed only at creation time. If you lose it, generate a new one and revoke the old token.

# 4. (Alternative) Use environment variables

Set variables before launching the Engine.

$Env:PAT="your-pat"; ./Kameleo.Engine.exe

PAT="your-pat" ./Kameleo.app/Contents/Resources/Engine/Kameleo.Engine

# 5. (Alternative) Use command-line flags

Append key=value arguments to the executable.

./Kameleo.Engine.exe pat=your-pat

./Kameleo.app/Contents/Resources/Engine/Kameleo.Engine pat=your-pat

# 6. Start the Engine

Run the Engine (Desktop auto-starts it). Example with flags shown above; omit if using file+env only.

# 7. Verify

Open: http://localhost:5050/swagger

Expect the Swagger UI to load. Change ListeningHost / ListeningPort to relocate the endpoint (e.g., 0.0.0.0 for LAN access, custom port for collisions).