config

Documentation

Index

• Variables
• type Config
  • func NewFromDir(dir string) (*Config, error)
  • func NewFromDirExternal(dir string) (*Config, error)
  • func (c *Config) ApplyGlobalState()
  • func (c *Config) HTTPClient() (*client.HTTPClient, error)
  • func (cfg *Config) IsSane() error
• type GSSAPIConfig
• type HttpSettingsConfig
• type LFSConfig
• type PATConfig
• type ServerConfig
• type YamlDuration
  • func (d *YamlDuration) UnmarshalYAML(unmarshal func(interface{}) error) error

Variables

var (
	DefaultConfig = Config{
		LogFile:   "gitlab-shell.log",
		LogFormat: "json",
		LogLevel:  "info",
		Server:    DefaultServerConfig,
		User:      "git",
		PATConfig: DefaultPATConfig,
	}

	DefaultServerConfig = ServerConfig{
		Listen:                  "[::]:22",
		WebListen:               "localhost:9122",
		ConcurrentSessionsLimit: 10,
		GracePeriod:             YamlDuration(10 * time.Second),
		ClientAliveInterval:     YamlDuration(15 * time.Second),
		ProxyHeaderTimeout:      YamlDuration(500 * time.Millisecond),
		LoginGraceTime:          YamlDuration(60 * time.Second),
		ReadinessProbe:          "/start",
		LivenessProbe:           "/health",
		HostKeyFiles: []string{
			"/run/secrets/ssh-hostkeys/ssh_host_rsa_key",
			"/run/secrets/ssh-hostkeys/ssh_host_ecdsa_key",
			"/run/secrets/ssh-hostkeys/ssh_host_ed25519_key",
		},
	}

	DefaultPATConfig = PATConfig{
		Enabled: true,
	}
)

The defaults to apply before parsing the config file(s).

Types

type Config

type Config struct {
	User                  string `yaml:"user,omitempty"`
	RootDir               string
	LogFile               string `yaml:"log_file,omitempty"`
	LogFormat             string `yaml:"log_format,omitempty"`
	LogLevel              string `yaml:"log_level,omitempty"`
	GitlabUrl             string `yaml:"gitlab_url"`
	GitlabRelativeURLRoot string `yaml:"gitlab_relative_url_root"`
	GitlabTracing         string `yaml:"gitlab_tracing"`
	// SecretFilePath is only for parsing. Application code should always use Secret.
	SecretFilePath string             `yaml:"secret_file"`
	Secret         string             `yaml:"secret"`
	SslCertDir     string             `yaml:"ssl_cert_dir"`
	HttpSettings   HttpSettingsConfig `yaml:"http_settings"`
	Server         ServerConfig       `yaml:"sshd"`
	LFSConfig      LFSConfig          `yaml:"lfs"`
	PATConfig      PATConfig          `yaml:"pat"`

	GitalyClient gitaly.Client
	// contains filtered or unexported fields
}

func NewFromDir

func NewFromDir(dir string) (*Config, error)

NewFromDir returns a new config given a root directory. It looks for the config file name in the given directory and reads the config from it. It doesn't apply any defaults. New code should prefer this over NewFromDirIntegrated and apply the right default via one of the Apply... functions.

func NewFromDirExternal

func NewFromDirExternal(dir string) (*Config, error)

NewFromDirExternal returns a new config from a given root dir. It also applies defaults appropriate for gitlab-shell running in an external SSH server.

func (*Config) ApplyGlobalState

func (c *Config) ApplyGlobalState()

func (*Config) HTTPClient

func (c *Config) HTTPClient() (*client.HTTPClient, error)

func (*Config) IsSane

func (cfg *Config) IsSane() error

IsSane checks if the given config fulfills the minimum requirements to be able to run. Any error returned by this function should be a startup error. On the other hand if this function returns nil, this doesn't guarantee the config will work, but it's at least worth a try.

type GSSAPIConfig

type GSSAPIConfig struct {
	Enabled              bool   `yaml:"enabled,omitempty"`
	Keytab               string `yaml:"keytab,omitempty"`
	ServicePrincipalName string `yaml:"service_principal_name,omitempty"`
	LibPath              string
}

type HttpSettingsConfig

type HttpSettingsConfig struct {
	User               string `yaml:"user"`
	Password           string `yaml:"password"`
	ReadTimeoutSeconds uint64 `yaml:"read_timeout"`
	CaFile             string `yaml:"ca_file"`
	CaPath             string `yaml:"ca_path"`
}

type LFSConfig

type LFSConfig struct {
	PureSSHProtocol bool `yaml:"pure_ssh_protocol"`
}

type PATConfig

type PATConfig struct {
	Enabled       bool     `yaml:"enabled,omitempty"`
	AllowedScopes []string `yaml:"allowed_scopes,omitempty"`
}

type ServerConfig

type ServerConfig struct {
	Listen                  string       `yaml:"listen,omitempty"`
	ProxyProtocol           bool         `yaml:"proxy_protocol,omitempty"`
	ProxyPolicy             string       `yaml:"proxy_policy,omitempty"`
	ProxyAllowed            []string     `yaml:"proxy_allowed,omitempty"`
	WebListen               string       `yaml:"web_listen,omitempty"`
	ConcurrentSessionsLimit int64        `yaml:"concurrent_sessions_limit,omitempty"`
	ClientAliveInterval     YamlDuration `yaml:"client_alive_interval,omitempty"`
	GracePeriod             YamlDuration `yaml:"grace_period"`
	ProxyHeaderTimeout      YamlDuration `yaml:"proxy_header_timeout"`
	LoginGraceTime          YamlDuration `yaml:"login_grace_time"`
	ReadinessProbe          string       `yaml:"readiness_probe"`
	LivenessProbe           string       `yaml:"liveness_probe"`
	HostKeyFiles            []string     `yaml:"host_key_files,omitempty"`
	HostCertFiles           []string     `yaml:"host_cert_files,omitempty"`
	MACs                    []string     `yaml:"macs"`
	KexAlgorithms           []string     `yaml:"kex_algorithms"`
	PublicKeyAlgorithms     []string     `yaml:"public_key_algorithms"`
	Ciphers                 []string     `yaml:"ciphers"`
	GSSAPI                  GSSAPIConfig `yaml:"gssapi,omitempty"`
}

type YamlDuration

type YamlDuration time.Duration

func (*YamlDuration) UnmarshalYAML

func (d *YamlDuration) UnmarshalYAML(unmarshal func(interface{}) error) error