Documentation
¶
Overview ¶
Package home contains AdGuard Home's HTTP API methods.
Index ¶
Constants ¶
const ( ClientSourceWHOIS clientSource = iota ClientSourceRDNS ClientSourceDHCP ClientSourceARP ClientSourceHostsFile )
Client sources. The order determines the priority.
const ( // ReadTimeout is the maximum duration for reading the entire request, // including the body. ReadTimeout = 10 * time.Second // ReadHeaderTimeout is the amount of time allowed to read request // headers. ReadHeaderTimeout = 10 * time.Second // WriteTimeout is the maximum duration before timing out writes of the // response. WriteTimeout = 10 * time.Second )
const MaxConnReadSize = 64 * 1024
MaxConnReadSize is an upper limit in bytes for reading from net.Conn.
const MaxFileSize = 1024 * 1024
MaxFileSize is a maximum file length in bytes.
const RequestBodySizeLimit = 64 * 1024
RequestBodySizeLimit is maximum request body length in bytes.
Variables ¶
var Context homeContext
Context - a global context object
var GLMode bool
GLMode - enable GL-Inet compatibility mode
Functions ¶
func StartMods ¶
func StartMods() error
StartMods initializes and starts the DNS server after installation.
func WebCheckPortAvailable ¶
WebCheckPortAvailable - check if port is available BUT: if we are already using this port, no need
Types ¶
type Auth ¶
type Auth struct {
// contains filtered or unexported fields
}
Auth - global object
func (*Auth) AuthRequired ¶
AuthRequired - if authentication is required
func (*Auth) RemoveSession ¶
RemoveSession - remove session
type Client ¶
type Client struct {
IDs []string
Tags []string
Name string
UseOwnSettings bool // false: use global settings
FilteringEnabled bool
SafeSearchEnabled bool
SafeBrowsingEnabled bool
ParentalEnabled bool
UseOwnBlockedServices bool // false: use global settings
BlockedServices []string
Upstreams []string // list of upstream servers to be used for the client's requests
// contains filtered or unexported fields
}
Client contains information about persistent clients.
type ClientHost ¶
type ClientHost struct {
Host string
Source clientSource
WhoisInfo [][]string // [[key,value], ...]
}
ClientHost information
type Filtering ¶
type Filtering struct {
// contains filtered or unexported fields
}
Filtering - module object
func (*Filtering) RegisterFilteringHandlers ¶
func (f *Filtering) RegisterFilteringHandlers()
RegisterFilteringHandlers - register handlers
type HTTPSServer ¶
type HTTPSServer struct {
// contains filtered or unexported fields
}
HTTPSServer - HTTPS Server
type RDNS ¶
type RDNS struct {
// contains filtered or unexported fields
}
RDNS - module context
func InitRDNS ¶
func InitRDNS(dnsServer *dnsforward.Server, clients *clientsContainer) *RDNS
InitRDNS - create module context
type TLSMod ¶
type TLSMod struct {
// contains filtered or unexported fields
}
TLSMod - TLS module object
func (*TLSMod) Reload ¶
func (t *TLSMod) Reload()
Reload updates the configuration of TLSMod and restarts it.
func (*TLSMod) Start ¶
func (t *TLSMod) Start()
Start updates the configuration of TLSMod and starts it.
func (*TLSMod) WriteDiskConfig ¶
func (t *TLSMod) WriteDiskConfig(conf *tlsConfigSettings)
WriteDiskConfig - write config
Source Files