config

Documentation

Index

• func FirstNonEmpty(s ...string) string
• func NewFileLogger(path string) (*slog.Logger, func() error, error)
• type Address
• type Client
• type Command
• type Configuration
  • func Configure(options ...Option) (Configuration, error)
  • func (c *Configuration) InContainer() bool
  • func (c *Configuration) UnmarshalJSON(b []byte) error
• type Container
• type Option
  • func WithIsClient() Option
  • func WithVersion(version string) Option
• type Server
• type User

Functions

func FirstNonEmpty

func FirstNonEmpty(s ...string) string

func NewFileLogger

func NewFileLogger(path string) (*slog.Logger, func() error, error)

NewFileLogger creates a new logger that writes to a file.

Types

type Address

type Address struct {
	Path            string      `json:"path,omitempty"`
	Dir             string      `json:"dir,omitempty"`
	Name            string      `json:"name,omitempty"`
	DirPermissions  os.FileMode `json:"dirPermissions,omitempty"`
	FilePermissions os.FileMode `json:"filePermissions,omitempty"`
}

Address contains address confiuration.

type Client

type Client struct {
	ID           string `json:"-"`
	StderrBuffer bool   `json:"stderrBuffer,omitempty"`
}

Client holds client configuration.

type Command

type Command struct{}

Command contains configuration for commands.

type Configuration

type Configuration struct {
	Address       Address            `json:"address,omitzero"`
	Server        Server             `json:"server,omitzero"`
	Client        Client             `json:"client,omitzero"`
	Commands      map[string]Command `json:"commands,omitempty"`
	WorkspaceRoot string             `json:"workspaceRoot,omitempty"`
	Version       string             `json:"-"`
	ConfigDir     string             `json:"-"`
	// contains filtered or unexported fields
}

Configuration holds configuration for both client and server.

func Configure

func Configure(options ...Option) (Configuration, error)

Configure creates and returns a new Configuration.

func (*Configuration) InContainer

func (c *Configuration) InContainer() bool

InContainer checks wether it is configured within a container.

func (*Configuration) UnmarshalJSON

func (c *Configuration) UnmarshalJSON(b []byte) error

type Container

type Container struct {
	Env      map[string]string `json:"env,omitempty"`
	Volumes  map[string]string `json:"volumes,omitempty"`
	User     User              `json:"user,omitzero"`
	Image    string            `json:"image,omitempty"`
	Template string            `json:"template,omitempty"`
	EnvFile  string            `json:"envFile,omitempty"`
	CPUs     float64           `json:"cpus,omitempty"`
	Memory   string            `json:"memory,omitempty"`
	Enable   bool              `json:"enable,omitempty"`
}

Container contains server container configuration.

type Option

type Option func(c *Configuration)

Option contains options for configuration.

func WithIsClient

func WithIsClient() Option

WithIsClient sets if the configuration is for the client.

func WithVersion

func WithVersion(version string) Option

WithVersion sets the version for the configuration.

type Server

type Server struct {
	Container Container `json:"container,omitzero"`
}

Server contains server configuration.

type User

type User struct {
	Username string `json:"username"`
	HomeDir  string `json:"homeDir,omitempty"`
	UID      string `json:"uid,omitempty"`
	GID      string `json:"gid,omitempty"`
}