install

package
v1.0.39 Latest Latest
Warning

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

 Go to latest Published: Dec 21, 2017 License: BSD-3-Clause, BSD-3-Clause Imports: 18 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

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

ComponentNames are all the valid component names

Functions

func AfterUpdateApply added in v1.0.17 

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 added in v1.0.17 

func BinPath() (string, error)

BinPath returns path to the keybase executable

func CheckIfValidLocation 

func CheckIfValidLocation() error

CheckIfValidLocation is not used on unix

func Install added in v1.0.29 

func Install(context Context, binPath string, sourcePath string, components []string, force bool, timeout time.Duration, log Log) keybase1.InstallResult

Install empty implementation for unsupported platforms

func InstallLogPath added in v1.0.18 

func InstallLogPath() (string, error)

func IsInUse added in v1.0.16 

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 added in v1.0.17 

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 KeybaseFuseStatus added in v1.0.29 

func KeybaseFuseStatus(bundleVersion string, log Log) keybase1.FuseStatus

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 added in v1.0.17 

func RunApp(context Context, log Log) error

RunApp starts the app

func SystemLogPath added in v1.0.18 

func SystemLogPath() string

func TerminateApp added in v1.0.17 

func TerminateApp(context Context, log Log) error

TerminateApp will stop the Keybase (UI) app

func Uninstall added in v1.0.29 

func Uninstall(context Context, components []string, log Log) keybase1.UninstallResult

Uninstall empty implementation for unsupported platforms

func UpdaterBinPath added in v1.0.17 

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"
	// ComponentNameCLIPaths is for /etc/paths.d/Keybase
	ComponentNameCLIPaths ComponentName = "clipaths"
	// 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 added in v1.0.17 

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 added in v1.0.17 

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

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.