bc-server

Server for maintaining and scheduling jobs.

Usage

bc-server [--cluster _name_] [--force] --dir path [server][:port] ... bc-server --version bc-server --help

where
--cluster name of cluster to join. Default is beyondcron.
--dir path location of configuration (etc) and data (data) directories.
--force start the server. This is required the first time that, the first server in a cluster is started. It is also required we performing a cluster cold start, and the server was not the last server in the cluster running.
server server name/s within the cluster. Default is name returned by /bin/hostname.
port server port number. Default is 5701, the value of the enviornment variable BEYONDCRON_SERVER_PORT.
--version print the sever version.
--help print the server command options.

if no server or port is provided, BeyondCron will attempt to use Hazelcast’s multicast discovery process.

Environment variables

BEYONDCRON_CLUSTER_NAME name of BeyondCron cluster to join.
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_FORCE_START force start the server if true.
BEYCONCRON_DIR location of configuration (etc) and data (data) directories. If defined, the variables BEYONDCRON_DIR_CONFIG and BEYONDCRON_DIR_DATA will be overwritten, and set to ${BEYONDCRON_DIR}/etc and ${BEYONDCRON_DIR}/data respectively.
BEYONDCRON_DIR_CONFIG location of configuration directory.
BEYONDCRON_DIR_DATA location of data directory.
BEYONDCRON_PROTECTED_HOSTS one or more space separated host names to protect. These names will be defined in additon to any names defined using the protected command. Default is localhost 127.0.0.1
BEYONDCRON_PROTECTED_USERS one or more space separated user names to protect. These names will be defined in additon to any names defined using the protected command. Default is root and the user that bc-server is running under.
BEYONDCRON_SERVER_NAMES one or more space separated server[:port]s to connect to.
BEYONDCRON_SERVER_PORT the server port number. Default is 5701.
BEYONDCRON_STATUS_SERVICE name of status service.
BEYONDCRON_USER_SERVICE name of user service.
BEYONDCRON_GUEST_USER_ACCESS enable guest user access if true. Default is false.
BEYONDCRON_GUEST_USER_NAME name of guest user. Default is guest.
BEYONDCRON_GUEST_USER_DESCRIPTION description of guest user. Default is Guest user.
BEYONDCRON_GUEST_USER_PASSWORD password of guest user. Default is guest.
BEYONDCRON_ALERT_COMMAND operating system command which is called when bc-server 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-server stopped unexpectedly” or “bc-server stopped after receiving signal 15”.
BEYONDCRON_DAEMONbc-server
BEYONDCRON_EXIT_CODE – exit code of bc-server
BEYONDCRON_OS_USER – operating system user name which bc-server was running under.
JAVA_OPTS one or more JVM options. e.g. -Xms2T -Xmx2M

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

Installation

See also

Reference