Files

114 lines
8.3 KiB
JSON

{
"builtinMetadata": {
"configDescriptions": {
"openresty_trusted_proxy_cidrs": "Trusted proxy IPv4/IPv6 CIDRs (JSON array)",
"metric_retention_days": "Retention period for CPU, memory, disk and network metrics (days, shared across all log databases)",
"log_retention_days_sqlite": "SQLite log retention period (days)",
"log_retention_days_clickhouse": "ClickHouse log retention period (days)",
"log_retention_days_postgres": "PostgreSQL retention period for access logs and observability data (days)",
"sw_offline_domains": "Domains using the Service Worker offline fallback (JSON array; no domains means the fallback is inactive)",
"sw_offline_enabled": "Enable the Service Worker offline fallback",
"sw_offline_html": "Custom HTML for the offline contact page; leave empty to use the built-in template",
"origin_error_page_get_only": "Show the origin error page only for GET requests; pass other methods through",
"origin_error_page_enabled": "Enable the origin error page",
"origin_error_page_status_codes": "Status code tags that trigger the origin error page (JSON array)",
"origin_error_page_html": "Custom HTML for the origin error page; leave empty to use the built-in template",
"openresty_default_limit_req_per_ip": "Default request rate limit per IP; leave empty to disable (for example, 10r/s or 100r/m)",
"openresty_default_limit_conn_per_server": "Default concurrent connection limit per site; 0 disables the limit",
"openresty_default_limit_conn_per_ip": "Default concurrent connection limit per IP; 0 disables the limit",
"openresty_default_limit_rate": "Default bandwidth limit per request; leave empty to disable",
"pages_max_history_count": "Maximum historical deployments retained per Pages project; 0 means unlimited",
"pages_max_package_size_mb": "Maximum Pages deployment package upload size (MiB)",
"openresty_keepalive_requests": "Maximum requests per keepalive connection",
"openresty_client_header_timeout": "Client request header timeout (seconds)",
"openresty_client_body_timeout": "Client request body timeout (seconds)",
"openresty_client_max_body_size": "Maximum client request body size",
"openresty_large_client_header_buffers": "Buffers for large client request headers",
"openresty_send_timeout": "Response send timeout (seconds)",
"openresty_proxy_connect_timeout": "Upstream connection timeout (seconds)",
"openresty_proxy_send_timeout": "Upstream request send timeout (seconds)",
"openresty_proxy_read_timeout": "Upstream response read timeout (seconds)",
"openresty_websocket_enabled": "Enable WebSocket support",
"openresty_http3_enabled": "Enable HTTP/3 support",
"openresty_proxy_buffering_enabled": "Enable proxy response buffering",
"openresty_proxy_buffers": "Proxy response buffers",
"openresty_proxy_buffer_size": "Proxy response buffer size",
"openresty_proxy_busy_buffers_size": "Maximum size of busy proxy response buffers",
"openresty_gzip_enabled": "Enable Gzip compression",
"openresty_gzip_min_length": "Minimum response size for Gzip compression",
"openresty_gzip_comp_level": "Gzip compression level",
"openresty_cache_enabled": "Enable caching",
"openresty_cache_levels": "Cache directory levels",
"openresty_cache_inactive": "Cache inactivity timeout",
"openresty_cache_key_template": "Cache key template",
"openresty_cache_lock_enabled": "Enable cache locking",
"openresty_cache_lock_timeout": "Cache lock timeout",
"openresty_cache_use_stale": "Conditions for serving stale cached responses",
"agent_heartbeat_interval": "Agent heartbeat interval (milliseconds)",
"node_offline_threshold": "Time without a heartbeat before a node is considered offline (milliseconds)",
"openresty_cache_max_size": "Maximum cache size",
"agent_websocket_upgrade_enabled": "Enable Agent WebSocket upgrades",
"agent_update_repo": "Repository for Agent updates",
"geoip_provider": "GeoIP provider",
"uptime_kuma_enabled": "Enable Uptime Kuma integration",
"uptime_kuma_monitor_scope": "Uptime Kuma monitoring scope",
"uptime_kuma_sync_interval": "Uptime Kuma synchronization interval (minutes)",
"uptime_kuma_interval": "Uptime Kuma monitoring interval (seconds)",
"uptime_kuma_retry": "Uptime Kuma retry count",
"uptime_kuma_retry_interval": "Uptime Kuma retry interval (seconds)",
"uptime_kuma_timeout": "Uptime Kuma timeout (seconds)",
"openresty_default_server_return_status": "HTTP status code returned by the default server",
"openresty_worker_processes": "Worker process count",
"openresty_worker_connections": "Connection limit per worker",
"openresty_worker_rlimit_nofile": "Worker open file descriptor limit",
"openresty_events_use": "Event processing method",
"openresty_events_multi_accept_enabled": "Enable accepting multiple connections at once",
"openresty_keepalive_timeout": "Keepalive timeout (seconds)",
"openresty_proxy_request_buffering_enabled": "Enable proxy request buffering",
"relay_frps_web_ui_port": "Port for the built-in FRPS web administration interface",
"relay_frps_web_ui_enabled": "Enable the built-in FRPS web administration interface",
"max_api_keys_per_user": "Maximum API keys each regular user can create",
"log_db_migration": "Flag indicating that log database writes are frozen during migration",
"login_session_ttl_hours": "Login session lifetime in hours; 0 ends the session when the browser closes, -1 never expires",
"disk_cache_lru_enabled": "Enable least recently used (LRU) cache eviction",
"disk_cache_ttl_minutes": "Default disk cache lifetime (minutes)",
"disk_cache_max_size_mb": "Maximum disk cache size (MB)",
"file_access_whitelist": "File business types accessible without signing in (JSON array)",
"smtp_host": "SMTP server address, for example smtp.example.com",
"smtp_port": "SMTP port, for example 587 or 465",
"smtp_username": "SMTP account, for example sender@example.com",
"smtp_password": "SMTP credential (authorization code or password)",
"upload_allowed_extensions": "Allowed image upload extensions (comma-separated)",
"site_name": "Platform display name",
"password_login_enabled": "Allow username and password sign-in",
"registration_enabled": "Allow users to register their own accounts (true/false)",
"cap_login_enabled": "Enable sign-in CAPTCHA (true/false)",
"oidc_login_enabled": "Allow sign-in through third-party OIDC providers",
"email_login_verification_enabled": "Require email verification for sign-in (true/false)",
"email_register_verification_enabled": "Require email verification for registration (true/false)",
"menu_display_config": "Menu visibility configuration (JSON string mapping URLs to enabled states)",
"search_engine_indexing_enabled": "Allow search engines to crawl and index this site (true/false)",
"update_upstream_repository": "Upstream GitHub Actions release repository (owner/repo or GitHub repository URL)",
"storage_config": "File storage driver and connection settings (JSON)",
"password_register_enabled": "Allow local accounts to be created with a password",
"cap_auto_solve": "Start solving the challenge when the page loads; otherwise require a user click",
"cap_challenge_count": "Number of PoW challenges the client must solve; default 1, recommended 1 to 5",
"cap_challenge_size": "CAPTCHA salt length",
"cap_challenge_difficulty": "CAPTCHA PoW difficulty (target prefix length)",
"cap_challenge_ttl_seconds": "CAPTCHA challenge lifetime (seconds)",
"cap_token_ttl_seconds": "CAPTCHA verification token lifetime (seconds)",
"server_address": "Server URL used to restrict allowed origins; leave empty to allow any origin"
},
"templates": {
"login_email": {
"name": "Sign-in verification email",
"description": "Verification email sent during password sign-in. Available variable: {{.Code}}"
},
"register_email": {
"name": "Registration verification email",
"description": "Verification email sent during registration. Available variable: {{.Code}}"
}
}
}
}