Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AuditConfig ¶ added in v0.8.0
type Config ¶
type Config struct {
HTTPListenPort int `usage:"HTTP port to listen on" default:"8080" name:"http-listen-port"`
DevMode bool `usage:"Enable development mode" default:"false" name:"dev-mode" env:"OBOT_DEV_MODE"`
DevUIPort int `usage:"The port on localhost running the dev instance of the UI" default:"5174"`
UserUIPort int `usage:"The port on localhost running the user production instance of the UI" env:"OBOT_SERVER_USER_UI_PORT"`
AllowedOrigin string `usage:"Allowed origin for CORS"`
ToolRegistries []string `usage:"The remote tool references to the set of gptscript tool registries to use" default:"github.com/obot-platform/tools"`
WorkspaceProviderType string `` /* 129-byte string literal not displayed */
HelperModel string `usage:"The model used to generate names and descriptions" default:"gpt-4.1-mini"`
EmailServerName string `usage:"The name of the email server to display for email receivers"`
Docker bool `usage:"Enable Docker support" default:"false" env:"OBOT_DOCKER"`
EnvKeys []string `usage:"The environment keys to pass through to the GPTScript server" env:"OBOT_ENV_KEYS"`
KnowledgeSetIngestionLimit int `usage:"The maximum number of files to ingest into a knowledge set" default:"3000" name:"knowledge-set-ingestion-limit"`
KnowledgeFileWorkers int `usage:"The number of workers to process knowledge files" default:"5"`
RunWorkers int `usage:"The number of workers to process runs" default:"1000"`
ElectionFile string `usage:"Use this file for leader election instead of database leases"`
EnableAuthentication bool `usage:"Enable authentication" default:"false"`
ForceEnableBootstrap bool `usage:"Enables the bootstrap user even if other admin users have been created" default:"false"`
AuthAdminEmails []string `usage:"Emails of admin users"`
AuthOwnerEmails []string `usage:"Emails of owner users"`
AgentsDir string `usage:"The directory to auto load agents on start (default $XDG_CONFIG_HOME/.obot/agents)"`
StaticDir string `usage:"The directory to serve static files from"`
RetentionPolicyHours int `usage:"The retention policy for the system. Set to 0 to disable retention." default:"2160"` // default 90 days
DefaultMCPCatalogPath string `usage:"The path to the default MCP catalog (accessible to all users)" default:""`
DisableUpdateCheck bool `usage:"Disable Obot server update checks"`
// Sendgrid webhook
SendgridWebhookUsername string `usage:"The username for the sendgrid webhook to authenticate with"`
SendgridWebhookPassword string `usage:"The password for the sendgrid webhook to authenticate with"`
EnableRegistryAuth bool `usage:"Enable authentication for the MCP registry API" default:"false" env:"OBOT_SERVER_ENABLE_REGISTRY_AUTH"`
GeminiConfig
GatewayConfig
EncryptionConfig
OtelOptions
AuditConfig
RateLimiterConfig
MCPConfig
services.Config
}
type EncryptionConfig ¶ added in v0.8.0
type EncryptionConfig encryption.Options
type GatewayConfig ¶
type GeminiConfig ¶ added in v0.7.0
type OtelOptions ¶ added in v0.8.0
type RateLimiterConfig ¶ added in v0.8.0
type RateLimiterConfig ratelimiter.Options
type Services ¶
type Services struct {
EncryptionConfig *encryptionconfig.EncryptionConfiguration
ToolRegistryURLs []string
WorkspaceProviderType string
ServerURL string
InternalServerURL string
EmailServerName string
DevUIPort int
UserUIPort int
Events *events.Emitter
StorageClient storage.Client
Router *router.Router
GPTClient *gptscript.GPTScript
Invoker *invoke.Invoker
PersistentTokenServer *persistent.TokenService
APIServer *server.Server
Started chan struct{}
GatewayServer *gserver.Server
GatewayClient *client.Client
ProxyManager *proxy.Manager
ProviderDispatcher *dispatcher.Dispatcher
Bootstrapper *bootstrap.Bootstrap
KnowledgeSetIngestionLimit int
SupportDocker bool
AuthEnabled bool
DefaultMCPCatalogPath string
AgentsDir string
GeminiClient *gemini.Client
Otel *Otel
AuditLogger audit.Logger
PostgresDSN string
RetentionPolicy time.Duration
// Use basic auth for sendgrid webhook, if being set
SendgridWebhookUsername string
SendgridWebhookPassword string
// Used for indexed lookups of access control rules.
AccessControlRuleHelper *accesscontrolrule.Helper
// Used for indexed lookups of model access policies.
ModelAccessPolicyHelper *modelaccesspolicy.Helper
WebhookHelper *mcp.WebhookHelper
// Used for loading and running MCP servers with GPTScript.
MCPLoader *mcp.SessionManager
// Global token storage client for MCP OAuth
MCPOAuthTokenStorage mcp.GlobalTokenStore
// OAuth configuration
OAuthServerConfig handlers.OAuthAuthorizationServerConfig
// Local Kubernetes configuration for deployment monitoring
LocalK8sConfig *rest.Config
MCPServerNamespace string
// Parsed settings from Helm for k8s to pass to controller
K8sSettingsFromHelm *v1.K8sSettingsSpec
DisableUpdateCheck bool
MCPRuntimeBackend string
RegistryNoAuth bool
}
Click to show internal directories.
Click to hide internal directories.