Files
copilotkit__copilotkit/examples/slack/.env.example
Benjamin Taylor a758faa19d fix(channels): CR follow-ups — honest stopped status + correct .env WS port (OSS-482)
Two fixes from the pre-merge adversarial CR of this PR (both pre-existing,
flagged as in-subject):

- ChannelManager.status() reported overall "online" for a manager stopped
  BEFORE activate() (e.g. SIGTERM during startup): `entries` is empty, so the
  empty-set fold returned "online" — a torn-down manager reading healthy. Now
  short-circuits to "stopped" when `this.stopped`, matching the documented
  status() contract. New red-green test covers the stop()-before-activate() case.

- examples/slack/.env.example: COPILOTKIT_INTELLIGENCE_WS_URL example was
  ws://localhost:4401, but derivation is a scheme-only swap of the :4201 API URL
  (→ ws://localhost:4201) and 4401 is used nowhere — a user uncommenting it hit a
  dead port. Corrected to :4201 and clarified the derivation note.
2026-07-15 10:50:20 -05:00

99 lines
5.6 KiB
Bash

# Set SLACK_*, DISCORD_*, TELEGRAM_BOT_TOKEN, and/or WHATSAPP_* — the bot starts
# an adapter for each platform whose secrets are present (any one, or several at
# once).
# ── Slack credentials (from api.slack.com/apps → your app) ──────────────
# Set both to run on Slack; leave blank to skip Slack.
# Bot Token: OAuth & Permissions page, "Bot User OAuth Token" (xoxb-...)
SLACK_BOT_TOKEN=xoxb-...
# App-Level Token: Basic Information → App-Level Tokens → generate with the
# "connections:write" scope (xapp-...)
SLACK_APP_TOKEN=xapp-...
# ── Discord credentials (from discord.com/developers/applications → your app) ──
# Set both to run on Discord; leave blank to skip Discord. Bot page → "Reset
# Token"; under "Privileged Gateway Intents" enable BOTH Message Content and
# Server Members (both required). Application ID is on General Information.
# DISCORD_BOT_TOKEN=
# DISCORD_APP_ID=
# Optional: a guild (server) id registers slash commands instantly during dev
# (global commands can take up to ~1h). Omit in production.
# DISCORD_GUILD_ID=
# ── Telegram credentials (from @BotFather on Telegram) ──────────────────
# Set to run on Telegram; leave blank to skip Telegram. Message @BotFather →
# /newbot → copy the token it gives you. Long-polling is the default ingress
# (no public URL or webhook setup needed).
# TELEGRAM_BOT_TOKEN=
# ── Agent backend (runtime.ts) ──────────────────────────────────────────
# The AG-UI endpoint the bridge POSTs to. Default points at the local
# CopilotKit runtime started by `pnpm runtime`.
AGENT_URL=http://localhost:8200/api/copilotkit/agent/triage/run
# Optional auth header forwarded to the agent (for a deployed runtime).
# AGENT_AUTH_HEADER=Bearer ...
# Model for the agent. This runtime is OpenAI-only (its web search is an OpenAI
# hosted provider tool), so AGENT_MODEL must be an OpenAI model id — either bare
# ("gpt-5.5-mini") or "openai/<id>" (the "openai/" prefix is stripped). Defaults
# to openai/gpt-5.5. OPENAI_API_KEY is required.
# AGENT_MODEL=openai/gpt-5.5-mini
OPENAI_API_KEY=sk-...
# ── Intelligence (managed Channel) mode — app/managed.ts (`pnpm channel`) ─
# The managed variant runs the SAME bot over Intelligence instead of a native
# adapter — it holds NO Slack tokens (Intelligence owns the Slack edge). Set
# these to run `pnpm channel`; the native `pnpm dev` ignores them. The agent
# brain reuses AGENT_URL / AGENT_AUTH_HEADER above. There is NO launcher and no
# infra ids to supply: the runtime derives project, adapter, and channel from
# the config below plus the channel name chosen in app/managed.ts.
# Intelligence platform API base URL.
# COPILOTKIT_INTELLIGENCE_URL=http://localhost:4201
# Project runtime API key (cpk-…).
# COPILOTKIT_API_KEY=cpk-...
# Optional: websocket base URL. Derived from COPILOTKIT_INTELLIGENCE_URL by a
# scheme-only swap (http→ws, same host+port) when unset — so the default here is
# ws://localhost:4201, matching the API URL above.
# COPILOTKIT_INTELLIGENCE_WS_URL=ws://localhost:4201
# ── Linear MCP ──────────────────────────────────────────────────────────
# The hosted Linear MCP accepts a raw API key as a bearer token (no OAuth
# dance). Create one at linear.app → Settings → API → Personal API keys.
# Leave LINEAR_API_KEY blank to run without Linear — a non-blank value turns the
# Linear MCP ON, so keep it empty unless you have a real key.
LINEAR_API_KEY=
# Override only if you front the MCP yourself; default is the hosted server.
# LINEAR_MCP_URL=https://mcp.linear.app/mcp
# Default Linear team the bot files/queries against.
LINEAR_TEAM_KEY=CPK
# ── Notion MCP ──────────────────────────────────────────────────────────
# Run the official Notion MCP as a Streamable-HTTP sidecar: `pnpm notion-mcp`.
# NOTION_TOKEN is the Notion integration secret the sidecar uses to call the
# Notion API (notion.so → Settings → Connections → develop integrations).
# NOTION_MCP_AUTH_TOKEN is the bearer the sidecar requires on its HTTP
# transport; the agent sends it. Pick any strong string and use it in both
# `pnpm notion-mcp` and here. Leave NOTION_MCP_AUTH_TOKEN blank to run
# without Notion.
# Both are blank by default — a non-blank NOTION_MCP_AUTH_TOKEN turns the Notion
# MCP ON. NOTION_TOKEN is only needed when you actually run `pnpm notion-mcp`.
NOTION_TOKEN=
NOTION_MCP_AUTH_TOKEN=
# Port the `pnpm notion-mcp` sidecar listens on (default 3001). If you change
# it, update the port in NOTION_MCP_URL below to match.
# NOTION_MCP_PORT=3001
# Override only if the sidecar runs elsewhere; default is the local sidecar.
# NOTION_MCP_URL=http://127.0.0.1:3001/mcp
# ── WhatsApp Cloud API (optional — omit to run Slack-only) ──────────────
# From your Meta App → WhatsApp → API Setup. Leave WHATSAPP_ACCESS_TOKEN blank
# to disable the WhatsApp adapter entirely. Use a System User token in prod
# (the temporary token expires in 24h).
WHATSAPP_ACCESS_TOKEN=
WHATSAPP_PHONE_NUMBER_ID=
WHATSAPP_APP_SECRET=
WHATSAPP_VERIFY_TOKEN=choose-any-string-and-paste-it-in-the-webhook-config
# Webhook path (default /webhook). The server listens on $PORT — Railway injects
# it and routes the service's public domain there; locally it defaults to 3000.
# WHATSAPP_PATH=/webhook