Documentation
¶
Index ¶
- Constants
- type AdminAuthzConfig
- type AdminConfig
- type AdminDebugConfig
- type AdminErrorsConfig
- type AdminScopeConfig
- type AppConfig
- type AuthConfig
- type CMSConfig
- type Config
- type DatabasesConfig
- type DatagridConfig
- type ExportPDFConfig
- type FeatureConfig
- type FiberConfig
- type NavigationConfig
- type PreferencesConfig
- type RegistrationConfig
- type SecureLinkConfig
- type SeedsConfig
- type ServerConfig
- type SiteConfig
- type TranslationConfig
Constants ¶
View Source
const ( DefaultEnvPrefix = "APP_" DefaultEnvDelimiter = "__" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AdminAuthzConfig ¶
type AdminConfig ¶
type AdminConfig struct {
BasePath string `koanf:"base_path" json:"base_path" yaml:"base_path"`
Title string `koanf:"title" json:"title" yaml:"title"`
DefaultLocale string `koanf:"default_locale" json:"default_locale" yaml:"default_locale"`
PublicAPI bool `koanf:"public_api" json:"public_api" yaml:"public_api"`
PreviewSecret string `koanf:"preview_secret" json:"preview_secret" yaml:"preview_secret"`
APIPrefix string `koanf:"api_prefix" json:"api_prefix" yaml:"api_prefix"`
APIVersion string `koanf:"api_version" json:"api_version" yaml:"api_version"`
AssetsDir string `koanf:"assets_dir" json:"assets_dir" yaml:"assets_dir"`
FeatureCatalogPath string `koanf:"feature_catalog_path" json:"feature_catalog_path" yaml:"feature_catalog_path"`
WorkflowConfigPath string `koanf:"workflow_config_path" json:"workflow_config_path" yaml:"workflow_config_path"`
RegisterTemplate string `koanf:"register_template" json:"register_template" yaml:"register_template"`
Preferences PreferencesConfig `koanf:"preferences" json:"preferences" yaml:"preferences"`
Debug AdminDebugConfig `koanf:"debug" json:"debug" yaml:"debug"`
Errors AdminErrorsConfig `koanf:"errors" json:"errors" yaml:"errors"`
Scope AdminScopeConfig `koanf:"scope" json:"scope" yaml:"scope"`
AuthzPreflight AdminAuthzConfig `koanf:"authz_preflight" json:"authz_preflight" yaml:"authz_preflight"`
PermissionResolverCacheTTL time.Duration `koanf:"permission_resolver_cache_ttl" json:"permission_resolver_cache_ttl" yaml:"permission_resolver_cache_ttl"`
PasswordPolicyHints []string `koanf:"password_policy_hints" json:"password_policy_hints" yaml:"password_policy_hints"`
DatagridURLStateEnableToken *bool `koanf:"datagrid_url_enable_state_token" json:"datagrid_url_enable_state_token" yaml:"datagrid_url_enable_state_token"`
}
type AdminDebugConfig ¶
type AdminDebugConfig struct {
Enabled bool `koanf:"enabled" json:"enabled" yaml:"enabled"`
EnableSlog bool `koanf:"enable_slog" json:"enable_slog" yaml:"enable_slog"`
Layout string `koanf:"layout" json:"layout" yaml:"layout"`
ReplEnabled bool `koanf:"repl_enabled" json:"repl_enabled" yaml:"repl_enabled"`
ReplReadOnly bool `koanf:"repl_read_only" json:"repl_read_only" yaml:"repl_read_only"`
ScopeEnabled bool `koanf:"scope_enabled" json:"scope_enabled" yaml:"scope_enabled"`
ScopeLimit int `koanf:"scope_limit" json:"scope_limit" yaml:"scope_limit"`
DoctorEnabled *bool `koanf:"doctor_enabled" json:"doctor_enabled" yaml:"doctor_enabled"`
}
type AdminErrorsConfig ¶
type AdminErrorsConfig struct {
DevMode bool `koanf:"dev_mode" json:"dev_mode" yaml:"dev_mode"`
IncludeStackTrace bool `koanf:"include_stack_trace" json:"include_stack_trace" yaml:"include_stack_trace"`
ExposeInternalErrors bool `koanf:"expose_internal_errors" json:"expose_internal_errors" yaml:"expose_internal_errors"`
}
type AdminScopeConfig ¶
type AuthConfig ¶
type CMSConfig ¶
type CMSConfig struct {
RuntimeLogs *bool `koanf:"runtime_logs" json:"runtime_logs" yaml:"runtime_logs"`
}
type Config ¶
type Config struct {
App AppConfig `koanf:"app" json:"app" yaml:"app"`
Server ServerConfig `koanf:"server" json:"server" yaml:"server"`
Admin AdminConfig `koanf:"admin" json:"admin" yaml:"admin"`
Site SiteConfig `koanf:"site" json:"site" yaml:"site"`
Features FeatureConfig `koanf:"features" json:"features" yaml:"features"`
Registration RegistrationConfig `koanf:"registration" json:"registration" yaml:"registration"`
Seeds SeedsConfig `koanf:"seeds" json:"seeds" yaml:"seeds"`
Databases DatabasesConfig `koanf:"databases" json:"databases" yaml:"databases"`
SecureLink SecureLinkConfig `koanf:"securelink" json:"securelink" yaml:"securelink"`
Translation TranslationConfig `koanf:"translation" json:"translation" yaml:"translation"`
Datagrid DatagridConfig `koanf:"datagrid" json:"datagrid" yaml:"datagrid"`
ExportPDF ExportPDFConfig `koanf:"export_pdf" json:"export_pdf" yaml:"export_pdf"`
Fiber FiberConfig `koanf:"fiber" json:"fiber" yaml:"fiber"`
Auth AuthConfig `koanf:"auth" json:"auth" yaml:"auth"`
CMS CMSConfig `koanf:"cms" json:"cms" yaml:"cms"`
ConfigPath string `koanf:"-" json:"-" yaml:"-"`
}
Config defines runtime configuration for the examples/web application.
type DatabasesConfig ¶
type DatagridConfig ¶
type DatagridConfig struct {
StateStoreMode string `koanf:"state_store_mode" json:"state_store_mode" yaml:"state_store_mode"`
SyncDebounceMS int `koanf:"sync_debounce_ms" json:"sync_debounce_ms" yaml:"sync_debounce_ms"`
URLMaxLength int `koanf:"url_max_length" json:"url_max_length" yaml:"url_max_length"`
URLMaxFiltersLength int `koanf:"url_max_filters_length" json:"url_max_filters_length" yaml:"url_max_filters_length"`
URLEnableStateToken *bool `koanf:"url_enable_state_token" json:"url_enable_state_token" yaml:"url_enable_state_token"`
}
type ExportPDFConfig ¶
type ExportPDFConfig struct {
Engine string `koanf:"engine" json:"engine" yaml:"engine"`
WKHTMLToPDFPath string `koanf:"wkhtmltopdf_path" json:"wkhtmltopdf_path" yaml:"wkhtmltopdf_path"`
BrowserPath string `koanf:"browser_path" json:"browser_path" yaml:"browser_path"`
Timeout time.Duration `koanf:"timeout" json:"timeout" yaml:"timeout"`
PageSize string `koanf:"page_size" json:"page_size" yaml:"page_size"`
PrintBackground bool `koanf:"print_background" json:"print_background" yaml:"print_background"`
PreferCSSPageSize bool `koanf:"prefer_css_page_size" json:"prefer_css_page_size" yaml:"prefer_css_page_size"`
Headless bool `koanf:"headless" json:"headless" yaml:"headless"`
Args []string `koanf:"args" json:"args" yaml:"args"`
}
type FeatureConfig ¶
type FeatureConfig struct {
PersistentCMS bool `koanf:"persistent_cms" json:"persistent_cms" yaml:"persistent_cms"`
GoOptions bool `koanf:"go_options" json:"go_options" yaml:"go_options"`
GoUsersActivity bool `koanf:"go_users_activity" json:"go_users_activity" yaml:"go_users_activity"`
UserInvites bool `koanf:"user_invites" json:"user_invites" yaml:"user_invites"`
PasswordReset bool `koanf:"password_reset" json:"password_reset" yaml:"password_reset"`
SelfRegistration bool `koanf:"self_registration" json:"self_registration" yaml:"self_registration"`
}
type FiberConfig ¶
type FiberConfig struct {
StrictRoutes bool `koanf:"strict_routes" json:"strict_routes" yaml:"strict_routes"`
RouteConflictPolicy string `koanf:"route_conflict_policy" json:"route_conflict_policy" yaml:"route_conflict_policy"`
PathConflictMode string `koanf:"path_conflict_mode" json:"path_conflict_mode" yaml:"path_conflict_mode"`
ReadBufferSize int `koanf:"read_buffer_size" json:"read_buffer_size" yaml:"read_buffer_size"`
}
type NavigationConfig ¶
type NavigationConfig struct {
}
type PreferencesConfig ¶
type RegistrationConfig ¶
type SecureLinkConfig ¶
type SecureLinkConfig struct {
BaseURL string `koanf:"base_url" json:"base_url" yaml:"base_url"`
SigningKey string `koanf:"signing_key" json:"signing_key" yaml:"signing_key"`
QueryKey string `koanf:"query_key" json:"query_key" yaml:"query_key"`
AsQuery bool `koanf:"as_query" json:"as_query" yaml:"as_query"`
Expiration time.Duration `koanf:"expiration" json:"expiration" yaml:"expiration"`
}
type SeedsConfig ¶
type ServerConfig ¶
type ServerConfig struct {
Address string `koanf:"address" json:"address" yaml:"address"`
}
type SiteConfig ¶
type SiteConfig struct {
BasePath string `koanf:"base_path" json:"base_path" yaml:"base_path"`
RuntimeEnv string `koanf:"runtime_env" json:"runtime_env" yaml:"runtime_env"`
ContentChannel string `koanf:"content_channel" json:"content_channel" yaml:"content_channel"`
SupportedLocales []string `koanf:"supported_locales" json:"supported_locales" yaml:"supported_locales"`
LocalePrefixMode string `koanf:"locale_prefix_mode" json:"locale_prefix_mode" yaml:"locale_prefix_mode"`
AllowLocaleFallback bool `koanf:"allow_locale_fallback" json:"allow_locale_fallback" yaml:"allow_locale_fallback"`
ContributionLocalePolicy string `koanf:"contribution_locale_policy" json:"contribution_locale_policy" yaml:"contribution_locale_policy"`
EnableGeneratedFallback bool `koanf:"enable_generated_fallback" json:"enable_generated_fallback" yaml:"enable_generated_fallback"`
EnableSearch bool `koanf:"enable_search" json:"enable_search" yaml:"enable_search"`
EnableCanonicalRedirect bool `koanf:"enable_canonical_redirect" json:"enable_canonical_redirect" yaml:"enable_canonical_redirect"`
CanonicalRedirectMode string `koanf:"canonical_redirect_mode" json:"canonical_redirect_mode" yaml:"canonical_redirect_mode"`
StrictLocalizedPaths bool `koanf:"strict_localized_paths" json:"strict_localized_paths" yaml:"strict_localized_paths"`
EnvironmentStrict bool `koanf:"environment_strict" json:"environment_strict" yaml:"environment_strict"`
Theme string `koanf:"theme" json:"theme" yaml:"theme"`
ThemeVariant string `koanf:"theme_variant" json:"theme_variant" yaml:"theme_variant"`
}
type TranslationConfig ¶
Click to show internal directories.
Click to hide internal directories.