webui

package

v1.6.0 Latest Latest Go to latest Published: Jun 24, 2026 License: Apache-2.0 Imports: 12 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/versity/versitygw

Links

Open Source Insights

Documentation ¶

Index ¶

func MountOn(app *fiber.App, prefix string, cfg *ServerConfig) error
type Option
type Server
- func NewServer(cfg *ServerConfig, opts ...Option) (*Server, error)
- func (s *Server) ServeMultiPort(ports []string) error
- func (s *Server) Shutdown() error
type ServerConfig

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func MountOn ¶ added in v1.4.0

func MountOn(app *fiber.App, prefix string, cfg *ServerConfig) error

MountOn registers the WebUI routes on an existing Fiber app at the given path prefix. This allows hosting the WebUI on the same port as another service (e.g. the S3 API server). The prefix must start with "/" and must not be empty or just "/".

Types ¶

type Option ¶

type Option func(*Server)

Option sets various options for NewServer()

func WithPathPrefix ¶ added in v1.4.0

func WithPathPrefix(prefix string) Option

WithPathPrefix mounts the entire web UI under the given path prefix

func WithQuiet ¶

func WithQuiet() Option

WithQuiet silences default logging output.

func WithSocketPerm ¶ added in v1.4.1

func WithSocketPerm(perm os.FileMode) Option

WithSocketPerm sets the file-mode permissions applied to file-backed UNIX domain sockets after binding. It has no effect on TCP/IP or abstract namespace sockets.

func WithTLS ¶

func WithTLS(cs *utils.CertStorage) Option

WithTLS sets TLS Credentials

type Server ¶

type Server struct {
	CertStorage *utils.CertStorage
	// contains filtered or unexported fields
}

Server is the main GUI server

func NewServer ¶

func NewServer(cfg *ServerConfig, opts ...Option) (*Server, error)

NewServer creates a new GUI server instance

func (*Server) ServeMultiPort ¶ added in v1.3.0

func (s *Server) ServeMultiPort(ports []string) error

ServeMultiPort creates listeners for multiple address specifications and serves on all of them simultaneously. This supports listening on multiple addresses.

func (*Server) Shutdown ¶

func (s *Server) Shutdown() error

Shutdown gracefully shuts down the server

type ServerConfig ¶

type ServerConfig struct {
	Gateways      []string // S3 API gateways
	AdminGateways []string // Admin API gateways (defaults to Gateways if empty)
	Region        string
	CORSOrigin    string
}

ServerConfig holds the server configuration

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL