ClouisleClouisle

Site Settings Reference

Look up public site, registration, security, theme, notification, and storage fields

Public settings are provided by the backend PublicSiteSettingsResponse. The following defaults apply when nothing is configured.

Public & Authentication Settings

FieldTypeDefault
site_namestringClouisle
site_description / site_url / site_iconstringEmpty
auth_page_layoutcentered or splitcentered
theme_modesystem, light or darksystem
theme_branding_displayfull, name_only, icon_only or hiddenfull
allow_registrationbooleantrue
require_approvalbooleantrue
email_verificationbooleantrue
enable_captchabooleanfalse
sso_enabledbooleanfalse
sso_allow_password_loginbooleantrue
allow_account_deletionbooleantrue
require_terms_acceptance_on_registerbooleanfalse

Knowledge Base Uploads

kb_document_max_upload_size_mb defaults to 50 with a valid range of 1-1024. The backend upload endpoint reads this value at runtime; exceeding the limit returns a validation error.

Theme Colors

The theme supports page, card, border, sidebar, top navigation, accent, muted, and chart colors. Colors use hex format, for example #3b82f6 or #3b82f680 with transparency.

Security & Compliance Settings

Security settings are managed by administrators under system settings, governing authentication policies, account lockout, password complexity, and outbound network defenses.

Setting KeyTypeDefaultDescription
model_endpoint_allowlistjson (array)19 pre-configured official OriginsModel endpoint Origin allowlist, strictly matched by scheme + host + port (path ignored), up to 200 entries
ssrf_allowed_targetsjson (array)[]SSRF outbound exemption allowlist, up to 200 entries; supports single IP, CIDR subnet, wildcard subdomain (*.corp.internal), or exact hostname
min_password_lengthint8Minimum password length
require_uppercasebooltrueRequire uppercase letters (A-Z) in password
require_numberbooltrueRequire digits (0-9) in password
require_special_charboolfalseRequire special characters (punctuation and bracket symbols) in password
session_timeout_daysint30Login session expiration in days
single_sessionboolfalseEnable single session enforcement (subsequent login terminates previous session)
max_login_attemptsint5Maximum failed login attempts before account lockout
lockout_duration_minutesint15Account lockout duration in minutes
enable_captchaboolfalseEnable human click-verification captcha on login
require_totpboolfalseRequire mandatory TOTP two-factor authentication for all users
password_expiration_enabledboolfalseEnable periodic password expiration policy
password_expiration_daysint90Password validity duration in days
password_expiration_warning_daysint7Days in advance to warn users before expiration
password_history_countint5Number of previous passwords prevented from reuse
password_min_age_daysint0Minimum password age in days before allowing another change
force_password_change_first_loginboolfalseForce users to change default password on first login

Outbound Network & SSRF Defenses

Clouisle enforces strict security validation on all outbound network execution paths (HTTP request workflow nodes, knowledge base document URL import and preview, database tool connection tests):

  1. Default Blocks: Loopback addresses (127.0.0.0/8, ::1), private networks (10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16, fc00::/7), link-local addresses (169.254.0.0/16, fe80::/10), multicast (224.0.0.0/4), unspecified addresses (0.0.0.0), and reserved domain names (localhost, local, metadata.google.internal).
  2. Non-bypassable Critical Blocks: Cloud metadata endpoints (169.254.169.254, 169.254.0.0/16, metadata.google.internal) and universal wildcards (0.0.0.0/0, ::/0, *) are strictly blocked even if added to the allowlist.
  3. Allowlist Exemptions: To connect to internal microservices or private databases, administrators add trusted targets to ssrf_allowed_targets. Supported formats:
    • Specific IP: e.g. 192.168.1.100
    • CIDR subnet: e.g. 10.50.0.0/16 (prefix length cannot be 0, cannot overlap metadata networks)
    • Wildcard subdomain: e.g. *.corp.internal (matches corp.internal and all its subdomains)
    • Exact hostname: e.g. api.internal.local (must contain at least one dot, cannot start or end with dot)

Model Endpoint Security Policy

All upstream LLM API requests are gated by model_endpoint_allowlist. The system matches against the full Origin (https://api.openai.com, http://localhost:11434), ignoring paths, query parameters, and credentials. Non-standard ports must match explicitly.

Memory Management & Retrieval Settings

Setting KeyTypeDefaultDescription
memory_async_extraction_enabledboolfalseEnable asynchronous background memory extraction from chat conversations
memory_extraction_model_idstring""Dedicated model ID for memory extraction (empty for system fallback)
memory_extraction_cooldown_secondsint180Cooldown window in seconds before background extraction (valid range 10-3600)
memory_extraction_max_pending_turnsint6Maximum pending unextracted conversation turns before immediate trigger (1-50)
retrieval_hybrid_modestring"rollout"Hybrid retrieval rollout mode: rollout, enabled, or disabled
retrieval_hybrid_team_idsjson (array)[]Team IDs explicitly included in hybrid retrieval rollout
retrieval_hybrid_percentageint100Deterministic hybrid retrieval rollout percentage

Storage & Audit Settings

Setting KeyTypeDefaultDescription
upload_storage_backendstring"local"File storage backend: "local" (local filesystem) or "object" (S3-compatible object storage)
kb_document_max_upload_size_mbint50Maximum file upload size in MB for knowledge base documents (1-1024)
object_storage_endpointstring""S3-compatible endpoint URL (e.g. s3.us-west-1.amazonaws.com)
object_storage_bucketstring""Bucket name
object_storage_regionstring""Bucket region
object_storage_access_keystring""Access Key
object_storage_secret_keystring""Secret Key (stored securely)
object_storage_force_path_stylebooltrueUse path-style S3 URLs
object_storage_securebooltrueUse HTTPS protocol for object storage endpoint
audit_log_retention_daysint365Audit log retention period in days (valid range 30-3650)
audit_log_archive_pathstring"/var/log/clouisle/audit_archives"Local or mounted archive file path
audit_alert_enabledbooltrueEnable security alerts on audit logs
audit_alert_webhookstring""Webhook URL for audit alerts
audit_alert_failed_login_thresholdint5Failed login threshold before triggering security alert
audit_alert_failed_login_windowint5Time window in minutes for failed login detection
audit_alert_bulk_deletion_thresholdint10Bulk deletion threshold before triggering alert

Notification Channels & Automated Notifications

Supported channels: Email (SMTP), DingTalk, WeChat Work, Feishu, Slack, and generic Webhooks.

Administrators configure global notification channels and enabled event types via auto_notification_config (JSON object). The system automatically tracks and dispatches:

  • Team events: team.member_added, team.member_removed, team.role_changed, team.ownership_transferred, team.model_granted, team.model_revoked
  • User events: user.activated, user.deactivated, user.password_reset, user.pending_approval
  • Knowledge base events: kb.doc_indexed, kb.doc_failed
  • Workflow events: workflow.run_failed, workflow.pause_pending
  • Credentials and security: apikey.expiring, apikey.expired, security.login_anomaly, security.account_locked, security.password_changed
Site settings fields overview
Site settings fields overview

How is this guide?

On this page