bc-web

Server providing a web based BeyondCron management console.

Usage

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

where
--cluster name of BeyondCron cluster to to connect to. Default is beyondcron.
--jetty filename Location of optional Jetty configuration file.
--port port on which to listen for http requests. Default is 8080.
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 enviornment variable BEYONDCRON_SERVER_PORT.
--version print the command version.
--help print the command options.

Environment variables

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.
BEYONDCRON_SERVER_ADDRESS_PRIVATE When searching for an address, only chose a private network address. Default is true.
BEYONDCRON_SERVER_ADDRESS_IPV6 When searching for an address, prefer an IPv6 address. Default is false.
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_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_JETTY_CONFIG Jetty configuration file.
BEYONDCRON_HTTP_PORT on which to listen for http requests. Default is 8080.
BEYONDCRON_TIME_ZONE default timezone.
BEYONDCRON_CHECK_HOSTS_EXIST check that command job hosts exist. Default is true.
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_DAEMONbc-web
BEYONDCRON_EXIT_CODE – exit code of bc-web
BEYONDCRON_OS_USER – operating system user name which bc-web was running under.
BEYONDCRON_ECHO enable/disable the echo url. Default is true, enabled.
JAVA_OPTS one or more JVM options. e.g. -Xms2T -Xmx2M
LOG4J_CONFIGURATION location of the log4j configuration file. If this file does not exist, bc-web will create and populate it, with the bc-web defaults.

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

URLs

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

Examples

Start on default port

jsmith% bc-web &

... bc-web 2.0.170215 ... Copyright (C) 2017 Adrian Riordan. All rights reserved. ...

jsmith% open http://localhost:8080

Login window

Open the online manual.

jsmith% open http://localhost:8080/docs

Online manual

Echo an http query.

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

echo query

Installation

Services

Overview

Configuration

Utilities

See also