Documentation
¶
Index ¶
Constants ¶
const ( EnvBitbucketClientID = "BITBUCKET_CLIENT_ID" EnvBitbucketClientSecret = "BITBUCKET_CLIENT_SECRET" EnvBitbucketForgeAppID = "SUPERPLANE_BITBUCKET_FORGE_APP_ID" EnvBitbucketForgeInstallURL = "SUPERPLANE_BITBUCKET_FORGE_INSTALL_URL" EnvBitbucketForgeJWKSURL = "SUPERPLANE_BITBUCKET_FORGE_JWKS_URL" DefaultBitbucketForgeJWKSURL = "https://forge.cdn.prod.atlassian-dev.net/.well-known/jwks.json" )
const ( EnvDevHostedOpenRouter = "SUPERPLANE_DEV_HOSTED_OPENROUTER" EnvDevOpenRouterAPIKey = "SUPERPLANE_DEV_OPENROUTER_API_KEY" EnvDevOpenRouterManagementKey = "SUPERPLANE_DEV_OPENROUTER_MANAGEMENT_KEY" EnvDevOpenRouterModels = "SUPERPLANE_DEV_OPENROUTER_MODELS" EnvDevOpenRouterBaseURL = "SUPERPLANE_DEV_OPENROUTER_BASE_URL" EnvDevHostedDefaultModel = "SUPERPLANE_DEV_HOSTED_DEFAULT_MODEL" )
const ( EnvGitHubAppID = "SUPERPLANE_GITHUB_APP_ID" EnvGitHubAppSlug = "SUPERPLANE_GITHUB_APP_SLUG" EnvGitHubAppPrivateKey = "SUPERPLANE_GITHUB_APP_PRIVATE_KEY" EnvGitHubAppWebhookSecret = "SUPERPLANE_GITHUB_APP_WEBHOOK_SECRET" )
const ( EnvJiraOAuthClientID = "SUPERPLANE_JIRA_OAUTH_CLIENT_ID" EnvJiraOAuthClientSecret = "SUPERPLANE_JIRA_OAUTH_CLIENT_SECRET" )
const ( EnvLinearOAuthClientID = "SUPERPLANE_LINEAR_OAUTH_CLIENT_ID" EnvLinearOAuthClientSecret = "SUPERPLANE_LINEAR_OAUTH_CLIENT_SECRET" EnvLinearOAuthWebhookSecret = "SUPERPLANE_LINEAR_OAUTH_WEBHOOK_SECRET" )
const ( EnvSentryAppSlug = "SUPERPLANE_SENTRY_APP_SLUG" EnvSentryAppClientID = "SUPERPLANE_SENTRY_APP_CLIENT_ID" EnvSentryAppClientSecret = "SUPERPLANE_SENTRY_APP_CLIENT_SECRET" EnvSentryAppAPIToken = "SUPERPLANE_SENTRY_APP_API_TOKEN" )
const MaxWebhookPayloadSize = 512 * 1024
Variables ¶
This section is empty.
Functions ¶
func MaxEmitCount ¶ added in v0.26.0
func MaxEmitCount() int
func MaxPayloadSize ¶ added in v0.26.0
func MaxPayloadSize() int
func RabbitMQURL ¶
Types ¶
type AnthropicAgentConfig ¶ added in v0.21.0
AnthropicAgentConfig holds the credentials and identifiers needed to talk to a single Anthropic managed agent. Empty values mean managed agents are disabled on this installation.
func LoadAnthropicAgentConfig ¶ added in v0.21.0
func LoadAnthropicAgentConfig() AnthropicAgentConfig
LoadAnthropicAgentConfig reads the env vars for the Anthropic managed-agents integration. If any required value is missing, Enabled() returns false.
func (AnthropicAgentConfig) Enabled ¶ added in v0.21.0
func (c AnthropicAgentConfig) Enabled() bool
Enabled reports whether the Anthropic provider has the credentials it needs to run.
type BitbucketForgeAppConfig ¶
BitbucketForgeAppConfig is SuperPlane Cloud's public Bitbucket Forge app. The process holds the app id and the install link. Tokens arrive from Forge and are not part of this config.
func LoadBitbucketForgeAppConfig ¶
func LoadBitbucketForgeAppConfig() BitbucketForgeAppConfig
LoadBitbucketForgeAppConfig reads the public Forge app from the process environment. Self-hosted leaves these empty. Enabled() is false unless the app id and the install link are both set.
func (BitbucketForgeAppConfig) Enabled ¶
func (c BitbucketForgeAppConfig) Enabled() bool
Enabled reports whether Cloud holds a complete public Bitbucket Forge app.
type DevHostedOpenRouterConfig ¶
type DevHostedOpenRouterConfig struct {
APIKey string
ManagementKey string
Models []string
BaseURL string
DefaultModel string
}
DevHostedOpenRouterConfig is the opt-in local seed for SuperPlane-hosted OpenRouter. Production and other developers leave these empty.
func LoadDevHostedOpenRouterConfig ¶
func LoadDevHostedOpenRouterConfig() (DevHostedOpenRouterConfig, error)
LoadDevHostedOpenRouterConfig reads the local OpenRouter seed. It is a no-op unless APP_ENV is development and SUPERPLANE_DEV_HOSTED_OPENROUTER is yes. A half-filled flag returns an error.
func (DevHostedOpenRouterConfig) Enabled ¶
func (c DevHostedOpenRouterConfig) Enabled() bool
Enabled reports whether the local seed has every required value.
type GitHubHostedAppConfig ¶
type GitHubHostedAppConfig struct {
ID int64
Slug string
PrivateKey string
WebhookSecret string
ClientID string
ClientSecret string
}
GitHubHostedAppConfig is SuperPlane Cloud's public GitHub App. The process holds the credentials. New connections store only the GitHub installation id. ClientID and ClientSecret are the app's user-login credentials. Cloud keeps those in GITHUB_CLIENT_ID and GITHUB_CLIENT_SECRET. A self-hosted installation does not store this pair.
func LoadGitHubHostedAppConfig ¶
func LoadGitHubHostedAppConfig() GitHubHostedAppConfig
LoadGitHubHostedAppConfig reads the public GitHub App from the process environment. Self-hosted leaves these empty. Enabled() is false unless every required value is set.
func (GitHubHostedAppConfig) Enabled ¶
func (c GitHubHostedAppConfig) Enabled() bool
Enabled reports whether Cloud holds a complete public GitHub App.
type JiraHostedOAuthConfig ¶
JiraHostedOAuthConfig is SuperPlane's Atlassian OAuth 2.0 (3LO) app. The process holds the credentials. New connections store only tokens.
func LoadJiraHostedOAuthConfig ¶
func LoadJiraHostedOAuthConfig() JiraHostedOAuthConfig
LoadJiraHostedOAuthConfig reads the public Jira OAuth app from the process environment. Self-hosted leaves these empty. Enabled() is false unless both values are set.
func (JiraHostedOAuthConfig) Enabled ¶
func (c JiraHostedOAuthConfig) Enabled() bool
Enabled reports whether Cloud holds a complete Jira OAuth app.
type LinearHostedOAuthConfig ¶
LinearHostedOAuthConfig is SuperPlane's public Linear OAuth application. The process holds the credentials. New connections store only tokens. WebhookSecret is the signing secret from the application's webhook settings.
func LoadLinearHostedOAuthConfig ¶
func LoadLinearHostedOAuthConfig() LinearHostedOAuthConfig
LoadLinearHostedOAuthConfig reads the public Linear OAuth app from the process environment. Enabled() is false unless both values are set.
func (LinearHostedOAuthConfig) Enabled ¶
func (c LinearHostedOAuthConfig) Enabled() bool
Enabled reports whether the process holds a complete Linear OAuth app.
type SentryHostedAppConfig ¶
type SentryHostedAppConfig struct {
Slug string
ClientID string
ClientSecret string
// APIToken is an optional owner token. When set, SuperPlane reads the
// public app and refuses a ready connection unless the webhook sends
// issue events. It is not required to install the app.
APIToken string
}
SentryHostedAppConfig is SuperPlane Cloud's public Sentry app. The process holds the credentials. New connections store only the installation UUID and tokens.
func LoadSentryHostedAppConfig ¶
func LoadSentryHostedAppConfig() SentryHostedAppConfig
LoadSentryHostedAppConfig reads the public Sentry app from the process environment. Self-hosted leaves these empty. Enabled() is false unless every required value is set.
func (SentryHostedAppConfig) Enabled ¶
func (c SentryHostedAppConfig) Enabled() bool
Enabled reports whether Cloud holds a complete public Sentry app.
Source Files