BrightServer Command Line Options

Command Line Options

BrightServer may be run with the following options from the command line interface. Below are the output as listed by the BrightServer executable, detailing these options. This menu can be accessed viewed via the -h or --help suffix after the BrightServer executable, eg:

> run --help

 

run [-t|--token] [-b|--brightdb BRIGHTDB_DIR] [-s|--system SYSTEM_DB_DIR] [-d|--dbdef SYSDB_CONFIG_FILE] [-a|--appdir DEFAULT_APPS_DIR ] [CONFIG_FILE_NAME]

where:

--version   *  prints server version and exits

--token     *  displays server hardware token

--brightdb  *  sets the brightdb database directory in which the database is to be created

--systemdb  *  sets the system database directory in which the system database is to be created

--dbdef     *  sets the system database configuration file name

--appdir    *  sets the default application distribution directory

--datadir   *  sets the data folder for external blob functionality

--http      *  sets the server HTTP port (must be used with --https and --tracer)

--https     *  sets the server HTTPS secure port (must be used with --http and --tracer)

--tracer    *  sets the server remote tracing port (must be used with --http and --https)

--user      *  specifies user name (must be used with --password to change user password)

--password  *  sets new user password (must be used with --user to change user password)

--scacheoff *  turns off caching of compiled scripts

--scacheon  *  turns on caching of compiled scripts

Examples

• Display the server version

  > run --version

  BrightServer(TM) Version 9.0.0

• Start BrightServer runinng an example file-based configuration - example.xml, located in the 'conf' directory of BrightServer. Please note, specifying a file-based configuration will have that configuration be the sole configuration for the server, disabling any other deployed configurations for the instance.

  > run conf\example.xml

• Retrieve the server token via command line input.

  > run --help

• Start the server with the HTTP, HTTPS and Remote Tracing ports saved to 8081, 8444 and 12922 respectively. All arguments must be specified, else the previous settings will be used.

  > run --http 8081 --https 8444 --tracer 12922

• Create a new user with username 'new_user' and password 'new_password'. If the user 'new_user' exists, their password will be changed to 'new_password'.

  > run --user new_user --password new_password

• Run BrightServer from a bs-sys-ds.xml file located in the 'conf' directory of BrightServer. This may be used when configuring Multiple Server Instances of BrightServer, when the server is being run as a service.

  > run --dbdef conf\bs-sys-ds.xml