bc-web

Server providing a web based BeyondCron desktop.

As well as providing an interactive real-time interface, bc-web also supports via the terminal panel the complete collection of commands that are available with the bc-cli command line interface.

Usage

bc-web [--cluster name] [server][:port] ... bc-web --version bc-web --help

where

--cluster name	of BeyondCron cluster to to connect to. Default is `beyondcron`.
server	server name/s within the cluster. Default, the value of the environment variable `BEYONDCRON_SERVER_NAMES`.
port	server port number. Default, the value of the environment variable `BEYONDCRON_SERVER_PORT`.
--version	print the command version.
--help	print the command options.

Environment variables

BEYONDCRON_ALERT_COMMAND	Operating system command which is called when bc-web stops unexpectedly. This can be used for example to send an email or SMS message. When called, the following environment variables will be set: `BEYONDCRON_ALERT_REASON` – description of error. e.g. “bc-web stopped unexpectedly” or “bc-web stopped after receiving signal 15”. `BEYONDCRON_DAEMON` – bc-web `BEYONDCRON_EXIT_CODE` – exit code of bc-web `BEYONDCRON_OS_USER` – operating system user name which bc-web was running under.
BEYONDCRON_CONFIG_SERVICE	Name of the configuration service. If not defined BeyondCron will read startup variables from operating system environment variables.
JAVA_OPTS	One or more JVM options. e.g. `-Xms2T -Xmx2M`
LOG4J_CONFIGURATION_FILE	Location of the log4j configuration file. If this file is named …/log4j2.yaml and does not exist, bc-web will create and populate it, with the bc-web defaults.

Startup variables

Startup variables can be set within a configuration service, or as operating systems environment variables. Startup variables will be read first from a configuration service if defined, and then from environment variables if not defined within the configuration service.

BEYONDCRON_CLUSTER_NAME	Name of BeyondCron cluster to join. Default is `beyondcron`.
BEYONDCRON_CLUSTER_PASSWORD	Password of cluster. If password is in the format file:filename, then the password will be read from filename. Default is a cluster specific random string.
BEYONDCRON_SERVER_ADDRESS_IGNORE	Space separated list of IP address prefixes. When searching for an address, ignore any addresses that begin with one of these prefixes. This can be useful, on servers with one or more management interfaces.
BEYONDCRON_SERVER_ADDRESS_IPV6	When searching for an address, prefer an IPv6 address. Default is `false`.
BEYONDCRON_SERVER_ADDRESS_PRIVATE	When searching for an address, only chose a private network address. Default is `true`.
BEYONDCRON_SERVER_NAMES	One or more space separated server[:port]s to connect to.
	Default is a plumbed IP address that best matches the rules defined by the environment variables `BEYONDCRON_SERVER_ADDRESS_PRIVATE`, `BEYONDCRON_SREVER_ADDRESS_IPV6` & `BEYONDCRON_SERVER_ADDRESS_IGNORE`.
BEYONDCRON_SERVER_PORT	the server port number. Default is `5701`.

where a parameter is defined on both the command line and as an environment/startup variable, the command line value will be used.

Configuration variables

Configuration variables are set within BeyondCron using the config commands.

beyondcron.time.zone	default timezone.
beyondcron.check.hosts.exist	check that command job hosts exist, when creating jobs. Default is `true`.
beyondcron.echo	enable/disable the echo url. Default is `true`, enabled.

Exit status

bc-web exits with 0 when shutdown/killed with the WINCH signal, 1 if an internal error occurred, or 2 if killed by a signal other than WINCH.

URLs

/	BeyondCron desktop.
/docs	BeyondCron online manual.
/echo	Simple echo URL, that reports what http data it received.

Examples

Login to the BeyondCron console

jsmith% open http://localhost:8080

type your user name, password and click “Login” to login to the BeyondCron desktop.

Open the online manual page for bc-web.

jsmith% open http://localhost:8080/docs/bc-web.html

Echo an http query.

jsmith% curl http://localhost:8080/echo?name=John%20Smith

Request ------- GET http://localhost:8080/echo?name=John%20Smith Header ------ accept: */* host: localhost:8080 user-agent: curl/7.81.0 &nsbp; Content -------