server

Documentation

Index

• Constants
• type ListReleaseNamesResponse
• type Server
  • func New(github *github.Client, helper *cmdutils.Helper[*config.Config]) *Server
  • func (s *Server) GetChecksum(ctx *fiber.Ctx) error
  • func (s *Server) GetLatestReleaseName(ctx *fiber.Ctx) error
  • func (s *Server) GetLatestReleaseShellScript(ctx *fiber.Ctx) error
  • func (s *Server) GetPing(ctx *fiber.Ctx) error
  • func (s *Server) GetReleaseArtifact(ctx *fiber.Ctx) error
  • func (s *Server) GetReleaseShellScript(ctx *fiber.Ctx) error
  • func (s *Server) ListReleaseNames(ctx *fiber.Ctx) error
  • func (s *Server) Start(address string, config *tls.Config, tlsOverride bool) (err error)
  • func (s *Server) Stop() error

Constants

const (
	LatestReleasePath     = "/"
	PingPath              = "/ping"
	LatestReleaseNamePath = "/latest"
	ListReleaseNamesPath  = "/releases"
	ChecksumPath          = "/checksum"

	ReleaseNameArgPath = "/:release_name"
	OSArgPath          = "/:os"
	ArchArgPath        = "/:arch"

	Analytics = "analytics"
)

Types

type ListReleaseNamesResponse

type ListReleaseNamesResponse struct {
	ReleaseNames []string `json:"release_names"`
}

type Server

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

func New

func New(github *github.Client, helper *cmdutils.Helper[*config.Config]) *Server

func (*Server) GetChecksum

func (s *Server) GetChecksum(ctx *fiber.Ctx) error

GetChecksum returns the checksum for the given release name, os, and arch

func (*Server) GetLatestReleaseName

func (s *Server) GetLatestReleaseName(ctx *fiber.Ctx) error

GetLatestReleaseName returns the name of the latest release

func (*Server) GetLatestReleaseShellScript

func (s *Server) GetLatestReleaseShellScript(ctx *fiber.Ctx) error

GetLatestReleaseShellScript returns a shell script which will download the latest release of the binary and install it on the system

func (*Server) GetPing

func (s *Server) GetPing(ctx *fiber.Ctx) error

GetPing is a simple health check endpoint that always returns 200

func (*Server) GetReleaseArtifact

func (s *Server) GetReleaseArtifact(ctx *fiber.Ctx) error

GetReleaseArtifact returns the artifact for the given release name, os, and arch

func (*Server) GetReleaseShellScript

func (s *Server) GetReleaseShellScript(ctx *fiber.Ctx) error

GetReleaseShellScript returns a shell script which will download the given release of the binary and install it on the system

func (*Server) ListReleaseNames

func (s *Server) ListReleaseNames(ctx *fiber.Ctx) error

ListReleaseNames returns a list of all available release names

func (*Server) Start

func (s *Server) Start(address string, config *tls.Config, tlsOverride bool) (err error)

func (*Server) Stop

func (s *Server) Stop() error