home

package

v0.107.48 Latest Latest Go to latest Published: Apr 5, 2024 License: GPL-3.0 Imports: 84 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/AdguardTeam/AdGuardHome

Links

Open Source Insights

Documentation ¶

Rendered for

Overview ¶

Package home contains AdGuard Home's HTTP API methods.

Index ¶

Constants
Variables
func Main(clientBuildFS fs.FS)
func RegisterAuthHandlers()
type Auth
- func InitAuth(dbFilename string, users []webUser, sessionTTL uint32, ...) (a *Auth)
- func (a *Auth) Close()
type DHCP
type Theme
- func (t *Theme) UnmarshalText(b []byte) (err error)

Constants ¶

View Source

const MaxFileSize = 1024 * 1024

MaxFileSize is a maximum file length in bytes.

View Source

const PasswordMinRunes = 8

PasswordMinRunes is the minimum length of user's password in runes.

Variables ¶

View Source

var Context homeContext

Context - a global context object

View Source

var GLMode bool

GLMode - enable GL-Inet compatibility mode

Functions ¶

func Main ¶

func Main(clientBuildFS fs.FS)

Main is the entry point

func RegisterAuthHandlers ¶

func RegisterAuthHandlers()

RegisterAuthHandlers - register handlers

Types ¶

type Auth ¶

type Auth struct {
	// contains filtered or unexported fields
}

Auth is the global authentication object.

func InitAuth ¶

func InitAuth(
	dbFilename string,
	users []webUser,
	sessionTTL uint32,
	rateLimiter *authRateLimiter,
	trustedProxies netutil.SubnetSet,
) (a *Auth)

InitAuth initializes the global authentication object.

func (*Auth) Close ¶

func (a *Auth) Close()

Close closes the authentication database.

type DHCP ¶ added in v0.107.33

type DHCP interface {
	// Leases returns all the DHCP leases.
	Leases() (leases []*dhcpsvc.Lease)

	// HostByIP returns the hostname of the DHCP client with the given IP
	// address.  The address will be netip.Addr{} if there is no such client,
	// due to an assumption that a DHCP client must always have a hostname.
	HostByIP(ip netip.Addr) (host string)

	// MACByIP returns the MAC address for the given IP address leased.  It
	// returns nil if there is no such client, due to an assumption that a DHCP
	// client must always have a MAC address.
	MACByIP(ip netip.Addr) (mac net.HardwareAddr)
}

DHCP is an interface for accessing DHCP lease data the [clientsContainer] needs.

type Theme ¶ added in v0.107.22

type Theme string

Theme is an enum of all allowed UI themes.

const (
	ThemeAuto  Theme = "auto"
	ThemeLight Theme = "light"
	ThemeDark  Theme = "dark"
)

Allowed Theme values.

Keep in sync with client/src/helpers/constants.js.

func (*Theme) UnmarshalText ¶ added in v0.107.22

func (t *Theme) UnmarshalText(b []byte) (err error)

UnmarshalText implements encoding.TextUnmarshaler interface for *Theme.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL