webserver

README

geneos Web Dashboard Servers

A webserver is an instance of a Web Dashboard.

It is not currently possible to manage TLS certificates and keys for webserver instances.

A new webserver instance is created using local package configuration files, therefore the same package version must be installed locally as on any remote host.

Documentation

Index

• Variables
• type Webservers
  • func (w *Webservers) Add(tmpl string, port uint16) (err error)
  • func (w *Webservers) Command() (args, env []string, home string)
  • func (w *Webservers) Config() *config.Config
  • func (w *Webservers) Home() string
  • func (w *Webservers) Host() *geneos.Host
  • func (w *Webservers) Load() (err error)
  • func (w *Webservers) Loaded() time.Time
  • func (w *Webservers) Name() string
  • func (w *Webservers) Rebuild(initial bool) error
  • func (w *Webservers) Reload() (err error)
  • func (w *Webservers) SetLoaded(t time.Time)
  • func (w *Webservers) String() string
  • func (w *Webservers) Type() *geneos.Component
  • func (w *Webservers) Unload() (err error)

Variables

var Webserver = geneos.Component{
	Name:          "webserver",
	Aliases:       []string{"web-server", "webservers", "webdashboard", "dashboards"},
	LegacyPrefix:  "webs",
	DownloadBase:  geneos.DownloadBases{Resources: "Web+Dashboard", Nexus: "geneos-web-server"},
	DownloadInfix: "web-server",
	PortRange:     "WebserverPortRange",
	CleanList:     "WebserverCleanList",
	PurgeList:     "WebserverPurgeList",
	LegacyParameters: map[string]string{
		"binsuffix": "binary",
		"webshome":  "home",
		"websbins":  "install",
		"websbase":  "version",
		"websexec":  "program",
		"webslogd":  "logdir",
		"webslogf":  "logfile",
		"websport":  "port",
		"webslibs":  "libpaths",
		"webscert":  "certificate",
		"webskey":   "privatekey",
		"websuser":  "user",
		"websopts":  "options",
		"websxmx":   "maxmem",
	},
	Defaults: []string{
		`binary=java`,
		`home={{join .root "webserver" "webservers" .name}}`,
		`install={{join .root "packages" "webserver"}}`,
		`version=active_prod`,
		`program={{join "${config:install}" "${config:version}" "JRE/bin/java"}}`,
		`logdir=logs`,
		`logfile=WebDashboard.log`,
		`port=8080`,
		`libpaths={{join "${config:install}" "${config:version}" "JRE/lib"}}:{{join "${config:install}" "${config:version}" "lib64"}}`,
		`maxmem=1024m`,
		`autostart=true`,
	},
	GlobalSettings: map[string]string{
		"WebserverPortRange": "8080,8100-",
		"WebserverCleanList": "*.old",
		"WebserverPurgeList": "logs/*.log:webserver.txt",
	},
	Directories: []string{
		"packages/webserver",
		"webserver/webservers",
	},
	GetPID: pidCheckFn,
}

Types

type Webservers

type Webservers instance.Instance

func (*Webservers) Add

func (w *Webservers) Add(tmpl string, port uint16) (err error)

func (*Webservers) Command

func (w *Webservers) Command() (args, env []string, home string)

func (*Webservers) Config

func (w *Webservers) Config() *config.Config

func (*Webservers) Home

func (w *Webservers) Home() string

func (*Webservers) Host

func (w *Webservers) Host() *geneos.Host

func (*Webservers) Load

func (w *Webservers) Load() (err error)

func (*Webservers) Loaded

func (w *Webservers) Loaded() time.Time

func (*Webservers) Name

func (w *Webservers) Name() string

func (*Webservers) Rebuild

func (w *Webservers) Rebuild(initial bool) error

func (*Webservers) Reload

func (w *Webservers) Reload() (err error)

func (*Webservers) SetLoaded

func (w *Webservers) SetLoaded(t time.Time)

func (*Webservers) String

func (w *Webservers) String() string

func (*Webservers) Type

func (w *Webservers) Type() *geneos.Component

Return the Component for an Instance

func (*Webservers) Unload

func (w *Webservers) Unload() (err error)