177 lines
4.0 KiB
TypeScript
177 lines
4.0 KiB
TypeScript
export interface Setting {
|
|
label: string
|
|
description?: string
|
|
placeholder?: string
|
|
cloudonly?: boolean
|
|
ee_only?: string
|
|
tooltip?: string
|
|
key: string
|
|
fieldType:
|
|
| 'text'
|
|
| 'number'
|
|
| 'boolean'
|
|
| 'password'
|
|
| 'select'
|
|
| 'textarea'
|
|
| 'seconds'
|
|
| 'email'
|
|
| 'license_key'
|
|
storage: SettingStorage
|
|
isValid?: (value: any) => boolean
|
|
}
|
|
|
|
export type SettingStorage = 'setting' | 'config'
|
|
|
|
export const settings: Record<string, Setting[]> = {
|
|
Core: [
|
|
{
|
|
label: 'Base Url',
|
|
description: 'Public base url of the instance',
|
|
key: 'base_url',
|
|
fieldType: 'text',
|
|
placeholder: 'https://windmill.com',
|
|
storage: 'setting',
|
|
isValid: (value: string | undefined) =>
|
|
value ? value?.startsWith('http') && value.includes('://') && !value?.endsWith('/') : true
|
|
},
|
|
{
|
|
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'
|
|
},
|
|
{
|
|
label: 'Retention Period in secs',
|
|
key: 'retention_period_secs',
|
|
description: 'How long to keep the jobs data in the database.',
|
|
fieldType: 'seconds',
|
|
placeholder: '60',
|
|
storage: 'setting',
|
|
cloudonly: false
|
|
},
|
|
{
|
|
label: 'Max Timeout for sync endpoints',
|
|
key: 'timeout_wait_result',
|
|
cloudonly: true,
|
|
fieldType: 'seconds',
|
|
placeholder: '60',
|
|
storage: 'config'
|
|
},
|
|
{
|
|
label: 'License Key',
|
|
description: 'License Key required to use the EE (switch image for windmill-ee)',
|
|
key: 'license_key',
|
|
fieldType: 'license_key',
|
|
placeholder: 'only needed to prepare upgrade to EE',
|
|
storage: 'setting'
|
|
},
|
|
{
|
|
label: 'Pip Extra Index Url',
|
|
description: 'Add private PIP registry',
|
|
key: 'pip_extra_index_url',
|
|
fieldType: 'text',
|
|
placeholder: 'https://username:password@pypi.company.com/simple',
|
|
storage: 'setting',
|
|
ee_only:
|
|
'You can still set this setting by using PIP_EXTRA_INDEX_URL as env variable to the worker containers'
|
|
},
|
|
{
|
|
label: 'Npm Config Registry',
|
|
description: 'Add private NPM registry',
|
|
key: 'npm_config_registry',
|
|
fieldType: 'text',
|
|
placeholder: 'https://yourregistry',
|
|
storage: 'setting',
|
|
ee_only:
|
|
'You can still set this setting by using NPM_CONFIG_REGISTRY as env variable to the worker containers'
|
|
},
|
|
{
|
|
label: 'Expose metrics',
|
|
description: 'Expose prometheus metrics for workers and servers on port 8001 at /metrics',
|
|
key: 'expose_metrics',
|
|
fieldType: 'boolean',
|
|
storage: 'setting',
|
|
ee_only: 'No workaround around this'
|
|
}
|
|
],
|
|
SMTP: [
|
|
{
|
|
label: 'Host',
|
|
key: 'smtp_host',
|
|
fieldType: 'text',
|
|
placeholder: 'smtp.gmail.com',
|
|
storage: 'config'
|
|
},
|
|
{
|
|
label: 'Port',
|
|
key: 'smtp_port',
|
|
fieldType: 'number',
|
|
placeholder: '587',
|
|
storage: 'config'
|
|
},
|
|
{
|
|
label: 'Username',
|
|
key: 'smtp_username',
|
|
fieldType: 'text',
|
|
placeholder: 'ruben@windmill.dev',
|
|
storage: 'config'
|
|
},
|
|
{
|
|
label: 'Password',
|
|
key: 'smtp_password',
|
|
fieldType: 'password',
|
|
storage: 'config'
|
|
},
|
|
{
|
|
label: 'From Address',
|
|
key: 'smtp_from',
|
|
placeholder: 'noreply@windmill.dev',
|
|
fieldType: 'email',
|
|
storage: 'config'
|
|
},
|
|
{
|
|
label: 'Implicit TLS',
|
|
key: 'smtp_tls_implicit',
|
|
fieldType: 'boolean',
|
|
storage: 'config'
|
|
}
|
|
],
|
|
'SSO/OAuth': [
|
|
{
|
|
label: 'Require users to have been added manually to windmill to sign in through OAuth',
|
|
key: 'require_preexisting_user_for_oauth',
|
|
fieldType: 'boolean',
|
|
storage: 'setting'
|
|
}
|
|
],
|
|
Debug: [
|
|
{
|
|
label: 'Keep Job Directories',
|
|
key: 'keep_job_dir',
|
|
fieldType: 'boolean',
|
|
tooltip: 'Keep Job directories after execution at /tmp/windmill/<worker>/<job_id>',
|
|
storage: 'setting'
|
|
},
|
|
{
|
|
label: 'Expose Debug Metrics',
|
|
key: 'expose_debug_metrics',
|
|
fieldType: 'boolean',
|
|
tooltip: 'Expose additional metrics (require metrics to be enabled)',
|
|
storage: 'setting'
|
|
}
|
|
],
|
|
Telemetry: [
|
|
{
|
|
label: 'Disable telemetry',
|
|
key: 'disable_stats',
|
|
fieldType: 'boolean',
|
|
storage: 'setting'
|
|
}
|
|
]
|
|
}
|
|
|
|
export const settingsKeys = Object.keys(settings)
|