install

Documentation

Index

• Variables
• func AfterUpdateApply(context Context, willRestart bool, force bool, log Log) error
• func AutoInstall(context Context, _ string, _ bool, timeout time.Duration, log Log) (bool, error)
• func BinPath() (string, error)
• func CheckIfValidLocation() error
• func InstallLogPath() (string, error)
• func IsInUse(mountDir string, log Log) bool
• func KBFSBinPath(runMode libkb.RunMode, binPath string) (string, error)
• func KBFSBundleVersion(context Context, binPath string) (string, error)
• func ResolveInstallStatus(version string, bundleVersion string, lastExitStatus string, log Log) (installStatus keybase1.InstallStatus, installAction keybase1.InstallAction, ...)
• func RunApp(context Context, log Log) error
• func SystemLogPath() string
• func TerminateApp(context Context, log Log) error
• func UpdaterBinPath() (string, error)
• type ComponentName
  • func ComponentNameFromString(s string) ComponentName
  • func (c ComponentName) Description() string
  • func (c ComponentName) String() string
• type Context
• type Log

Variables

var ComponentNames = []ComponentName{ComponentNameCLI, ComponentNameService, ComponentNameKBFS, ComponentNameUpdater, ComponentNameFuse, ComponentNameHelper, ComponentNameApp, ComponentNameKBNM}

ComponentNames are all the valid component names

Functions

func AfterUpdateApply

func AfterUpdateApply(context Context, willRestart bool, force bool, log Log) error

func AutoInstall

func AutoInstall(context Context, _ string, _ bool, timeout time.Duration, log Log) (bool, error)

AutoInstall installs auto start on unix

func BinPath

func BinPath() (string, error)

BinPath returns path to the keybase executable

func CheckIfValidLocation

func CheckIfValidLocation() error

CheckIfValidLocation is not used on unix

func InstallLogPath

func InstallLogPath() (string, error)

func IsInUse

func IsInUse(mountDir string, log Log) bool

IsInUse returns true if the mount is in use. This may be used by the updater to determine if it's safe to apply an update and restart.

func KBFSBinPath

func KBFSBinPath(runMode libkb.RunMode, binPath string) (string, error)

KBFSBinPath returns the path to the KBFS executable

func KBFSBundleVersion

func KBFSBundleVersion(context Context, binPath string) (string, error)

KBFSBundleVersion returns the bundle (not installed) version for KBFS

func ResolveInstallStatus

func ResolveInstallStatus(version string, bundleVersion string, lastExitStatus string, log Log) (installStatus keybase1.InstallStatus, installAction keybase1.InstallAction, status keybase1.Status)

ResolveInstallStatus will determine necessary install actions for the current environment

func RunApp

func RunApp(context Context, log Log) error

RunApp starts the app

func SystemLogPath

func SystemLogPath() string

func TerminateApp

func TerminateApp(context Context, log Log) error

TerminateApp will stop the Keybase (UI) app

func UpdaterBinPath

func UpdaterBinPath() (string, error)

UpdaterBinPath returns the path to the updater executable, by default is in the same directory as the keybase executable.

Types

type ComponentName

type ComponentName string

ComponentName defines a component name

const (
	// ComponentNameCLI is the command line component
	ComponentNameCLI ComponentName = "cli"
	// ComponentNameService is the service component
	ComponentNameService ComponentName = "service"
	// ComponentNameKBFS is the KBFS component
	ComponentNameKBFS ComponentName = "kbfs"
	// ComponentNameKBNM is the Keybase NativeMessaging client component
	ComponentNameKBNM ComponentName = "kbnm"
	// ComponentNameUpdater is the updater component
	ComponentNameUpdater ComponentName = "updater"
	// ComponentNameApp is the UI app
	ComponentNameApp ComponentName = "app"
	// ComponentNameFuse is the Fuse component
	ComponentNameFuse ComponentName = "fuse"
	// ComponentNameHelper is the privileged helper tool
	ComponentNameHelper ComponentName = "helper"
	// ComponentNameMountDir is the mount directory
	ComponentNameMountDir ComponentName = "mountdir"
	// ComponentNameUnknown is placeholder for unknown components
	ComponentNameUnknown ComponentName = "unknown"
)

func ComponentNameFromString

func ComponentNameFromString(s string) ComponentName

ComponentNameFromString returns ComponentName from a string

func (ComponentName) Description

func (c ComponentName) Description() string

Description returns description for component name

func (ComponentName) String

func (c ComponentName) String() string

String returns string for ComponentName

type Context

type Context interface {
	GetConfigDir() string
	GetCacheDir() string
	GetRuntimeDir() string
	GetMountDir() (string, error)
	GetLogDir() string
	GetRunMode() libkb.RunMode
	GetServiceInfoPath() string
	GetKBFSInfoPath() string
}

Context is the enviroment for this package

type Log

type Log interface {
	Debug(s string, args ...interface{})
	Info(s string, args ...interface{})
	Warning(s string, args ...interface{})
	Errorf(s string, args ...interface{})
}

Log is the logging interface for this package