Files
windmill/frontend/src/lib/components/instanceSettings.ts
T
Ruben Fiszel 4cf53a44bb feat: add auto-login SSO provider instance setting (#8929)
* [ee] feat: add auto-login SSO provider instance setting

Adds an instance-level `auto_login_provider` setting that, when set to
an OAuth provider key (e.g. "okta") or "saml", causes the login page
to auto-redirect users to the configured SSO flow on mount.

Useful for orgs with a single SSO where the provider button grid adds
a pointless extra click.

- Backend: new global setting constant, read from DB in list_logins
  handler and returned as the `auto_login` field in the response
- Frontend: Login.svelte auto-redirects in loadLogins() when the
  configured provider is actually present in the response
- Escape hatch: `?no_sso=1` skips the auto-redirect and shows the
  normal login form (admin fallback when SSO is broken)
- No redirect loop: if the `error` prop is set (SSO callback failed),
  the redirect is skipped
- Admin UI: new text field under Auth/OAuth/SAML in instance settings

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* fix: skip auto-redirect on /user/login page

Auto-redirect should only fire on embeds where the user did not
explicitly navigate to a login screen (public app popup, approval
pages). Visiting /user/login is an explicit sign-in action — often by
an admin who needs password fallback — so we must never hijack it.

Gate the logic on a new `autoRedirect` prop (default true). The main
login page passes `autoRedirect={false}`.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* chore: update ee-repo-ref to b7157d55fb9f8d8f7aeb7b1fb69bc935af895a2f

This commit updates the EE repository reference after PR #547 was merged in windmill-ee-private.

Previous ee-repo-ref: e32a48499d206a24e0c12817b465775321b0ee41

New ee-repo-ref: b7157d55fb9f8d8f7aeb7b1fb69bc935af895a2f

Automated by sync-ee-ref workflow.

* fix: handle popup-blocked auto-redirect in popup mode

When Login is embedded with popup=true (public app), auto-redirect
funnels through window.open() without a user gesture — browsers block
it by default, leaving the user stuck on "Signing you in…".

Detect window.open returning null, clean up listeners, reset
autoRedirecting so the provider button grid re-renders, and surface a
toast pointing users at the manual button. The grid click retains its
user gesture and passes the popup blocker.

Also extracts a redirectSaml() helper so the SAML auto-redirect path
and the SSO button click share the same logic.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-authored-by: windmill-internal-app[bot] <windmill-internal-app[bot]@users.noreply.github.com>
2026-04-24 04:20:01 +00:00

1080 lines
30 KiB
TypeScript

import type { ButtonType } from './common/button/model'
import { z } from 'zod'
// Languages that support HTTP request tracing via OTEL proxy
export const OTEL_TRACING_PROXY_LANGUAGES = [
'nativets',
'python3',
'deno',
'bun',
'go',
'bash',
'rust',
'csharp',
'nu',
'ruby'
] as const
export interface Setting {
label: string
description?: string
placeholder?: string
cloudonly?: boolean
ee_only?: string
tooltip?: string
key: string
// If value is not specified for first element, it will automatcally use undefined
select_items?: {
label: string
tooltip?: string
// If not specified, label will be used
value?: string
}[]
fieldType:
| 'text'
| 'number'
| 'boolean'
| 'password'
| 'select'
| 'select_python'
| 'textarea'
| 'codearea'
| 'seconds'
| 'email'
| 'license_key'
| 'object_store_config'
| 'critical_error_channels'
| 'critical_alerts_on_db_oversize'
| 'slack_connect'
| 'smtp_connect'
| 'indexer_rates'
| 'otel'
| 'otel_tracing_proxy'
| 'secret_backend'
| 'github_enterprise_app'
| 'ws_connectivity'
storage: SettingStorage
advancedToggle?: {
label: string
onChange: (values: Record<string, any>) => Record<string, any>
checked: (values: Record<string, any>) => boolean
}
hiddenIfNull?: boolean
hiddenIfEmpty?: boolean
hiddenInEe?: boolean
hideInQuickSetup?: boolean
requiresReloadOnChange?: boolean
triggersRestart?: boolean
isValid?: (value: any) => boolean
validate?: (value: any) => Record<string, string>
error?: string
defaultValue?: () => any
codeAreaLang?: string
actionButton?: {
label: string
onclick: (values: Record<string, any>) => Promise<void>
variant?: ButtonType.Variant
}
}
export type SettingStorage = 'setting'
const positiveNumber = z.number().positive('Must be a positive number')
const nonNegativeNumber = z.number().nonnegative('Must be zero or a positive number')
const indexerSettingsSchema = z
.object({
writer_memory_budget: positiveNumber.optional(),
commit_job_max_batch_size: positiveNumber.optional(),
refresh_index_period: positiveNumber.optional(),
max_indexed_job_log_size: positiveNumber.optional(),
commit_log_max_batch_size: positiveNumber.optional(),
refresh_log_index_period: positiveNumber.optional(),
max_index_time_window_secs: nonNegativeNumber.optional()
})
.passthrough()
function validateIndexerSettings(v: any): Record<string, string> {
if (!v) return {}
const result = indexerSettingsSchema.safeParse(v)
if (result.success) return {}
const errors: Record<string, string> = {}
for (const issue of result.error.issues) {
const field = issue.path[0]?.toString()
if (field) errors[field] = issue.message
}
return errors
}
export const scimSamlSetting: Setting[] = [
{
label: 'SCIM token',
description: 'Token used to authenticate requests from the IdP',
key: 'scim_token',
fieldType: 'password',
placeholder: 'mytoken',
storage: 'setting',
ee_only: ''
},
{
label: 'SAML metadata',
description: 'XML metadata url OR content for the SAML IdP',
key: 'saml_metadata',
fieldType: 'textarea',
placeholder: 'https://dev-2578259.okta.com/app/exkaell8gidiiUWrg5d7/sso/saml/metadata ',
storage: 'setting',
ee_only: '',
triggersRestart: true
}
]
export const settings: Record<string, Setting[]> = {
Core: [
{
label: 'Base url',
description:
'Public base url of the instance. <a href="https://www.windmill.dev/docs/advanced/instance_settings#global-users">Learn more</a>',
key: 'base_url',
fieldType: 'text',
placeholder: 'https://windmill.com',
storage: 'setting',
error: 'Base url must start with http:// or https:// and not end with / or a space',
isValid: (value: string | undefined) =>
value == undefined ||
(value?.startsWith('http') &&
value.includes('://') &&
!value?.endsWith('/') &&
!value?.endsWith(' '))
},
{
label: 'Email domain',
description: 'Domain to display in webhooks for email triggers (should match the MX record)',
key: 'email_domain',
fieldType: 'text',
placeholder: 'mail.windmill.com',
storage: 'setting',
triggersRestart: true,
error: 'Must be a valid domain',
isValid: (value: string | undefined) =>
value == undefined ||
value === '' ||
/^[a-zA-Z0-9]([a-zA-Z0-9-]*[a-zA-Z0-9])?(\.[a-zA-Z0-9]([a-zA-Z0-9-]*[a-zA-Z0-9])?)*$/.test(
value
)
},
{
label: 'Request size limit in MB',
description: 'Maximum size of HTTP requests in MB.',
cloudonly: true,
key: 'request_size_limit_mb',
fieldType: 'number',
placeholder: '50',
storage: 'setting',
triggersRestart: true
},
{
label: 'License key',
description:
'License key required to use the EE (switch image for windmill-ee). <a href="https://www.windmill.dev/docs/advanced/instance_settings#license-key">Learn more</a>',
key: 'license_key',
fieldType: 'license_key',
placeholder: 'only for EE',
storage: 'setting'
},
{
label: 'Non-prod instance',
description:
'Whether we should consider the reported usage of this instance as non-prod. <a href="https://www.windmill.dev/docs/advanced/instance_settings#non-prod-instance">Learn more</a>',
key: 'dev_instance',
fieldType: 'boolean',
storage: 'setting',
ee_only: '',
hideInQuickSetup: true
},
{
label: 'App workspace prefix',
description:
'When enabled apps will be accessible at /a/{workspace_id}/{custom_path} instead of /a/{custom_path} allowing you to define same custom path for apps in different workspace without conflict',
key: 'app_workspaced_route',
fieldType: 'boolean',
storage: 'setting',
ee_only: '',
hideInQuickSetup: true
},
{
label: 'HTTP route workspace prefix',
description:
'When enabled HTTP routes will be accessible at /api/r/{workspace_id}/{route} instead of /api/r/{route} allowing you to define same route path in different workspaces without conflict',
key: 'http_route_workspaced_route',
fieldType: 'boolean',
storage: 'setting',
ee_only: '',
hideInQuickSetup: true
},
{
label: 'Audit log retention (days)',
key: 'audit_log_retention_days',
description: 'How long to keep audit log entries in the database. Default: 365 days.',
fieldType: 'number',
placeholder: '365',
storage: 'setting',
ee_only: '',
hideInQuickSetup: true
}
],
Jobs: [
{
label: 'Job isolation',
key: 'job_isolation',
fieldType: 'select',
description:
'Isolation mode for job execution. None: no isolation. Unshare: PID namespace isolation via unshare. Nsjail: full nsjail sandboxing. <a href="https://www.windmill.dev/docs/advanced/security_isolation">Learn more</a>',
storage: 'setting',
select_items: [
{
label: 'None',
value: 'none'
},
{
label: 'Unshare',
value: 'unshare'
},
{
label: 'Nsjail',
value: 'nsjail_sandboxing'
}
]
},
{
label: 'Default timeout',
key: 'job_default_timeout',
description:
'Default timeout for individual jobs. <a href="https://www.windmill.dev/docs/core_concepts/jobs#retention-policy">Learn more</a>',
fieldType: 'seconds',
storage: 'setting',
cloudonly: false
},
{
label: 'Max timeout for sync endpoints',
description:
'Maximum amount of time (measured in seconds) that a <a href="https://www.windmill.dev/docs/core_concepts/webhooks">sync endpoint</a> is allowed to run before it is forcibly stopped or timed out.',
key: 'timeout_wait_result',
fieldType: 'seconds',
placeholder: '60',
storage: 'setting'
},
{
label: 'Keep job directories for debug',
key: 'keep_job_dir',
fieldType: 'boolean',
description: 'Keep Job directories after execution at /tmp/windmill/WORKER/JOB_ID',
storage: 'setting'
},
{
label: 'Retention period in secs',
key: 'retention_period_secs',
description:
'How long to keep the jobs data in the database (max 30 days on CE). <a href="https://www.windmill.dev/docs/advanced/instance_settings#retention-period-in-secs">Learn more</a>',
fieldType: 'seconds',
placeholder: '30',
storage: 'setting',
ee_only: 'You can only adjust this setting to above 30 days in the EE version',
cloudonly: false
}
],
'Object Storage': [
{
label: 'Instance object storage',
description:
' S3/Azure bucket to store large logs and global cache for Python and Go. <a href="https://www.windmill.dev/docs/core_concepts/object_storage_in_windmill#instance-object-storage">Learn more</a>',
key: 'object_store_cache_config',
fieldType: 'object_store_config',
storage: 'setting',
ee_only: '',
isValid: (v) => {
if (!v || v.type !== 'Gcs') return true
return v.serviceAccountKey !== undefined
}
},
{
label: 'Delete logs from s3 periodically',
description:
'Job and service logs are periodically deleted from disk when they expire. When this setting is on, they are also deleted from object storage. Defaults to on when object storage is configured; turn off to keep logs in object storage indefinitely.',
key: 'monitor_logs_on_s3',
fieldType: 'boolean',
storage: 'setting',
ee_only: ''
}
],
'Private Hub': [
{
label: 'Private Hub base url',
description:
'Base URL of your Private Hub instance, without trailing slash. <a href="https://www.windmill.dev/docs/core_concepts/private_hub">Learn more</a>',
placeholder: 'https://hub.company.com',
key: 'hub_base_url',
fieldType: 'text',
storage: 'setting',
ee_only: '',
advancedToggle: {
label: 'I have a different URL for Hub access from end-user browsers',
onChange(values) {
if (values['hub_accessible_url']) {
values['hub_accessible_url'] = null
} else {
values['hub_accessible_url'] = values['hub_base_url'] || 'https://hub.company.com'
}
return values
},
checked: (values) => values['hub_accessible_url'] != null
},
requiresReloadOnChange: true
},
{
label: 'Private Hub accessible url',
description:
'Base URL accessible from end-user browsers, without trailing slash. <a href="https://www.windmill.dev/docs/core_concepts/private_hub">Learn more</a>',
key: 'hub_accessible_url',
fieldType: 'text',
hiddenIfNull: true,
storage: 'setting',
ee_only: '',
requiresReloadOnChange: true
},
{
label: 'Private Hub API secret',
description:
'If access to your Private Hub is restricted, you can set the hub API secret here. <a href="https://www.windmill.dev/docs/core_concepts/private_hub">Learn more</a>',
key: 'hub_api_secret',
fieldType: 'password',
storage: 'setting',
ee_only: ''
},
{
label: 'Azure OpenAI base path',
description:
'All workspaces using an OpenAI resource for Windmill AI will run on the specified deployed model. Format: https://{your-resource-name}.openai.azure.com/openai/deployments/{deployment-id}. <a href="https://www.windmill.dev/docs/core_concepts/ai_generation#azure-openai-advanced-models">Learn more</a>',
key: 'openai_azure_base_path',
fieldType: 'text',
storage: 'setting',
ee_only: '',
hiddenIfEmpty: true
},
{
label: 'Disable Hub',
description:
'Disable the Windmill Hub integration entirely. Enable this if your instance runs in a closed environment without internet access and you do not have a private hub setup.',
key: 'disable_hub',
fieldType: 'boolean',
storage: 'setting',
ee_only: '',
requiresReloadOnChange: true
}
],
SMTP: [
{
label: 'SMTP configuration',
key: 'smtp_settings',
fieldType: 'smtp_connect',
storage: 'setting',
ee_only: ''
}
],
'Auth/OAuth/SAML': [
{
label: 'Disable password login',
description:
'Hide the email/password form on the login page and reject password login requests. Use when you only want OAuth/SAML logins.',
key: 'disable_password_login',
fieldType: 'boolean',
storage: 'setting'
},
{
label: 'Auto-login SSO provider',
description:
'If set, the login page redirects automatically to this provider. Use the OAuth provider key (e.g. "okta", "google") or "saml". The provider must be configured; otherwise the setting is ignored. Visit /user/login?no_sso=1 to bypass the redirect and fall back to the normal login form.',
key: 'auto_login_provider',
fieldType: 'text',
placeholder: 'okta',
storage: 'setting'
}
],
'DB Health': [],
Registries: [
{
label: 'Instance Python Version',
description: 'Default python version for newly deployed scripts',
key: 'instance_python_version',
fieldType: 'select_python',
// To change latest stable version:
// 1. Change placeholder in instanceSettings.ts
// 2. Change LATEST_STABLE_PY in dockerfile
// 3. Change #[default] annotation for PyVersion in backend
placeholder: '3.10,3.11,3.12,3.13',
select_items: [
{
label: 'Latest Stable',
value: 'default',
tooltip: 'python-3.12'
},
{
label: '3.10'
},
{
label: '3.11'
},
{
label: '3.12'
},
{
label: '3.13'
}
],
storage: 'setting'
},
{
label: 'UV index url',
description: 'Add private Pip registry',
key: 'pip_index_url',
fieldType: 'password',
placeholder: 'https://username:password@pypi.company.com/simple',
storage: 'setting',
ee_only: ''
},
{
label: 'UV extra index url',
description: 'Add private extra Pip registry',
key: 'pip_extra_index_url',
fieldType: 'password',
placeholder: 'https://username:password@pypi.company.com/simple',
storage: 'setting',
ee_only: ''
},
{
label: 'UV index strategy',
description:
'Strategy for resolving packages from multiple indexes. See <a href="https://docs.astral.sh/uv/pip/compatibility/#packages-that-exist-on-multiple-indexes">uv docs</a>',
key: 'uv_index_strategy',
fieldType: 'select',
placeholder: 'unsafe-best-match',
defaultValue: () => 'unsafe-best-match',
select_items: [
{
label: 'first-index',
tooltip: 'Only use the first index that contains the package'
},
{
label: 'unsafe-first-match',
tooltip: 'Search for packages across all indexes, preferring the first match'
},
{
label: 'unsafe-best-match (default)',
value: 'unsafe-best-match',
tooltip: 'Search for packages across all indexes, preferring the best match'
}
],
storage: 'setting',
ee_only: ''
},
{
label: 'NPM Registry Configuration (.npmrc)',
description:
'Full .npmrc file content for private npm registries. Used by Bun, Deno, and the npm proxy. Takes precedence over the legacy fields below.',
key: 'npmrc',
fieldType: 'codearea',
codeAreaLang: 'ini',
placeholder:
'registry=https://registry.mycompany.com/\n//registry.mycompany.com/:_authToken=YOUR_TOKEN\n\n@myorg:registry=https://registry.myorg.com/\n//registry.myorg.com/:_authToken=SCOPED_TOKEN',
storage: 'setting',
ee_only: ''
},
{
label: 'Npm config registry (legacy)',
description: 'Add private npm registry. Prefer using the .npmrc field above.',
key: 'npm_config_registry',
fieldType: 'password',
placeholder: 'https://registry.npmjs.org/:_authToken=npm_FOOBAR',
storage: 'setting',
ee_only: '',
hiddenIfEmpty: true
},
{
label: 'Bunfig install scopes (legacy)',
description:
'Add private scoped registries for Bun. Prefer using the .npmrc field above. See: https://bun.sh/docs/install/registries',
key: 'bunfig_install_scopes',
fieldType: 'password',
placeholder: '"@myorg3" = { token = "mytoken", url = "https://registry.myorg.com/" }',
storage: 'setting',
ee_only: '',
hiddenIfEmpty: true
},
{
label: 'Nuget Config',
description:
'Write a nuget.config file to set custom package sources and credentials. Use <clear /> inside <packageSources> to remove default sources and only use your custom ones',
key: 'nuget_config',
fieldType: 'codearea',
codeAreaLang: 'xml',
storage: 'setting',
ee_only: ''
},
{
label: 'Maven/Ivy repositories',
description: 'Add private Maven/Ivy repositories',
key: 'maven_repos',
fieldType: 'password',
placeholder: 'https://user:password@artifacts.foo.com/maven',
storage: 'setting',
ee_only: ''
},
{
label: 'Maven settings.xml',
description:
'Write a Maven settings.xml file for custom repositories, mirrors, and credentials',
key: 'maven_settings_xml',
fieldType: 'codearea',
codeAreaLang: 'xml',
storage: 'setting',
ee_only: ''
},
{
label: 'Disable default Maven repository',
description: 'Do not use default Maven repository',
key: 'no_default_maven',
fieldType: 'boolean',
storage: 'setting',
ee_only: ''
},
{
label: 'Ruby Gems repositories',
description: 'Add private Ruby repositories with credentials. Should end with /',
key: 'ruby_repos',
fieldType: 'password',
placeholder: 'https://user:password@gems.foo.com/',
storage: 'setting',
ee_only: ''
},
{
label: 'Cargo registries',
description: 'Write a .cargo/config.toml to set custom Cargo registries and credentials',
key: 'cargo_registries',
fieldType: 'codearea',
codeAreaLang: 'toml',
storage: 'setting',
ee_only: ''
},
{
label: 'PowerShell Repository URL',
description: 'Add private PowerShell repository URL',
key: 'powershell_repo_url',
placeholder:
'https://pkgs.dev.azure.com/<org>/<project>/_packaging/<feed>/nuget/v3/index.json',
fieldType: 'text',
storage: 'setting',
ee_only: ''
},
{
label: 'PowerShell Repository PAT',
description:
'Add private PowerShell repository Personal Access Token (optional, for authenticated repositories)',
key: 'powershell_repo_pat',
fieldType: 'password',
storage: 'setting',
ee_only: ''
}
],
Alerts: [
{
label: 'Critical alert channels',
description:
'Channels to send critical alerts to. <a href="https://www.windmill.dev/docs/core_concepts/critical_alerts">Learn more</a>',
key: 'critical_error_channels',
fieldType: 'critical_error_channels',
storage: 'setting',
ee_only: 'Channels other than tracing are only available in the EE version',
actionButton: {
label: 'Test all channels',
onclick: async (values) => {
const { SettingService } = await import('$lib/gen')
const { sendUserToast } = await import('$lib/toast')
try {
await SettingService.testCriticalChannels({
requestBody: values.critical_error_channels
})
sendUserToast('Test message sent successfully to critical channels', false)
} catch (error: any) {
sendUserToast('Failed to send test message: ' + error.message, true)
}
},
variant: 'accent'
}
},
{
label: 'Mute critical alerts in UI',
description: 'Enable to mute critical alerts in the UI',
key: 'critical_alert_mute_ui',
fieldType: 'boolean',
storage: 'setting',
requiresReloadOnChange: true,
ee_only: 'Critical alerts in UI are only available in the EE version'
},
{
label: 'Alert on token expiry',
description:
'Send critical alerts when API tokens are about to expire (within 7 days) or have expired',
key: 'critical_alerts_on_token_expiry',
fieldType: 'boolean',
storage: 'setting',
ee_only: ''
},
{
label: 'Slack',
key: 'slack',
fieldType: 'slack_connect',
storage: 'setting',
ee_only: ''
},
{
label: 'Alert on DB oversize',
key: 'critical_alerts_on_db_oversize',
description: 'Alert if DB grows more than specified size',
fieldType: 'critical_alerts_on_db_oversize',
placeholder: '100',
storage: 'setting',
ee_only: ''
}
],
Webhooks: [
{
label: 'Instance Events Webhook',
description:
'URL to receive POST requests for instance events (user added, OAuth signup, user invited/added/joined workspace).',
key: 'instance_events_webhook',
fieldType: 'text',
placeholder: 'https://example.com/webhook',
storage: 'setting'
}
],
'OTEL/Prom': [
{
label: 'OpenTelemetry',
key: 'otel',
fieldType: 'otel',
storage: 'setting',
ee_only: '',
triggersRestart: true
},
{
label: 'HTTP Request Tracing',
description:
'Capture HTTP/HTTPS requests from job scripts as OpenTelemetry spans. Visible in job details and exported to your OTEL collector if configured. Toggling restarts workers.',
key: 'otel_tracing_proxy',
fieldType: 'otel_tracing_proxy',
storage: 'setting',
ee_only: 'HTTP Request Tracing is an EE feature',
triggersRestart: true,
defaultValue: () => ({ enabled: false, enabled_languages: [...OTEL_TRACING_PROXY_LANGUAGES] })
},
{
label: 'Prometheus',
description:
'Expose Prometheus metrics for workers and servers on port 8001 at /metrics. <a target="_blank" href="https://www.windmill.dev/docs/advanced/instance_settings#expose-metrics">Learn more</a>',
key: 'expose_metrics',
fieldType: 'boolean',
storage: 'setting',
ee_only: '',
triggersRestart: true
}
],
Indexer: [
{
label: '',
key: 'indexer_settings',
fieldType: 'indexer_rates',
storage: 'setting',
validate: validateIndexerSettings
}
],
Telemetry: [
{
label: 'Minimal telemetry',
key: 'disable_stats',
fieldType: 'boolean',
storage: 'setting'
}
],
'Secret Storage': [
{
label: 'Backend type',
description:
'By default, secrets are encrypted and stored in the database. Enterprise Edition supports HashiCorp Vault, Azure Key Vault, and AWS Secrets Manager as external secret backends.',
key: 'secret_backend',
fieldType: 'secret_backend',
storage: 'setting',
ee_only:
'HashiCorp Vault, Azure Key Vault, and AWS Secrets Manager integrations are Enterprise Edition features'
}
],
'GitHub App': [
{
label: 'GitHub App',
description:
'Configure a self-managed GitHub App to enable git sync without stats.windmill.dev.',
key: 'github_enterprise_app',
fieldType: 'github_enterprise_app',
storage: 'setting',
ee_only: '',
error:
'When self-managed mode is enabled, Base URL, App ID, App Slug, Client ID, and Private Key are required.',
isValid: (v: any) => {
if (!v?.self_managed) return true
return !!(v?.base_url && v?.app_id && v?.app_slug && v?.client_id && v?.private_key)
}
}
],
WebSocket: [
{
label: 'WebSocket connectivity',
description:
'Test connectivity to multiplayer, LSP, and debugger WebSocket services. Enable custom URL override for deployments where WebSocket traffic routes to a different host.',
key: 'ws_base_url',
fieldType: 'ws_connectivity',
storage: 'setting',
requiresReloadOnChange: true,
isValid: (value: string | undefined) =>
!value ||
(value.startsWith('ws') &&
value.includes('://') &&
!value.endsWith('/') &&
!value.endsWith(' '))
}
],
LSP: [
{
label: 'Ruff config (ruff.toml)',
description:
'Shared ruff.toml applied to the Python editor linter across the whole instance. The LSP container fetches this every minute and writes it next to edited files. See <a href="https://docs.astral.sh/ruff/configuration/">ruff docs</a>',
key: 'ruff_config',
fieldType: 'codearea',
codeAreaLang: 'toml',
placeholder: 'line-length = 100\n\n[lint]\nselect = ["E", "F", "I"]\nignore = ["E501"]',
storage: 'setting'
}
]
}
export const settingsKeys = Object.keys(settings)
// --- Sidebar navigation for instance settings ---
export const instanceSettingsNavigationGroups = [
{
title: 'Core',
items: [
{
id: 'users',
label: 'Users',
aiId: 'instance-settings-users',
aiDescription: 'Instance users settings'
},
{
id: 'general',
label: 'General',
aiId: 'instance-settings-general',
aiDescription: 'Instance general settings'
},
{
id: 'jobs',
label: 'Jobs',
aiId: 'instance-settings-jobs',
aiDescription: 'Instance jobs settings'
}
]
},
{
title: 'Authentication',
items: [
{
id: 'sso',
label: 'SSO',
aiId: 'instance-settings-sso',
aiDescription: 'Instance SSO settings'
},
{
id: 'oauth',
label: 'OAuth',
aiId: 'instance-settings-oauth',
aiDescription: 'Instance OAuth settings'
},
{
id: 'scim_saml',
label: 'SCIM/SAML',
aiId: 'instance-settings-scim-saml',
aiDescription: 'Instance SCIM/SAML settings',
isEE: true
}
]
},
{
title: 'Infrastructure',
items: [
{
id: 'smtp',
label: 'SMTP',
aiId: 'instance-settings-smtp',
aiDescription: 'Instance SMTP settings'
},
{
id: 'registries',
label: 'Registries',
aiId: 'instance-settings-registries',
aiDescription: 'Instance registries settings'
},
{
id: 'object_storage',
label: 'Object Storage',
aiId: 'instance-settings-object-storage',
aiDescription: 'Instance object storage settings',
isEE: true
}
]
},
{
title: 'Monitoring',
items: [
{
id: 'alerts',
label: 'Alerts',
aiId: 'instance-settings-alerts',
aiDescription: 'Instance alerts settings',
isEE: true
},
{
id: 'webhooks',
label: 'Webhooks',
aiId: 'instance-settings-webhooks',
aiDescription: 'Instance events webhook settings'
},
{
id: 'otel_prom',
label: 'OTEL/Prometheus',
aiId: 'instance-settings-otel-prom',
aiDescription: 'Instance OTEL/Prometheus settings',
isEE: true
},
{
id: 'indexer',
label: 'Indexer',
aiId: 'instance-settings-indexer',
aiDescription: 'Instance indexer settings',
isEE: true
},
{
id: 'db_health',
label: 'DB Health',
aiId: 'instance-settings-db-health',
aiDescription: 'Database health diagnostics and performance insights'
}
]
},
{
title: 'AI',
items: [
{
id: 'ai',
label: 'AI',
aiId: 'instance-settings-ai',
aiDescription: 'Instance AI settings (providers, models, prompts)'
}
]
},
{
title: 'Advanced',
items: [
{
id: 'github_enterprise_app',
label: 'GitHub App',
aiId: 'instance-settings-github-enterprise-app',
aiDescription: 'Self-managed GitHub App for git sync',
isEE: true
},
{
id: 'private_hub',
label: 'Private Hub',
aiId: 'instance-settings-private-hub',
aiDescription: 'Instance private hub settings',
isEE: true
},
{
id: 'telemetry',
label: 'Telemetry',
aiId: 'instance-settings-telemetry',
aiDescription: 'Instance telemetry settings'
},
{
id: 'secret_storage',
label: 'Secret Storage',
aiId: 'instance-settings-secret-storage',
aiDescription: 'Instance secret storage settings'
},
{
id: 'websocket',
label: 'WebSocket',
aiId: 'instance-settings-websocket',
aiDescription: 'WebSocket connectivity test and URL override'
},
{
id: 'lsp',
label: 'LSP',
aiId: 'instance-settings-lsp',
aiDescription: 'Language server protocol settings (ruff config, editor linting)'
}
]
}
]
export const tabToCategoryMap: Record<string, string> = {
general: 'Core',
ai: 'AI',
sso: 'Auth/OAuth/SAML',
oauth: 'Auth/OAuth/SAML',
scim_saml: 'Auth/OAuth/SAML',
smtp: 'SMTP',
registries: 'Registries',
alerts: 'Alerts',
webhooks: 'Webhooks',
otel_prom: 'OTEL/Prom',
indexer: 'Indexer',
telemetry: 'Telemetry',
secret_storage: 'Secret Storage',
object_storage: 'Object Storage',
jobs: 'Jobs',
private_hub: 'Private Hub',
github_enterprise_app: 'GitHub App',
websocket: 'WebSocket',
db_health: 'DB Health',
lsp: 'LSP'
}
export const tabToAuthSubTab: Record<string, 'sso' | 'oauth' | 'scim'> = {
sso: 'sso',
oauth: 'oauth',
scim_saml: 'scim'
}
// Navigation groups for the initial setup flow (no Users tab)
export const setupNavigationGroups = instanceSettingsNavigationGroups
.map((group) => ({
...group,
items: group.items.filter((item) => item.id !== 'users')
}))
.filter((group) => group.items.length > 0)
export const categoryToTabMap: Record<string, string> = {
Core: 'general',
AI: 'ai',
SMTP: 'smtp',
'Auth/OAuth/SAML': 'sso',
Registries: 'registries',
Alerts: 'alerts',
Webhooks: 'webhooks',
'OTEL/Prom': 'otel_prom',
Indexer: 'indexer',
Telemetry: 'telemetry',
'Secret Storage': 'secret_storage',
'Object Storage': 'object_storage',
Jobs: 'jobs',
'Private Hub': 'private_hub',
'GitHub App': 'github_enterprise_app',
WebSocket: 'websocket',
'DB Health': 'db_health',
LSP: 'lsp'
}
export interface SearchableSettingItem {
label: string
tabId: string
settingKey?: string
category: string
/** Full description text (HTML stripped), used for search matching only — not displayed */
description?: string
}
/**
* Extract the label portion from a uFuzzy marked/highlighted string.
* Only allows `<mark>` and `</mark>` tags through (sanitizes everything else).
*/
export function extractMarkedLabel(marked: string | undefined, labelLength: number): string {
if (!marked) return ''
let plainIdx = 0
let markedIdx = 0
while (plainIdx < labelLength && markedIdx < marked.length) {
if (marked[markedIdx] === '<') {
while (markedIdx < marked.length && marked[markedIdx] !== '>') markedIdx++
markedIdx++
} else {
plainIdx++
markedIdx++
}
}
// Include any closing </mark> right after
if (marked.startsWith('</mark>', markedIdx)) {
markedIdx += '</mark>'.length
}
// Sanitize: only allow <mark> and </mark> tags from uFuzzy highlight
return marked.slice(0, markedIdx).replace(/<(?!\/?mark>)[^>]*>/g, '')
}
export function buildSearchableSettingItems(
navigationGroups: typeof instanceSettingsNavigationGroups = instanceSettingsNavigationGroups
): SearchableSettingItem[] {
const items: SearchableSettingItem[] = []
// Add sidebar navigation items (tab-level)
for (const group of navigationGroups) {
for (const navItem of group.items) {
items.push({
label: navItem.label,
tabId: navItem.id,
category: group.title
})
}
}
// Add individual settings from each category
for (const [category, categorySettings] of Object.entries(settings)) {
const tabId = categoryToTabMap[category]
if (!tabId) continue
for (const setting of categorySettings) {
if (!setting.label) continue
items.push({
label: setting.label,
tabId,
settingKey: setting.key,
category,
description: setting.description?.replace(/<[^>]*>/g, '') ?? ''
})
}
}
// Add SCIM/SAML settings
for (const setting of scimSamlSetting) {
if (!setting.label) continue
items.push({
label: setting.label,
tabId: 'scim_saml',
settingKey: setting.key,
category: 'SCIM/SAML',
description: setting.description?.replace(/<[^>]*>/g, '') ?? ''
})
}
return items
}
/** Registry settings that support per-workspace overrides. Excludes instance_python_version and uv_index_strategy which are instance-wide only. */
export const WORKSPACE_REGISTRY_SETTINGS: Setting[] = settings['Registries'].filter(
(s) => s.key !== 'instance_python_version' && s.key !== 'uv_index_strategy'
)