Skip to main content

Settings

The Settings page is the admin configuration hub for the Beak AI Runtime. The page subtitle reads "Configure your system preferences and integrations". Six tabs cover distinct configuration areas: Users, AI Provider, Notifications (SMTP), Email Settings, Microsoft Teams, and Slack Integration. Each tab loads and saves its configuration independently; unsaved changes on one tab are not affected by switching to another.

Password and secret fields mask their values after the initial save and show a Saved (unchanged) placeholder so admins know a value is stored without exposing it. Leaving a masked field blank when saving preserves the existing secret.

Users Tab​

The Users tab provides full lifecycle management for Runtime user accounts. The left column carries a User Management heading with a summary of the current admin count and active user count. The right column contains the user table.

User Table Toolbar​

  • Filter buttons — all (N), active (N), and inactive (N) buttons filter the displayed rows. The active button is highlighted in the primary colour.
  • Add User button — Opens the Add User dialog.

User Row​

Each row in the table shows:

  • Avatar — Initials derived from the user's first and last name, or the first character of the email address. Admin avatars use the primary colour background; standard users use the muted background.
  • Display name and email — Full name (or email address if no name is set) in bold, with the email address as secondary text below.
  • Inactive badge — Shown in red when the user's account is deactivated.
  • Role badge — A clickable pill showing Admin (with a shield icon, primary colour border) or User (with a user icon, neutral border). Clicking the badge toggles the role between admin and user immediately.
  • Auth method badge — A small uppercase label showing local or sso indicating how the user authenticates.
  • Deactivate / Activate button — Toggles the account's active state. Deactivated accounts cannot log in.

Add User Dialog​

The Add User dialog collects:

  • First Name and Last Name — Optional display name fields.
  • Email — Required. The login identifier for the account.
  • Role — User (default) or Admin. Admin users can access all admin pages including Connections, Providers, and Settings.
  • Auth Method — Local (Password) for credentials stored in the Runtime, or SSO for accounts authenticated through the configured identity provider.
  • Password — Required when Local (Password) is selected; must be at least eight characters.

The dialog's Add User button is disabled until the email field is populated and while the creation request is in flight.

AI Provider Tab​

The AI Provider tab routes LLM requests to either the Beak AI Gateway or a custom OpenAI-compatible endpoint. The left column carries the AI Provider heading and a description explaining the two routing modes.

Provider Selection​

Two radio options are presented.

  • Beak AI Gateway — Routes through the Beak Gateway Manager for unified multi-provider routing, spend tracking, and rate limiting. Recommended for deployments that share the Beak platform stack.
  • Custom OpenAI-Compatible Endpoint — Connects directly to any API that follows the OpenAI REST interface, including OpenAI, Azure OpenAI, Ollama, and vLLM.

Beak AI Gateway Fields​

  • Gateway URL — The base URL of the Beak Gateway Manager service (for example http://gateway-manager:5060).
  • Virtual API Key — The API key issued by the Gateway Manager for this Runtime instance; stored encrypted.
  • Default Model — A dropdown populated dynamically from the models available in the connected Gateway. If the Gateway is unreachable or returns no models, a free-text input is shown instead.

Custom Endpoint Fields​

  • Base URL — The API root (for example https://api.openai.com/v1).
  • API Key — The provider API key; stored encrypted.
  • Default Model — Free-text model identifier (for example gpt-4o).
  • Test Connection button — Fires a live probe against the configured endpoint and displays the latency on success or the error message on failure.

The Save Provider Settings button is shared across both modes and appears at the bottom of the form.

Notifications (SMTP) Tab​

The Notifications (SMTP) tab configures the outbound mail server the Runtime uses to send transactional alerts, approval emails, and other automated messages. The left column carries the Notifications (SMTP) heading.

SMTP Fields​

  • Host — The SMTP server hostname (for example smtp.gmail.com).
  • Port — The SMTP port number (for example 587).
  • Username — The SMTP account username.
  • Password — The SMTP account password; stored encrypted. Leaving the field blank when saving preserves the existing password.
  • Use SSL/TLS toggle — Enables or disables a secure connection to the mail server.

The tab footer contains a Test Connection button that fires a test delivery and a Save SMTP Settings button.

Email Settings Tab​

The Email Settings tab controls how outgoing messages appear to recipients. It lives within the same Notifications (SMTP) tab in the navigation but is rendered as a separate card beneath the SMTP configuration.

  • Sender Name — The display name shown in the From field of outgoing emails (for example Beak Administrator).
  • Reply-To Address — The email address replies are directed to (for example support@beak.io).

Changes are committed with the Save Email Settings button.

Microsoft Teams Tab​

The Microsoft Teams tab connects the Runtime to a Teams channel for delivering agent alerts and approval notifications. The left column carries the Microsoft Teams heading.

Teams Fields​

  • Webhook URL — The incoming webhook URL generated from the target Teams channel. The field shows Saved (unchanged) when a URL is already stored.
  • Channel Name — The display name of the Teams channel (for example #beak-notifications).
  • Enable Notifications toggle — Activates or suspends Teams notification delivery without removing the configuration.

The tab footer contains a Test Connection button and a Save Teams Settings button.

Slack Integration Tab​

The Slack Integration tab connects the Runtime to a Slack workspace for real-time alerts and agent interaction from Slack channels. The left column carries the Slack Integration heading.

Slack Fields​

  • Bot Token — The xoxb- prefixed OAuth bot token from the Slack app configuration; stored encrypted.
  • Signing Secret — The signing secret used to verify that incoming Slack requests originate from the configured app; stored encrypted.
  • Default Channel — The fallback channel used when no channel is specified by the triggering event (for example #beak-alerts).
  • Enable Notifications toggle — Activates or suspends Slack notification delivery without removing the configuration.

The tab footer contains a Test Connection button and a Save Slack Settings button.

Best Practices​

  • Create at least two admin accounts — A single admin account creates a risk of being locked out. Maintain a second admin as a break-glass account.
  • Use Test Connection before saving SMTP or Teams settings in production — A successful test confirms the credentials and network path are correct before agents rely on the channel for approval notifications.
  • Route through the Beak AI Gateway when possible — The Gateway provides centralised spend tracking and rate limiting that is not available when connecting directly to a provider endpoint.
  • Rotate secrets by entering a new value in the password field and saving — The Runtime replaces the stored secret on save; the Saved (unchanged) placeholder confirms the old value remains intact until a new one is explicitly provided.
  • Enable the Microsoft Teams or Slack channels alongside SMTP — Redundant notification channels ensure approval requests reach approvers even if one delivery path is unavailable.