install

package

v0.0.0-...-a8b6a46 Latest Latest Go to latest Published: Jun 7, 2020 License: BSD-3-Clause, BSD-3-Clause Imports: 16 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/fiersk17/f3keybase.md

Links

Open Source Insights

Documentation ¶

Rendered for

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 Install(context Context, binPath string, sourcePath string, components []string, ...) keybase1.InstallResult
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 KeybaseFuseStatus(bundleVersion string, log Log) keybase1.FuseStatus
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 Uninstall(context Context, components []string, log Log) keybase1.UninstallResult
func UpdaterBinPath() (string, error)
func WatchdogLogPath(string) (string, error)
type ComponentName
- func ComponentNameFromString(s string) ComponentName
- func (c ComponentName) Description() string
- func (c ComponentName) String() string
type Context
type Log

Constants ¶

This section is empty.

Variables ¶

View Source

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

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 Install ¶

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 ¶

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 KeybaseFuseStatus ¶

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 ¶

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 Uninstall ¶

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

Uninstall empty implementation for unsupported platforms

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.

func WatchdogLogPath ¶

func WatchdogLogPath(string) (string, error)

WatchdogLogPath doesn't exist on linux as an independent log file

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"
	// ComponentNameRedirector is the KBFS redirector
	ComponentNameRedirector ComponentName = "redirector"
	// 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 environment 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

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
libnativeinstaller

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