Settings
Configure branding, authentication, navigation, and runtime options for the OpenAgent site.
Settings
Settings (configured via Sites in the admin panel) controls the entire built-in site experience: branding, authentication, navigation, and runtime behavior.
Branding & Appearance
| Field | Description |
|---|---|
| Theme Color | Primary accent color for the UI (hex code, e.g. #4f46e5). |
| HTML Title | Browser tab title for the site (e.g. "MyCompany AI"). |
| Favicon URL | URL to a .ico or .png favicon. |
| Logo URL | URL to the logo image shown in the navigation bar. |
| Navbar HTML | Custom HTML injected into the navigation bar. |
| Footer HTML | Custom HTML for the page footer. |
| Static Base URL | Base URL for serving static assets from a CDN or custom domain. |
| Nav Items | List of navigation items to show in the site sidebar. Controls which product areas are visible. |
| Endpoint | Public HTTPS base URL for this OpenAgent site. Hub cards use it when linking to Stores hosted by another OpenAgent database. If the built-in site has no public endpoint, OpenAgent can auto-fill it from the first public request host. |
| Hub Description | Custom subtitle shown at the top of the Hub page. Leave it empty to use the default Hub description. |
Custom Navbar HTML is rendered in the management shell after settings are loaded, so branding and navigation snippets can be updated from the site record without rebuilding the frontend.
Authentication
| Field | Description |
|---|---|
| Issuer | OIDC issuer URL of the identity provider (e.g. Casdoor endpoint). |
| Client ID | OAuth2 application client ID. |
| Client Secret | OAuth2 application client secret. |
| Casdoor Endpoint | Casdoor service URL (backward-compatible alias for Issuer). |
| Casdoor Organization | The Casdoor organization name to authenticate against. |
| Casdoor Application | The Casdoor application name. |
For standard Casdoor deployments, setting Issuer, Client ID, and Client Secret is sufficient. The Casdoor-specific fields are for backward compatibility.
Runtime Configuration
| Field | Description |
|---|---|
| IP Parsing Mode | How client IPs are extracted from requests. Options: "" (direct), "X-Forwarded-For", "X-Real-IP". Set appropriately when running behind a reverse proxy. |
| Parent DB Name | Database name for a parent OpenAgent instance. Use it when this site should read or sync shared parent-instance data in a multi-instance deployment. |
| Hub DB Names | Comma-separated database names whose published Stores should also appear in this site's Hub. Each remote database should have a public Endpoint configured on its built-in site record. |
| Socks5 Proxy | SOCKS5 proxy address (e.g. 127.0.0.1:1080) for outbound requests. Used by tools that make external HTTP calls (web_search, web_fetch, etc.) when Enable Proxy is set on the Tool record. |
| Log Config | Logging configuration string (BeeGo log config format). |
Hub Federation
Use Hub DB Names when one OpenAgent site should act as a catalog for Stores published by multiple OpenAgent databases. The field accepts database names separated by commas. OpenAgent reads Stores whose Publish State is Published from each listed database and merges them into the Hub response.
Each contributing site should have a public Endpoint on its built-in site record. Remote Hub cards use that endpoint to build the chat link, so users land on the OpenAgent instance that actually hosts the Store. When Endpoint is empty or points to a non-public host, OpenAgent can auto-fill it from the first public request host and stores it as an HTTPS URL.
Set Hub Description on the Hub site when the catalog needs deployment-specific copy, such as an internal marketplace description or school/course context. This text only changes the Hub page header; Store cards still use each Store's own profile fields.
Feature Flags
| Field | Description |
|---|---|
| Check User Balance | When enabled, enforces token/credit balance checks before processing messages. Useful for metered deployments. |
Applying changes
Settings changes take effect immediately for new sessions. Users who are currently logged in may need to refresh their browser to pick up branding changes.