config

package

Go to main page

Versions in this module

v0

v0.5.0

Aug 19, 2026

Changes in this version

type AuthIdentity

+ ClientIDMetadata *ClientIDMetadata

+ CreatedBy string

+ Delegates []DelegateEntry

+ type ClientIDMetadata struct

+ FirstSeen time.Time

+ PinnedName string

+ URL string

type Config

+ Debug bool

+ MTLS MTLSConfig

+ type DelegateEntry struct

+ ClientAuth string

+ DenyCapabilities []string

+ DenyDocsets []string

+ Identity string

+ Roles []string

+ func (d DelegateEntry) MarshalJSON() ([]byte, error)

type JWKSSpec

+ URL string

+ type MTLSConfig struct

+ CABundle string

type Option

+ func WithDebug(enabled bool) Option

v0.4.1

Aug 8, 2026

v0.4.0

Aug 7, 2026

Changes in this version

+ const DefaultInboxMaxUploadSize

type Config

+ Inbox InboxConfig

+ Plugins PluginsConfig

+ type InboxConfig struct

+ AllowedTypes map[string]string

+ MaxUploadSize int64

+ type PluginsConfig struct

+ Skills SkillsPluginConfig

+ type SkillsPluginConfig struct

+ Enabled bool

+ RemoteCheckTTL time.Duration

+ RemoteMaxBytes int64

+ RemoteTimeout time.Duration

v0.3.0

Jul 14, 2026

Changes in this version

+ func ValidateAuthConfig(auth *AuthConfig) error

type AuthConfig

+ Roles map[string]RoleSpec

type AuthIdentity

+ Roles []string

+ type CapabilityRules struct

+ Capabilities []string

type Config

+ MCPRequireAuth *bool

+ WritableDir string

+ func (cfg Config) MCPAuthRequired() bool

+ type DocsetAccess struct

+ Allow map[string]string

+ Deny []string

type DocsetSpec

+ Access DocsetAccess

+ AgentSkills bool

+ Aliases []string

+ OKF *OKFDocsetConfig

+ type OKFDocsetConfig struct

+ Enforce *bool

+ Patterns []string

type Option

+ func WithWritableDir(dir string) Option

type PathMapping

+ func (p PathMapping) MarshalJSON() ([]byte, error)

+ type RoleSpec struct

+ Allow CapabilityRules

+ Comment string

+ Deny CapabilityRules

v0.2.0

Jul 9, 2026

Changes in this version

type AuthConfig

+ Default map[string]string

type AuthIdentity

+ Capabilities []string

+ Docsets map[string]string

+ Home string

+ Match []IdentityMatch

+ type AuthTokensConfig struct

+ AccessTTL string

+ Audience string

+ Issuer string

+ RefreshTTL string

type Config

+ APIEnabled bool

+ APIPath string

+ DataDir string

+ MCPEnabled bool

+ MCPPath string

+ MaxJobs int

+ OIDCIssuers []OIDCIssuer

+ Readonly bool

+ Shellexec ShellexecConfig

+ Tokens *AuthTokensConfig

+ WriteConflictPolicy vfs.WriteConflictPolicy

type DocsetSpec

+ Inbox string

+ MaxWriteSize int64

+ Readonly *bool

+ WriteConflictPolicy string

+ type IdentityMatch struct

+ Aud string

+ Claims map[string]string

+ Scope string

+ Sub string

+ SubPrefix string

+ TTL string

+ type JWKSSpec struct

+ Mode string

+ type OIDCIssuer struct

+ IssuerURL string

+ JWKS JWKSSpec

type Option

+ func WithAPIEnabled(enabled bool) Option

+ func WithAPIPath(path string) Option

+ func WithDataDir(dir string) Option

+ func WithMCPEnabled(enabled bool) Option

+ func WithMCPPath(path string) Option

+ func WithReadonly(readonly bool) Option

+ func WithWriteConflictPolicy(policy string) Option

+ type ShellexecCmd struct

+ Async bool

+ Cmd string

+ Debounce string

+ FailOnError *bool

+ Timeout string

+ type ShellexecConfig struct

+ PostWrite []ShellexecCmd

+ PreCommit []ShellexecCmd

+ PreRead []ShellexecCmd

+ func (c ShellexecConfig) IsEmpty() bool

v0.1.0

Jun 24, 2026

Changes in this version

+ type AuthConfig struct

+ AllowKeyless *bool

+ DefaultCwd string

+ Docsets map[string]DocsetSpec

+ Identities []AuthIdentity

+ Lore map[string][]string

+ UnknownIdentity string

+ func LoadAuthConfig(path string) (*AuthConfig, error)

+ type AuthIdentity struct

+ Comment string

+ Lore string

+ Name string

+ PublicKey string

+ Publish []string

+ type Config struct

+ AllowKeyless bool

+ AuthFile string

+ CAKeysFile string

+ ConfigVersion string

+ DefaultCwd string

+ ExternalSSHPort int

+ Files FilesConfig

+ Folders []FolderConfig

+ HTTPPort int

+ HostCertFile string

+ HostKeyPath string

+ Logger *slog.Logger

+ MOTD string

+ MetricsPort int

+ Passkeys PasskeysConfig

+ Port int

+ SkillsDir string

+ TLSCert string

+ TLSKey string

+ UnknownIdentity string

+ func New(opts ...Option) (Config, error)

+ type DocsetSpec struct

+ MaxPublishSize int64

+ Paths []PathMapping

+ PublishDir string

+ type FilesConfig struct

+ Allowed []string

+ Denied []string

+ Ignore []string

+ type FolderConfig struct

+ Name string

+ Path string

+ type Option func(*Config) error

+ func WithAllowKeyless(allow bool) Option

+ func WithAllowedPatterns(patterns []string) Option

+ func WithAuthFile(path string) Option

+ func WithCAKeysFile(path string) Option

+ func WithConfigFile(path string) Option

+ func WithDefaultCwd(cwd string) Option

+ func WithEmbeddedConfig(data []byte, motdFallback string) Option

+ func WithHTTPPort(port int) Option

+ func WithHostCertFile(path string) Option

+ func WithHostKeyPath(path string) Option

+ func WithIgnorePatterns(patterns []string) Option

+ func WithLogger(logger *slog.Logger) Option

+ func WithMOTD(motd string) Option

+ func WithMOTDFile(path string) Option

+ func WithMetricsPort(port int) Option

+ func WithPasskeys(pk PasskeysConfig) Option

+ func WithPort(port int) Option

+ func WithSkillsDir(dir string) Option

+ func WithTLS(cert, key string) Option

+ type PasskeysConfig struct

+ Enabled bool

+ LorePath string

+ PasskeysFile string

+ RPID string

+ RPName string

+ RPOrigins []string

+ SessionTTL string

+ type PathMapping struct

+ Display string

+ Source string

+ func (p *PathMapping) UnmarshalJSON(data []byte) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL