Documentation ¶
Index ¶
- Variables
- func SelfUpdate(ctx context.Context)
- type Config
- func (c *Config) AddFilterList(list FilterList) string
- func (c *Config) GetCAInstalled() bool
- func (c *Config) GetFilterLists() []FilterList
- func (c *Config) GetIgnoredHosts() []string
- func (c *Config) GetPort() int
- func (c *Config) GetVersion() string
- func (c *Config) RemoveFilterList(url string) string
- func (c *Config) RunMigrations()
- func (c *Config) Save() error
- func (c *Config) SetCAInstalled(caInstalled bool)
- func (c *Config) SetIgnoredHosts(hosts []string) error
- func (c *Config) SetPort(port int) string
- func (c *Config) ToggleFilterList(url string, enabled bool) string
- type FilterList
Constants ¶
This section is empty.
Variables ¶
var ( // ConfigDir is the path to the directory storing the application configuration. ConfigDir string // DataDir is the path to the directory storing the application data. DataDir string )
var Version = "development"
Version is the current version of the binary. Set at compile time using ldflags (see .github/workflows/build.yml).
Functions ¶
func SelfUpdate ¶
SelfUpdate checks for updates and prompts the user to update if there is one.
Types ¶
type Config ¶
type Config struct { sync.RWMutex Filter struct { FilterLists []FilterList `json:"filterLists"` } `json:"filter"` Certmanager struct { CAInstalled bool `json:"caInstalled"` } `json:"certmanager"` Proxy struct { Port int `json:"port"` IgnoredHosts []string `json:"ignoredHosts"` } `json:"proxy"` // contains filtered or unexported fields }
Config stores and manages the configuration for the application. Although all fields are public, this is only for use by the JSON marshaller. All access to the Config should be done through the exported methods.
func (*Config) AddFilterList ¶
func (c *Config) AddFilterList(list FilterList) string
AddFilterList adds a new filter list to the list of enabled filter lists.
func (*Config) GetCAInstalled ¶
GetCAInstalled returns whether the CA is installed.
func (*Config) GetFilterLists ¶
func (c *Config) GetFilterLists() []FilterList
GetFilterLists returns the list of enabled filter lists.
func (*Config) GetIgnoredHosts ¶ added in v0.4.0
GetIgnoredHosts returns the list of ignored hosts.
func (*Config) GetVersion ¶
func (*Config) RemoveFilterList ¶
RemoveFilterList removes a filter list from the list of enabled filter lists.
func (*Config) RunMigrations ¶
func (c *Config) RunMigrations()
RunMigrations runs the version-to-version migrations.
func (*Config) Save ¶
Save saves the config to disk. It is not thread-safe, and should only be called if the caller has a lock on the config.
func (*Config) SetCAInstalled ¶
SetCAInstalled sets whether the CA is installed.
func (*Config) SetIgnoredHosts ¶ added in v0.4.0
SetIgnoredHosts sets the list of ignored hosts.