home

Documentation

Overview

Package home contains AdGuard Home's HTTP API methods.

Index

• Constants
• func Main(clientBuildFS fs.FS)
• type BlockedClientChecker
• type Theme
  • func (t *Theme) UnmarshalText(b []byte) (err error)

Constants

const MaxFileSize = 1024 * 1024

MaxFileSize is a maximum file length in bytes.

const PasswordMinRunes = 8

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

Functions

func Main

func Main(clientBuildFS fs.FS)

Main is the entry point

Types

type BlockedClientChecker

type BlockedClientChecker interface {
	// TODO(s.chzhen):  Accept [client.FindParams].
	IsBlockedClient(ip netip.Addr, clientID string) (blocked bool, rule string)
}

BlockedClientChecker checks if a client is blocked by the current access settings.

type Theme

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.ts.

func (*Theme) UnmarshalText

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

UnmarshalText implements encoding.TextUnmarshaler interface for *Theme.