bulletin-board-server
| Crates.io | bulletin-board-server |
| lib.rs | bulletin-board-server |
| version | 0.3.3 |
| created_at | 2024-10-13 21:13:23.21517+00 |
| updated_at | 2026-01-16 15:29:29.782991+00 |
| description | Object storage for ArrayObject for debugging and data taking purposes. |
| homepage | |
| repository | https://github.com/YShoji-HEP/BulletinBoard |
| max_upload_size | |
| id | 1407683 |
| size | 73,010 |
Yutaro Shoji (YShoji-HEP)
documentation
README
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
BulletinBoardanddbgbbis maintained for matching minor version numbers. - Running included tests will interact with the server and may erase existing data.
Usage
You can run the Bulletin Board Server in several ways:
Cargo
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
Built-in Server (GUI)
The server is integrated into BulletinBoard GUI. Select "Built-in" in the settings page and start the server from the start page.
Docker
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.
Environment Variables
| 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. |
Command Line Options
| 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. |