config

Documentation

Overview

Package config handles configuration values for Miniflux application.

Index

• type Config
  • func NewConfig() *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) 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) PollingFrequency() int
  • func (c *Config) RootURL() string
  • func (c *Config) RunMigrations() bool
  • func (c *Config) SessionCleanupFrequency() int
  • func (c *Config) WorkerPoolSize() int

Types

type Config

type Config struct {
	IsHTTPS bool
	// contains filtered or unexported fields
}

Config manages configuration parameters.

func NewConfig

func NewConfig() *Config

NewConfig returns a new Config.

func (*Config) BasePath

func (c *Config) BasePath() string

BasePath returns the application base path according to the base URL.

func (*Config) BaseURL

func (c *Config) BaseURL() string

BaseURL returns the application base URL with path.

func (*Config) BatchSize

func (c *Config) BatchSize() int

BatchSize returns the number of feeds to send for background processing.

func (*Config) CertCache

func (c *Config) CertCache() string

CertCache returns the directory to use for Let's Encrypt session cache.

func (*Config) CertDomain

func (c *Config) CertDomain() string

CertDomain returns the domain to use for Let's Encrypt certificate.

func (*Config) CertFile

func (c *Config) CertFile() string

CertFile returns the SSL certificate filename if any.

func (*Config) CreateAdmin

func (c *Config) CreateAdmin() bool

CreateAdmin returns true if the environment variable CREATE_ADMIN is not empty.

func (*Config) DatabaseMaxConnections

func (c *Config) DatabaseMaxConnections() int

DatabaseMaxConnections returns the number of maximum database connections.

func (*Config) DatabaseURL

func (c *Config) DatabaseURL() string

DatabaseURL returns the database URL.

func (*Config) HasDebugMode

func (c *Config) HasDebugMode() bool

HasDebugMode returns true if debug mode is enabled.

func (*Config) HasHSTS

func (c *Config) HasHSTS() bool

HasHSTS returns true if HTTP Strict Transport Security is enabled.

func (*Config) IsOAuth2UserCreationAllowed

func (c *Config) IsOAuth2UserCreationAllowed() bool

IsOAuth2UserCreationAllowed returns true if user creation is allowed for OAuth2 users.

func (*Config) KeyFile

func (c *Config) KeyFile() string

KeyFile returns the private key filename for custom SSL certificate.

func (*Config) ListenAddr

func (c *Config) ListenAddr() string

ListenAddr returns the listen address for the HTTP server.

func (*Config) OAuth2ClientID

func (c *Config) OAuth2ClientID() string

OAuth2ClientID returns the OAuth2 Client ID.

func (*Config) OAuth2ClientSecret

func (c *Config) OAuth2ClientSecret() string

OAuth2ClientSecret returns the OAuth2 client secret.

func (*Config) OAuth2Provider

func (c *Config) OAuth2Provider() string

OAuth2Provider returns the name of the OAuth2 provider configured.

func (*Config) OAuth2RedirectURL

func (c *Config) OAuth2RedirectURL() string

OAuth2RedirectURL returns the OAuth2 redirect URL.

func (*Config) PollingFrequency

func (c *Config) PollingFrequency() int

PollingFrequency returns the interval to refresh feeds in the background.

func (*Config) RootURL

func (c *Config) RootURL() string

RootURL returns the base URL without path.

func (*Config) RunMigrations

func (c *Config) RunMigrations() bool

RunMigrations returns true if the environment variable RUN_MIGRATIONS is not empty.

func (*Config) SessionCleanupFrequency

func (c *Config) SessionCleanupFrequency() int

SessionCleanupFrequency returns the interval for session cleanup.

func (*Config) WorkerPoolSize

func (c *Config) WorkerPoolSize() int

WorkerPoolSize returns the number of background worker.