install

Documentation

Index

• Variables
• func AutoInstall(g *libkb.GlobalContext, binPath string, force bool) (newProc bool, err error)
• func AutoInstallWithStatus(g *libkb.GlobalContext, binPath string, force bool) keybase1.InstallResult
• func CheckIfValidLocation() *keybase1.Error
• func DefaultKBFSLabel(runMode libkb.RunMode) string
• func DefaultLaunchdEnvVars(label string) []launchd.EnvVar
• func DefaultServiceLabel(runMode libkb.RunMode) string
• func Install(g *libkb.GlobalContext, binPath string, components []string, force bool) keybase1.InstallResult
• func IsInUse(mountDir string, log logger.Logger) bool
• func KBFSBundleVersion(context Context, binPath string) (string, error)
• func KBFSServiceStatus(g *libkb.GlobalContext, label string) (status keybase1.ServiceStatus)
• func KeybaseFuseStatus(bundleVersion string, log logger.Logger) keybase1.FuseStatus
• func KeybaseFuseStatusForAppBundle(appPath string, log logger.Logger) (keybase1.FuseStatus, error)
• func KeybaseServiceStatus(g *libkb.GlobalContext, label string) (status keybase1.ServiceStatus)
• func ListServices(g *libkb.GlobalContext) (*keybase1.ServicesStatus, error)
• func NewInstallResult(componentResults []keybase1.ComponentResult) keybase1.InstallResult
• func NewUninstallResult(componentResults []keybase1.ComponentResult) keybase1.UninstallResult
• func OSVersion() (semver.Version, error)
• func ResolveInstallStatus(version string, bundleVersion string, lastExitStatus string) (installStatus keybase1.InstallStatus, installAction keybase1.InstallAction, ...)
• func RunAfterStartup(g *libkb.GlobalContext, isService bool) error
• func ServiceStatus(g *libkb.GlobalContext, label ServiceLabel) (*keybase1.ServiceStatus, error)
• func Uninstall(g *libkb.GlobalContext, components []string) keybase1.UninstallResult
• func UninstallKBFS(runMode libkb.RunMode, mountDir string, log logger.Logger) error
• type ComponentName
  • func ComponentNameFromString(s string) ComponentName
  • func (c ComponentName) String() string
• type Context
• type ServiceLabel
  • func NewServiceLabel(s string) (ServiceLabel, error)
  • func (l ServiceLabel) ComponentName() ComponentName

Variables

var ComponentNames = []ComponentName{ComponentNameCLI, ComponentNameService, ComponentNameKBFS, ComponentNameUpdater}

Functions

func AutoInstall

func AutoInstall(g *libkb.GlobalContext, binPath string, force bool) (newProc bool, err error)

func AutoInstallWithStatus

func AutoInstallWithStatus(g *libkb.GlobalContext, binPath string, force bool) keybase1.InstallResult

func CheckIfValidLocation

func CheckIfValidLocation() *keybase1.Error

func DefaultKBFSLabel

func DefaultKBFSLabel(runMode libkb.RunMode) string

func DefaultLaunchdEnvVars

func DefaultLaunchdEnvVars(label string) []launchd.EnvVar

func DefaultServiceLabel

func DefaultServiceLabel(runMode libkb.RunMode) string

func Install

func Install(g *libkb.GlobalContext, binPath string, components []string, force bool) keybase1.InstallResult

func IsInUse

func IsInUse(mountDir string, log logger.Logger) 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 KBFSBundleVersion

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

func KBFSServiceStatus

func KBFSServiceStatus(g *libkb.GlobalContext, label string) (status keybase1.ServiceStatus)

func KeybaseFuseStatus

func KeybaseFuseStatus(bundleVersion string, log logger.Logger) keybase1.FuseStatus

func KeybaseFuseStatusForAppBundle

func KeybaseFuseStatusForAppBundle(appPath string, log logger.Logger) (keybase1.FuseStatus, error)

func KeybaseServiceStatus

func KeybaseServiceStatus(g *libkb.GlobalContext, label string) (status keybase1.ServiceStatus)

func ListServices

func ListServices(g *libkb.GlobalContext) (*keybase1.ServicesStatus, error)

func NewInstallResult

func NewInstallResult(componentResults []keybase1.ComponentResult) keybase1.InstallResult

func NewUninstallResult

func NewUninstallResult(componentResults []keybase1.ComponentResult) keybase1.UninstallResult

func OSVersion

func OSVersion() (semver.Version, error)

func ResolveInstallStatus

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

func RunAfterStartup

func RunAfterStartup(g *libkb.GlobalContext, isService bool) error

func ServiceStatus

func ServiceStatus(g *libkb.GlobalContext, label ServiceLabel) (*keybase1.ServiceStatus, error)

func Uninstall

func Uninstall(g *libkb.GlobalContext, components []string) keybase1.UninstallResult

func UninstallKBFS

func UninstallKBFS(runMode libkb.RunMode, mountDir string, log logger.Logger) error

UninstallKBFS uninstalls all KBFS services and unmounts the directory

Types

type ComponentName

type ComponentName string

const (
	ComponentNameCLI     ComponentName = "cli"
	ComponentNameService ComponentName = "service"
	ComponentNameKBFS    ComponentName = "kbfs"
	ComponentNameUpdater ComponentName = "updater"
	ComponentNameUnknown ComponentName = "unknown"
)

func ComponentNameFromString

func ComponentNameFromString(s string) ComponentName

func (ComponentName) String

func (c ComponentName) String() string

type Context

type Context interface {
	GetCacheDir() string
	GetRuntimeDir() string
	GetRunMode() libkb.RunMode
}

type ServiceLabel

type ServiceLabel string

ServiceLabel is an identifier string for a service

const (
	// AppServiceLabel is the service label for the keybase launchd service in Keybase.app
	AppServiceLabel ServiceLabel = "keybase.service"
	// AppKBFSLabel is the service label for the kbfs launchd service in Keybase.app
	AppKBFSLabel ServiceLabel = "keybase.kbfs"
	// AppUpdaterLabel is the service label for the updater launchd service in Keybase.app
	AppUpdaterLabel ServiceLabel = "keybase.updater"
	// BrewServiceLabel is the service label for the updater launchd service in homebrew
	BrewServiceLabel ServiceLabel = "homebrew.mxcl.keybase"
	// BrewKBFSLabel is the service label for the kbfs launchd service in homebrew
	BrewKBFSLabel ServiceLabel = "homebrew.mxcl.kbfs"
	// UnknownLabel is an empty/unknown label
	UnknownLabel ServiceLabel = ""
)

func NewServiceLabel

func NewServiceLabel(s string) (ServiceLabel, error)

func (ServiceLabel) ComponentName

func (l ServiceLabel) ComponentName() ComponentName