Documentation
¶
Overview ¶
Package config handles configuration values for Miniflux application.
Index ¶
- type Config
- func (c *Config) BasePath() string
- func (c *Config) BaseURL() string
- func (c *Config) BatchSize() int
- func (c *Config) CertCache() string
- func (c *Config) CertDomain() string
- func (c *Config) CertFile() string
- func (c *Config) CleanupFrequency() int
- func (c *Config) CreateAdmin() bool
- func (c *Config) DatabaseMaxConnections() int
- func (c *Config) DatabaseURL() string
- func (c *Config) HasDebugMode() bool
- func (c *Config) HasHSTS() bool
- func (c *Config) IsOAuth2UserCreationAllowed() bool
- func (c *Config) KeyFile() string
- func (c *Config) ListenAddr() string
- func (c *Config) OAuth2ClientID() string
- func (c *Config) OAuth2ClientSecret() string
- func (c *Config) OAuth2Provider() string
- func (c *Config) OAuth2RedirectURL() string
- func (c *Config) PocketConsumerKey(defaultValue string) string
- func (c *Config) PollingFrequency() int
- func (c *Config) ProxyImages() string
- func (c *Config) RootURL() string
- func (c *Config) RunMigrations() bool
- func (c *Config) WorkerPoolSize() int
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
IsHTTPS bool
// contains filtered or unexported fields
}
Config manages configuration parameters.
func (*Config) CertDomain ¶
CertDomain returns the domain to use for Let's Encrypt certificate.
func (*Config) CleanupFrequency ¶
CleanupFrequency returns the interval for cleanup jobs.
func (*Config) CreateAdmin ¶
CreateAdmin returns true if the environment variable CREATE_ADMIN is not empty.
func (*Config) DatabaseMaxConnections ¶
DatabaseMaxConnections returns the number of maximum database connections.
func (*Config) DatabaseURL ¶
DatabaseURL returns the database URL.
func (*Config) HasDebugMode ¶
HasDebugMode returns true if debug mode is enabled.
func (*Config) IsOAuth2UserCreationAllowed ¶
IsOAuth2UserCreationAllowed returns true if user creation is allowed for OAuth2 users.
func (*Config) ListenAddr ¶
ListenAddr returns the listen address for the HTTP server.
func (*Config) OAuth2ClientID ¶
OAuth2ClientID returns the OAuth2 Client ID.
func (*Config) OAuth2ClientSecret ¶
OAuth2ClientSecret returns the OAuth2 client secret.
func (*Config) OAuth2Provider ¶
OAuth2Provider returns the name of the OAuth2 provider configured.
func (*Config) OAuth2RedirectURL ¶
OAuth2RedirectURL returns the OAuth2 redirect URL.
func (*Config) PocketConsumerKey ¶
PocketConsumerKey returns the Pocket Consumer Key if defined as environment variable.
func (*Config) PollingFrequency ¶
PollingFrequency returns the interval to refresh feeds in the background.
func (*Config) ProxyImages ¶
ProxyImages returns "none" to never proxy, "http-only" to proxy non-HTTPS, "all" to always proxy.
func (*Config) RunMigrations ¶
RunMigrations returns true if the environment variable RUN_MIGRATIONS is not empty.
func (*Config) WorkerPoolSize ¶
WorkerPoolSize returns the number of background worker.
Source Files