hostinfo

Documentation

Overview

Package hostinfo answers questions about the host environment that Tailscale is running on.

Index

• Constants
• func DisabledEtcAptSource() bool
• func FirewallMode() string
• func GetOSVersion() string
• func IsNATLabGuestVM() bool
• func IsSELinuxEnforcing() bool
• func New() *tailcfg.Hostinfo
• func RegisterHostinfoNewHook(f func(*tailcfg.Hostinfo))
• func SetApp(v string)
• func SetDeviceModel(model string)
• func SetFirewallMode(v string)
• func SetOSVersion(v string)
• func SetPackage(v string)
• type EnvType
  • func GetEnvType() EnvType

Constants

const (
	KNative            = EnvType("kn")
	AWSLambda          = EnvType("lm")
	Heroku             = EnvType("hr")
	AzureAppService    = EnvType("az")
	AWSFargate         = EnvType("fg")
	FlyDotIo           = EnvType("fly")
	Kubernetes         = EnvType("k8s")
	DockerDesktop      = EnvType("dde")
	Replit             = EnvType("repl")
	HomeAssistantAddOn = EnvType("haao")
)

Functions

func DisabledEtcAptSource

func DisabledEtcAptSource() bool

DisabledEtcAptSource reports whether Ubuntu (or similar) has disabled the /etc/apt/sources.list.d/tailscale.list file contents upon upgrade to a new release of the distro.

See https://github.com/tailscale/tailscale/issues/3177

func FirewallMode

func FirewallMode() string

FirewallMode returns the firewall mode for the app. It is empty if unset.

func GetOSVersion

func GetOSVersion() string

GetOSVersion returns the OSVersion of current host if available.

func IsNATLabGuestVM

func IsNATLabGuestVM() bool

IsNATLabGuestVM reports whether the current host is a NAT Lab guest VM.

func IsSELinuxEnforcing

func IsSELinuxEnforcing() bool

IsSELinuxEnforcing reports whether SELinux is in "Enforcing" mode.

func New

func New() *tailcfg.Hostinfo

New returns a partially populated Hostinfo for the current host.

func RegisterHostinfoNewHook

func RegisterHostinfoNewHook(f func(*tailcfg.Hostinfo))

RegisterHostinfoNewHook registers a callback to be called on a non-nil tailcfg.Hostinfo before it is returned by New.

func SetApp

func SetApp(v string)

SetApp sets the app type for the app. It is used by tsnet to specify what app is using it such as "golinks" and "k8s-operator".

func SetDeviceModel

func SetDeviceModel(model string)

SetDeviceModel sets the device model for use in Hostinfo updates.

func SetFirewallMode

func SetFirewallMode(v string)

SetFirewallMode sets the firewall mode for the app.

func SetOSVersion

func SetOSVersion(v string)

SetOSVersion sets the OS version.

func SetPackage

func SetPackage(v string)

SetPackage sets the packaging type for the app.

For Android, the possible values are: - "googleplay": installed from Google Play Store. - "fdroid": installed from the F-Droid repository. - "amazon": installed from the Amazon Appstore. - "unknown": when the installer package name is null. - "unknown$installerPackageName": for unrecognized installer package names, prefixed by "unknown". Additionally, tsnet sets this value to "tsnet".

Types

type EnvType

type EnvType string

EnvType represents a known environment type. The empty string, the default, means unknown.

func GetEnvType

func GetEnvType() EnvType