contextforge-dev-tools/.env.example at main · contextforge-org/contextforge-dev-tools · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
# Default local configuration for cf-integration.
#
# Copy this file to .env for local runs. .env is ignored by git.
# Shell variables override values from .env:
#   CF_CONTROLPLANE_REF=user/luca/dataplane-integration-fixes \
#     cargo run --locked -- stack up --lane external

# Default execution lane. Possible: builtin, external.
CF_MCP_LANE=external

# Optional developer checkout containing source overlays. Without this, the
# current directory is the workspace and the binary can materialize embedded
# assets beneath CF_INTEGRATION_DIR.
# CF_INTEGRATION_ROOT=/path/to/contextforge-dev-tools

# cf-controlplane checkout. Default: main.
# Possible: any branch, tag, or commit accepted by git checkout.
CF_CONTROLPLANE_REF=main

# cf-controlplane repository. Default: IBM upstream.
# Possible: any git clone URL.
CF_CONTROLPLANE_REPO=https://github.com/IBM/mcp-context-forge.git

# cf-controlplane image used by upstream compose. By default, the harness maps
# the freshly fetched origin/main revision to its commit-tagged GHCR image.
# Set the full override only to select a different registry or immutable tag.
# Possible: any Docker image reference.
# CF_CONTROLPLANE_IMAGE=ghcr.io/ibm/mcp-context-forge:<tag>

# Official cf-controlplane image selector. Default: main. `main` resolves to the
# fetched origin/main SHA because upstream reserves `latest` for releases.
CF_CONTROLPLANE_VERSION=main

# Build behavior. Default: auto.
# Possible:
#   auto  - pull/reuse prebuilt images; build only an explicitly selected source dataplane
#   true  - always pass docker compose --build (for explicit local development)
#   false - never pass --build
CF_COMPOSE_BUILD=auto

# Force a matching running integration stack to restart. Default: false.
CF_FORCE_STACK_RESTART=false

# Compose project names. Defaults shown.
CF_INTEGRATION_PROJECT=cf
CF_CONTROLPLANE_PROJECT=cf-controlplane-only

# Gateway replica count. Default: 1 for local integration runs.
# Possible: positive integer. Use 2+ only when explicitly testing multi-instance gateway behavior.
GATEWAY_REPLICAS=1

# Generated checkout/build/runtime directory. Default: .integration.
CF_INTEGRATION_DIR=.integration

# cf-dataplane source checkout. Default: empty, which means published image mode.
# Set this to any branch, tag, or commit to checkout/build cf-dataplane locally.
# Possible: main, user/luca/cp-parity-tool-names, any ref accepted by git checkout.
# CF_DATAPLANE_REF=user/luca/cp-parity-tool-names

# cf-dataplane repository. Default: contextforge-org upstream.
# Possible: any git clone URL.
CF_DATAPLANE_REPO=https://github.com/contextforge-org/contextforge-data-plane.git

# cf-dataplane checkout directory. Default: .integration/contextforge-data-plane.
CF_DATAPLANE_DIR=.integration/contextforge-data-plane

# Local cf-dataplane image tag used when CF_DATAPLANE_REF is set and CF_DATAPLANE_IMAGE is unset.
# Possible: any Docker image reference.
CF_DATAPLANE_LOCAL_IMAGE=contextforge-org/contextforge-data-plane:local

# Full cf-dataplane image override. With no source ref or full override, the
# published default derives from CF_DATAPLANE_VERSION (currently latest). Leave
# the full override unset in source mode to use CF_DATAPLANE_LOCAL_IMAGE.
# CF_DATAPLANE_IMAGE=ghcr.io/contextforge-org/contextforge-data-plane:<tag>
CF_DATAPLANE_VERSION=latest

# Registry refresh policy for prebuilt images. Default: always.
# Set to never only after loading the exact image into the local Docker daemon.
# CF_CONTROLPLANE_PULL_POLICY=never
# CF_DATAPLANE_PULL_POLICY=never

# cf-dataplane image platform. Default: auto.
# auto resolves to linux/amd64 in published image mode, or the Docker server platform
# when CF_DATAPLANE_REF is set for a local source build.
# Possible: auto, linux/amd64, linux/arm64, or any platform supported by the selected image.
CF_DATAPLANE_PLATFORM=auto

# Dataplane publisher interval in seconds. Default: 2 for fast local tests.
# Possible: positive integer. Use 60 to match older/default upstream behavior.
CF_DATAPLANE_PUBLISHER_INTERVAL_SECONDS=2

# Dataplane per-user config cache TTL in seconds. Default: 0 for functional tests.
# Possible: non-negative integer. Use 60 to restore the dataplane image default for load benchmarks.
CF_DATAPLANE_USER_CONFIG_CACHE_EXPIRY_SECONDS=0

# Optional comma-separated transport allowlist overrides. Defaults cover the
# loopback nginx origin using NGINX_PORT and the internal `nginx` service name
# used by containerized Locust runs.
# CF_DATAPLANE_MCP_ALLOWED_HOSTS=127.0.0.1:8080,localhost:8080,nginx
# CF_DATAPLANE_MCP_ALLOWED_ORIGINS=http://127.0.0.1:8080,http://localhost:8080

# Guarded Fast Time contract and default registered virtual server.
CF_FAST_TIME_EXPECTED_IMAGE=ghcr.io/ibm/cfex-mcp-fast-time-server:latest
CF_FAST_TIME_SERVER_ID=9779b6698cbd4b4995ee04a4fab38737

# Public nginx port. Default: 8080.
NGINX_PORT=8080

# Optional fixed loopback port for the direct conformance fixture. Zero asks
# Docker to allocate an ephemeral port.
# CF_CONFORMANCE_PORT=0
# Direct public-origin override; otherwise derived from NGINX_PORT.
# MCP_CLI_BASE_URL=http://127.0.0.1:8080

# Optional operational MCP protocol mode override for probe, load, live, and
# Inspector workflows. Possible: modern, legacy. Default: modern.
# MCP_PROTOCOL_VERSION=modern

# Local integration administrator. Stable random signing/encryption secrets are
# created automatically under CF_INTEGRATION_DIR when their overrides are unset.
PLATFORM_ADMIN_EMAIL=admin@example.com
PLATFORM_ADMIN_PASSWORD=changeme
# JWT_SECRET_KEY=<integration-secret>
# AUTH_ENCRYPTION_SECRET=<integration-encryption-secret>

# Optional existing fixture and token overrides. Empty values use the harness
# Fast Time fixture; managed dataplane workflows request and revoke a
# control-plane API token whose UUID subject matches the published snapshot.
# MCP_SERVER_ID=<virtual-server-id>
# MCPGATEWAY_BEARER_TOKEN=<token>

# Locust load defaults. A smoke run uses 1 user at 1 user/second
# for 10s unless LOCUST_* is exported by the calling process.
LOCUST_USERS=100
LOCUST_SPAWN_RATE=10
LOCUST_RUN_TIME=5m
# Positive finite per-request deadline for the Locust adapter. Default: 60 seconds.
LOCUST_REQUEST_TIMEOUT_SECONDS=60

# Optional control-plane-only test behavior.
# CONTROLPLANE_ENABLE_SSO=true