Documentation
¶
Index ¶
- Constants
- func ApplyCommandLineOverrides(cfg *nbconfig.Config)
- func ApplyDeviceAuthFlowConfig(ctx context.Context, cfg *nbconfig.Config, oidcConfig *OIDCConfigResponse, ...) error
- func ApplyEmbeddedIdPConfig(ctx context.Context, cfg *nbconfig.Config) error
- func ApplyOIDCConfig(ctx context.Context, cfg *nbconfig.Config) error
- func ApplyPKCEFlowConfig(ctx context.Context, cfg *nbconfig.Config, oidcConfig *OIDCConfigResponse)
- func Customize(fn func(root *cobra.Command))
- func EnsureEncryptionKey(ctx context.Context, configPath string, cfg *nbconfig.Config) error
- func Execute() error
- func LoadMgmtConfig(ctx context.Context, mgmtConfigPath string) (*nbconfig.Config, error)
- func LogConfigInfo(cfg *nbconfig.Config)
- func SetNewServer(fn func(*server.Config) server.Server)
- type OIDCConfigResponse
Constants ¶
const (
// ExitSetupFailed defines exit code
ExitSetupFailed = 1
)
Variables ¶
This section is empty.
Functions ¶
func ApplyCommandLineOverrides ¶ added in v0.65.0
ApplyCommandLineOverrides applies command-line flag overrides to the config
func ApplyDeviceAuthFlowConfig ¶ added in v0.65.0
func ApplyDeviceAuthFlowConfig(ctx context.Context, cfg *nbconfig.Config, oidcConfig *OIDCConfigResponse, oidcEndpoint string) error
ApplyDeviceAuthFlowConfig applies OIDC config to DeviceAuthorizationFlow if enabled
func ApplyEmbeddedIdPConfig ¶ added in v0.65.0
ApplyEmbeddedIdPConfig populates HttpConfig and EmbeddedIdP storage from config when embedded IdP is enabled. This allows users to only specify EmbeddedIdP config without duplicating values in HttpConfig.
func ApplyOIDCConfig ¶ added in v0.65.0
ApplyOIDCConfig fetches and applies OIDC configuration if endpoint is specified
func ApplyPKCEFlowConfig ¶ added in v0.65.0
func ApplyPKCEFlowConfig(ctx context.Context, cfg *nbconfig.Config, oidcConfig *OIDCConfigResponse)
ApplyPKCEFlowConfig applies OIDC config to PKCEAuthorizationFlow if configured
func Customize ¶ added in v0.79.0
Customize hands the fully built root command to fn so an embedding binary can extend or adjust the command tree — most commonly attaching its own subcommands next to (or under) the built-in ones — before calling Execute. The root command is constructed in this package's init, so Customize may be called from the embedding binary's main at any point before Execute.
func EnsureEncryptionKey ¶ added in v0.65.0
EnsureEncryptionKey generates and saves a DataStoreEncryptionKey if not set
func LoadMgmtConfig ¶ added in v0.65.0
func LogConfigInfo ¶ added in v0.65.0
LogConfigInfo logs informational messages about the loaded configuration
Types ¶
type OIDCConfigResponse ¶ added in v0.8.10
type OIDCConfigResponse struct {
Issuer string `json:"issuer"`
TokenEndpoint string `json:"token_endpoint"`
DeviceAuthEndpoint string `json:"device_authorization_endpoint"`
JwksURI string `json:"jwks_uri"`
AuthorizationEndpoint string `json:"authorization_endpoint"`
}
OIDCConfigResponse used for parsing OIDC config response
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package admincmd provides reusable cobra commands for self-hosted administrator helpers.
|
Package admincmd provides reusable cobra commands for self-hosted administrator helpers. |
|
Package proxycmd provides reusable cobra commands for managing reverse proxy instances.
|
Package proxycmd provides reusable cobra commands for managing reverse proxy instances. |
|
Package tokencmd provides reusable cobra commands for managing proxy access tokens.
|
Package tokencmd provides reusable cobra commands for managing proxy access tokens. |