chartmuseum

Documentation

Index

• type Logger
  • func NewLogger(json bool, debug bool) (*Logger, error)
• type Router
  • func NewRouter(logger *Logger, username string, password string, enableMetrics bool) *Router
• type Server
  • func NewServer(options ServerOptions) (*Server, error)
  • func (server *Server) Listen(port int)
• type ServerOptions

Types

type Logger

type Logger struct {
	*zap.SugaredLogger
}

Logger handles all logging from application

func NewLogger

func NewLogger(json bool, debug bool) (*Logger, error)

NewLogger creates a new Logger instance

type Router

type Router struct {
	*gin.Engine
}

Router handles all incoming HTTP requests

func NewRouter

func NewRouter(logger *Logger, username string, password string, enableMetrics bool) *Router

NewRouter creates a new Router instance

type Server

type Server struct {
	Logger                 *Logger
	Router                 *Router
	RepositoryIndex        *repo.Index
	StorageBackend         storage.Backend
	StorageCache           []storage.Object
	StorageCacheLock       *sync.Mutex
	AllowOverwrite         bool
	TlsCert                string
	TlsKey                 string
	ChartPostFormFieldName string
	ProvPostFormFieldName  string
}

Server contains a Logger, Router, storage backend and object cache

func NewServer

func NewServer(options ServerOptions) (*Server, error)

NewServer creates a new Server instance

func (*Server) Listen

func (server *Server) Listen(port int)

Listen starts server on a given port

type ServerOptions

type ServerOptions struct {
	StorageBackend         storage.Backend
	LogJSON                bool
	Debug                  bool
	EnableAPI              bool
	AllowOverwrite         bool
	EnableMetrics          bool
	ChartURL               string
	TlsCert                string
	TlsKey                 string
	Username               string
	Password               string
	ChartPostFormFieldName string
	ProvPostFormFieldName  string
}

ServerOptions are options for constructing a Server