web

Documentation

Overview

Package web is a web dashboard

Index

• Variables
• func Commands(options ...service.Option) []*cli.Command
• func Plugins() []plugin.Plugin
• func Register(pl plugin.Plugin) error
• func Run(ctx *cli.Context, srvOpts ...service.Option)

Variables

var (
	// Default server name
	Name = "go.vine.web"
	// Default address to bind to
	Address = ":8082"
	// The namespace to serve
	// Example:
	// Namespace + /[Service]/foo/bar
	// Host: Namespace.Service Endpoint: /foo/bar
	Namespace = "go.vine"
	Type      = "web"
	Resolver  = "path"
	// Base path sent to web service.
	// This is stripped from the request path
	// Allows the web service to define absolute paths
	BasePathHeader = "X-Vine-Web-Base-Path"

	ACMEProvider          = "autocert"
	ACMEChallengeProvider = "cloudflare"
	ACMECA                = acme.LetsEncryptProductionCA

	// Host name the web dashboard is served on
	Host, _ = os.Hostname()
)

Meta Fields of vine web

Functions

func Commands

func Commands(options ...service.Option) []*cli.Command

Commands for `vine web`

func Plugins

func Plugins() []plugin.Plugin

Plugins lists the web plugins

func Register

func Register(pl plugin.Plugin) error

Register registers an web plugin

func Run

func Run(ctx *cli.Context, srvOpts ...service.Option)