Runtime Variables

These variables are access by various parts of the server and can modify how it functions.

Setting runtime variables

Any of these methods can be used to set runtime variables. Duplicates may be randomly chosen.

Properties file

Create a file called board.properties in the working directory of the server and format as the following

key=value
other.key=value with spaces

Command line arguments

Arguments may be passed in through the command line.

java -jar board-server-xxx.jar --key value --other.key "value with spaces"

Environment variables

You can set environment variables to be used as runtime variables. Prefix each environment variable with board.

board.key value
board.other.key value with spaces

Runtime variables

File indicates a relative (<working directory>/folder/file.ext) or absolute path (C:/folder/file.ext)

Flag	Type	Default	Description
ssl	boolean	(required)	Whether SSL will be used (HTTPS/WSS, port 443) instead of unencrypted sockets (HTTP/WS, port 80)
ssl.keystore.path	file	(optional)	Path to the PKCS12 mykeystore.pfx containing the private key for the server. Set to http to use HTTP without SSL encryption
ssl.passphrase	string	(optional)	Passphrase for mykeystore.pfx
postgres	boolean	(required)	Whether to use memory (debug only) or PostgreSQL
postgres.url	string	(optional)	Fully qualified JDBC url to PostgreSQL database
postgres.user	string	(optional)	User for PostgreSQL database
postgres.password	string	(optional	Password for PostgreSQL database
document.root.path	file	documentRoot	Should be set to where board-web-client is. HTTP requests to a directory (localhost or localhost/folder/) will be served the index.html file of those directories HTTP requests to a file that do not specify an extension (localhost/file) will be served a .html that corresponds to the requested name
debug.log.traffic	boolean	false	Will print network throughput (read/write) into the console
autosave.interval	integer (seconds)	-1	Sets how often flat file storage will be saved to disk, or negative value to disable
http.cache.time	integer (seconds)	0	How long before a cached item expires. Set to 0 for development purposes so refreshing the page will always load your new changes (equivalent of crtl+f5)