cmd

Documentation

Index

• Variables
• func NewRootCmd() (cmd *cobra.Command)
• type Build
  • func (b Build) ContainerLabels() (labels map[string]string)
  • func (b Build) State() string
  • func (b Build) States() []string
  • func (b Build) XFlags() []string
• type Docker
  • func (d *Docker) Build(tag, dockerfile, target string, buildMetaData *Build) error
  • func (d *Docker) Login(username, password, registry string) error
  • func (d *Docker) Manifest(tags []string) error
  • func (d *Docker) PublishReadme() error
  • func (d *Docker) Tag(image, tag string) error
• type DockerImage
  • func (d DockerImage) Match(platform string) bool
• type DockerImages
• type HostEntry

Variables

var DockerImageName = "authelia/authelia"

DockerImageName the official name of Authelia docker image.

var ErrNoRunningSuite = errors.New("no running suite")

ErrNoRunningSuite error raised when no suite is running.

var ErrNotAvailableSuite = errors.New("unavailable suite")

ErrNotAvailableSuite error raised when suite is not available.

var IntermediateDockerImageName = "authelia:dist"

IntermediateDockerImageName local name of the docker image.

var OutputDir = "dist"

OutputDir the output directory where the built version of Authelia is located.

Functions

func NewRootCmd

func NewRootCmd() (cmd *cobra.Command)

NewRootCmd returns the root authelia-scripts cmd.

Types

type Build

type Build struct {
	Branch string
	Tag    string
	Commit string
	Tagged bool
	Clean  bool
	Extra  string
	Number int
	Date   time.Time
}

Build represents a builds metadata.

func (Build) ContainerLabels

func (b Build) ContainerLabels() (labels map[string]string)

ContainerLabels returns the container labels for this Build.

func (Build) State

func (b Build) State() string

State returns the state tags string for this Build.

func (Build) States

func (b Build) States() []string

States returns the state tags for this Build.

func (Build) XFlags

func (b Build) XFlags() []string

XFlags returns the XFlags for this Build.

type Docker

type Docker struct{}

Docker a docker object.

func (*Docker) Build

func (d *Docker) Build(tag, dockerfile, target string, buildMetaData *Build) error

Build build a docker image.

func (*Docker) Login

func (d *Docker) Login(username, password, registry string) error

Login login to the dockerhub registry.

func (*Docker) Manifest

func (d *Docker) Manifest(tags []string) error

Manifest push a docker manifest to dockerhub.

func (*Docker) PublishReadme

func (d *Docker) PublishReadme() error

PublishReadme push README.md to dockerhub.

func (*Docker) Tag

func (d *Docker) Tag(image, tag string) error

Tag tag a docker image.

type DockerImage

type DockerImage struct {
	Architecture string `json:"architecture"`
	Variant      any    `json:"variant"`
	Digest       string `json:"digest"`
	OS           string `json:"os"`
}

DockerImage represents some of the data from the docker images API.

func (DockerImage) Match

func (d DockerImage) Match(platform string) bool

Match returns true if this image matches the platform.

type DockerImages

type DockerImages []DockerImage

DockerImages represents some of the data from the docker images API.

type HostEntry

type HostEntry struct {
	Domain string
	IP     string
}

HostEntry represents an entry in /etc/hosts.