Bulletin Board Server

BulletinBoard provides object storage for ArrayObject, designed for debugging and data acquisition workflows.

BulletinBoard is part of the dbgbb project.

Important Notes

Client operations do not return success/failure status to maximize performance. Please consult server logs for error details.
Data is not encrypted; avoid transmitting confidential information.
This crate is under active development and specifications may change. Compatibility between BulletinBoard and dbgbb is maintained for matching minor version numbers.
Running included tests will interact with the server and may erase existing data.

You can run the Bulletin Board Server in several ways:

Install and launch the server with a specified listen address:

cargo install bulletin-board-server
export BB_LISTEN_ADDR="0.0.0.0:7578"
bulletin-board-server

The server is integrated into BulletinBoard GUI. Select "Built-in" in the settings page and start the server from the start page.

Run the server using the official Docker image:

docker run -p 7578:7578 -v /path/to/vol:/data yshojihep/bulletin-board:latest

For further details, refer to DockerHub.

Variable	Default	Description
BB_LISTEN_ADDR	"127.0.0.1:7578"	Server listen address. For Unix sockets, specify the path to a new socket file.
BB_TMP_DIR	"./bb_tmp"	Directory for temporary data.
BB_ACV_DIR	"./bb_acv"	Directory for archived data.
BB_TOT_MEM_LIMIT	"1GiB"	Total memory limit. Exceeding this causes all bulletins to be saved as files. Metadata size is not included in this calculation.
BB_FILE_THRETHOLD	"1MiB"	Bulletins exceeding this size are stored as files.
BB_MAX_RESULTS	1024	Maximum number of results returned by `viewboard` and `get_info`.
BB_LOG_FILE	"./bulletin-board.log"	Log file location.
BB_LOG_LEVEL	3	Log level: 0 (None), 1 (Error), 2 (Warn), 3 (Notice, default), 4 (Info), 5 (Debug).
BB_DEBUG	Not set	If set, logs are output to stdout.

Short	Long	Description
-d	--debug	Log to stdout.
-l	--log-level <LOG_LEVEL>	Set log level [0: None, 1: Error, 2: Warn, 3: Notice (default), 4: Info, 5: Debug].
-h	--help	Display help information.
-V	--version	Display version information.