config

package
v0.0.13 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 22, 2025 License: AGPL-3.0-or-later Imports: 2 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// TLSMinVersion is the minimum required version of TLS.
	TLSMinVersion = tls.VersionTLS13
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AuthMode added in v0.0.13

type AuthMode string

AuthMode defines the authentication mode for the API.

const (
	AuthModeAuto  AuthMode = "auto"
	AuthModeNone  AuthMode = "none"
	AuthModeToken AuthMode = "token"
)

type Config

type Config struct {
	ListenAddr          string
	Host                string
	TLS                 *TLS
	AuthMode            AuthMode
	InsecureAllowNoAuth bool // DANGER: no authentication even for non-loopback addresses.
	InDocker            bool
	Debug               bool // deprecated
	DataDir             string
	LogFile             LogFile
	Sources             Sources
	ImageNameFFMPEG     string
}

Config holds the configuration for the application.

type LogFile

type LogFile struct {
	Enabled bool
	Path    string
	// contains filtered or unexported fields
}

LogFile holds the configuration for the log file.

func (LogFile) GetPath added in v0.0.4

func (l LogFile) GetPath() string

GetPath returns the path to the log file. If the path is not set, it returns the default log path.

type MediaServerSource added in v0.0.8

type MediaServerSource struct {
	ImageName string // ImageName is the Docker image of the MediaMTX server.
	StreamKey string
	RTMP      RTMPSource
	RTMPS     RTMPSource
}

MediaServerSource holds the configuration for the media server source.

type NetAddr added in v0.0.8

type NetAddr struct {
	IP   string
	Port int
}

NetAddr holds an IP and/or port.

type RTMPSource

type RTMPSource struct {
	Enabled bool

	NetAddr
}

RTMPSource holds the configuration for the RTMP source.

type Sources

type Sources struct {
	MediaServer MediaServerSource
}

Sources holds the configuration for the sources.

type TLS added in v0.0.8

type TLS struct {
	CertPath string
	KeyPath  string
}

TLS holds the TLS configuration.

Jump to

Keyboard shortcuts

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