config

Documentation

Index

• Variables
• type Config
  • func NewConfig(cfg *config.Config) (*Config, error)
  • func (cfg *Config) AuthRepo(repo string, pk ssh.PublicKey) gm.AccessLevel
  • func (cfg *Config) Fetch(repo string, pk ssh.PublicKey)
  • func (cfg *Config) KeyboardInteractiveHandler(ctx ssh.Context, _ gossh.KeyboardInteractiveChallenge) bool
  • func (cfg *Config) PasswordHandler(ctx ssh.Context, password string) bool
  • func (cfg *Config) PublicKeyHandler(ctx ssh.Context, pk ssh.PublicKey) bool
  • func (cfg *Config) Push(repo string, pk ssh.PublicKey)
  • func (cfg *Config) Reload() error
• type MenuRepo
• type Repo
  • func (r *Repo) Commit(hash string) (*git.Commit, error)
  • func (r *Repo) CommitsByPage(ref *git.Reference, page, size int) (git.Commits, error)
  • func (r *Repo) CountCommits(ref *git.Reference) (int64, error)
  • func (r *Repo) Description() string
  • func (r *Repo) Diff(commit *git.Commit) (*git.Diff, error)
  • func (r *Repo) HEAD() (*git.Reference, error)
  • func (r *Repo) IsPrivate() bool
  • func (r *Repo) LatestFile(pattern string) (string, string, error)
  • func (r *Repo) Name() string
  • func (r *Repo) Path() string
  • func (r *Repo) Push(remote, branch string) error
  • func (r *Repo) Readme() (readme string, path string)
  • func (r *Repo) References() ([]*git.Reference, error)
  • func (r *Repo) Repo() string
  • func (r *Repo) SetReadme(readme, path string)
  • func (r *Repo) Tree(ref *git.Reference, path string) (*git.Tree, error)
  • func (r *Repo) UpdateServerInfo() error
• type RepoSource
  • func NewRepoSource(repoPath string) *RepoSource
  • func (rs *RepoSource) AllRepos() []*Repo
  • func (rs *RepoSource) GetRepo(name string) (*Repo, error)
  • func (rs *RepoSource) InitRepo(name string, bare bool) (*Repo, error)
  • func (rs *RepoSource) LoadRepo(name string) error
  • func (rs *RepoSource) LoadRepos() error
• type User

Variables

var ErrMissingRepo = errors.New("missing repo")

ErrMissingRepo indicates that the requested repository could not be found.

var (
	// ErrNoConfig is returned when no config file is found.
	ErrNoConfig = errors.New("no config file found")
)

Types

type Config

type Config struct {
	Name         string         `yaml:"name" json:"name"`
	Host         string         `yaml:"host" json:"host"`
	Port         int            `yaml:"port" json:"port"`
	AnonAccess   string         `yaml:"anon-access" json:"anon-access"`
	AllowKeyless bool           `yaml:"allow-keyless" json:"allow-keyless"`
	Users        []User         `yaml:"users" json:"users"`
	Repos        []MenuRepo     `yaml:"repos" json:"repos"`
	Source       *RepoSource    `yaml:"-" json:"-"`
	Cfg          *config.Config `yaml:"-" json:"-"`
	// contains filtered or unexported fields
}

Config is the Soft Serve configuration.

func NewConfig

func NewConfig(cfg *config.Config) (*Config, error)

NewConfig creates a new internal Config struct.

func (*Config) AuthRepo

func (cfg *Config) AuthRepo(repo string, pk ssh.PublicKey) gm.AccessLevel

AuthRepo grants repo authorization to the given key.

func (*Config) Fetch

func (cfg *Config) Fetch(repo string, pk ssh.PublicKey)

Fetch registers Git fetch functionality for the given repo and key.

func (*Config) KeyboardInteractiveHandler

func (cfg *Config) KeyboardInteractiveHandler(ctx ssh.Context, _ gossh.KeyboardInteractiveChallenge) bool

KeyboardInteractiveHandler returns whether or not keyboard interactive is allowed.

func (*Config) PasswordHandler

func (cfg *Config) PasswordHandler(ctx ssh.Context, password string) bool

PasswordHandler returns whether or not password access is allowed.

func (*Config) PublicKeyHandler

func (cfg *Config) PublicKeyHandler(ctx ssh.Context, pk ssh.PublicKey) bool

PublicKeyHandler returns whether or not the given public key may access the repo.

func (*Config) Push

func (cfg *Config) Push(repo string, pk ssh.PublicKey)

Push registers Git push functionality for the given repo and key.

func (*Config) Reload

func (cfg *Config) Reload() error

Reload reloads the configuration.

type MenuRepo

type MenuRepo struct {
	Name    string `yaml:"name" json:"name"`
	Repo    string `yaml:"repo" json:"repo"`
	Note    string `yaml:"note" json:"note"`
	Private bool   `yaml:"private" json:"private"`
	Readme  string `yaml:"readme" json:"readme"`
}

Repo contains repository configuration information.

type Repo

type Repo struct {
	// contains filtered or unexported fields
}

Repo represents a Git repository.

func (*Repo) Commit

func (r *Repo) Commit(hash string) (*git.Commit, error)

Commit returns the commit for a given hash.

func (*Repo) CommitsByPage

func (r *Repo) CommitsByPage(ref *git.Reference, page, size int) (git.Commits, error)

CommitsByPage returns the commits for a repository.

func (*Repo) CountCommits

func (r *Repo) CountCommits(ref *git.Reference) (int64, error)

CountCommits returns the number of commits for a repository.

func (*Repo) Description

func (r *Repo) Description() string

Description returns the description for a repository.

func (*Repo) Diff

func (r *Repo) Diff(commit *git.Commit) (*git.Diff, error)

Diff returns the diff for a given commit.

func (*Repo) HEAD

func (r *Repo) HEAD() (*git.Reference, error)

HEAD returns the reference for a repository.

func (*Repo) IsPrivate

func (r *Repo) IsPrivate() bool

IsPrivate returns true if the repository is private.

func (*Repo) LatestFile

func (r *Repo) LatestFile(pattern string) (string, string, error)

LatestFile returns the contents of the latest file at the specified path in the repository and its file path.

func (*Repo) Name

func (r *Repo) Name() string

Name returns the name of the repository.

func (*Repo) Path

func (r *Repo) Path() string

Path returns the path to the repository.

func (*Repo) Push

func (r *Repo) Push(remote, branch string) error

Push pushes the repository to the remote.

func (*Repo) Readme

func (r *Repo) Readme() (readme string, path string)

Readme returns the readme and its path for the repository.

func (*Repo) References

func (r *Repo) References() ([]*git.Reference, error)

GetReferences returns the references for a repository.

func (*Repo) Repo

func (r *Repo) Repo() string

Repo returns the repository directory name.

func (*Repo) SetReadme

func (r *Repo) SetReadme(readme, path string)

SetReadme sets the readme for the repository.

func (*Repo) Tree

func (r *Repo) Tree(ref *git.Reference, path string) (*git.Tree, error)

Tree returns the git tree for a given path.

func (*Repo) UpdateServerInfo

func (r *Repo) UpdateServerInfo() error

UpdateServerInfo updates the server info for the repository.

type RepoSource

type RepoSource struct {
	Path string
	// contains filtered or unexported fields
}

RepoSource is a reference to an on-disk repositories.

func NewRepoSource

func NewRepoSource(repoPath string) *RepoSource

NewRepoSource creates a new RepoSource.

func (*RepoSource) AllRepos

func (rs *RepoSource) AllRepos() []*Repo

AllRepos returns all repositories for the given RepoSource.

func (*RepoSource) GetRepo

func (rs *RepoSource) GetRepo(name string) (*Repo, error)

GetRepo returns a repository by name.

func (*RepoSource) InitRepo

func (rs *RepoSource) InitRepo(name string, bare bool) (*Repo, error)

InitRepo initializes a new Git repository.

func (*RepoSource) LoadRepo

func (rs *RepoSource) LoadRepo(name string) error

LoadRepo loads a repository from disk.

func (*RepoSource) LoadRepos

func (rs *RepoSource) LoadRepos() error

LoadRepos opens Git repositories.

type User

type User struct {
	Name        string   `yaml:"name" json:"name"`
	Admin       bool     `yaml:"admin" json:"admin"`
	PublicKeys  []string `yaml:"public-keys" json:"public-keys"`
	CollabRepos []string `yaml:"collab-repos" json:"collab-repos"`
}

User contains user-level configuration for a repository.