racksdb-web CLI manpage

This section explains all racksdb-web command options available. The content of the page this also available in racksdb-web(1) manpage after installation.

Synopsis

racksdb-web [OPTIONS]

Options

-h, --help

Show this help message and exit.

-v, --version

Show RacksDB version number and exit.

--debug

Enable debug mode with more messages in output.

-b, --db=DB

Path to database. Both files and directories paths are accepted. If the path is a directory, all YAML files in this directory are loaded, recursively. If the path does not exist, an error is reported. Default value is /var/lib/racksdb/ directory.

-s, --schema=SCHEMA

Path to RacksDB schema YAML file. If the file does not exist, an error is reported. Default value is /usr/share/racksdb/schemas/racksdb.yml.

-e, --ext=EXT

Path to optional RacksDB schema extensions. If the file does not exist, it is silently ignored by RacksDB. Default value is /etc/racksdb/extensions.yml.

--host=HOST

The hostname to listen for incoming requests. Set to 0.0.0.0 to listen on all IP addresses of the host. Default value is localhost which restricts connections to local host.

-p, --port=PORT

TCP port to listen for incoming requests. Default value is 5000.

--drawings-schema=DRAWINGS_SCHEMA

Path to drawing parameters schema YAML file. Default value is /usr/share/racksdb/drawings.yml.

--cors

Enable CORS headers.

--openapi

Enable OpenAPI endpoint to retrieve REST API specifications.

--with-ui[=PATH]

Enable web UI. The web UI is disabled by default. When the option is used without value, default UI path /usr/share/racksdb/frontend is used. When a path is provided, racksdb-web loads UI files from this path.

Exit status

0

racksdb-web has processed command with success.

1

racksdb-web encountered an error.