files

Documentation

Overview

Package files centralises location paths used in Qubesome.

Key locations: - ~/.qubesome: default location for persistent files. - ~/.qubesome/images-last-checked: file that stores when images were last checked. - /run/user/%d/qubesome: root of ephemeral files. - /run/user/%d/qubesome/git/<git-url>/<path>: where git repositories are cloned to.

Index

• Constants
• Variables
• func ClientCookiePath(profile string) (string, error)
• func ContainerRunnerBinary(runner string) string
• func GitDirPath(url string) (string, error)
• func GitRoot() string
• func ImagesLastCheckedPath() string
• func InProfileSocketPath() string
• func IsolatedRunUserPath(profile string) (string, error)
• func ProfileConfig(profile string) string
• func ProfileDir(profile string) string
• func QubesomeConfig() string
• func QubesomeDir() string
• func RunUserQubesome() string
• func ServerCookiePath(profile string) (string, error)
• func SocketPath(profile string) (string, error)
• func WorkloadsDir(root, path string) (string, error)

Constants

const (
	ShBinary          = "/bin/sh"
	XclipBinary       = "/usr/bin/xclip"
	FireCrackerBinary = "/usr/bin/firecracker"
	XrandrBinary      = "/usr/bin/xrandr"
	DbusBinary        = "/usr/bin/dbus-send"
	PodmanBinary      = "/usr/bin/podman"
	DockerBinary      = "/usr/bin/docker"
)

const (
	FileMode = 0o600
	DirMode  = 0o700
)

Variables

var (
	// ErrUnableGetSocketPath is an error returned when unable to get the socket path for a profile.
	ErrUnableGetSocketPath = errors.New("unable to get socket path for profile")
)

Functions

func ClientCookiePath

func ClientCookiePath(profile string) (string, error)

ClientCookiePath returns the path to the client cookie file for the given profile.

func ContainerRunnerBinary

func ContainerRunnerBinary(runner string) string

func GitDirPath

func GitDirPath(url string) (string, error)

GitDirPath returns the path to the git directory for the given URL.

func GitRoot

func GitRoot() string

GitRoot returns the root directory for git repositories.

func ImagesLastCheckedPath

func ImagesLastCheckedPath() string

ImagesLastCheckedPath returns the file path for the file that records when images where last checked.

func InProfileSocketPath

func InProfileSocketPath() string

InProfileSocketPath returns the path to the socket when running inside the profile container.

func IsolatedRunUserPath

func IsolatedRunUserPath(profile string) (string, error)

func ProfileConfig

func ProfileConfig(profile string) string

ProfileConfig returns the profile config file path. This will be a symlink to the actual profile which is sourced within the Git repository.

func ProfileDir

func ProfileDir(profile string) string

func QubesomeConfig

func QubesomeConfig() string

QubesomeConfig returns the default qubesome config file path.

func QubesomeDir

func QubesomeDir() string

QubesomeDir returns the root directory where Qubesome configuration is stored.

func RunUserQubesome

func RunUserQubesome() string

RunUserQubesome returns the path to the user-specific qubesome directory.

func ServerCookiePath

func ServerCookiePath(profile string) (string, error)

ServerCookiePath returns the path to the server cookie file for the given profile.

func SocketPath

func SocketPath(profile string) (string, error)

SocketPath returns the path to the socket file for the given profile.

func WorkloadsDir

func WorkloadsDir(root, path string) (string, error)

WorkloadsDir returns the workloads directory path for a given Qubesome profile.