RACKSDB-WEB(1)

📦 version 0.7.0, in alpine 3.24

💅 racksdb-web(1) — the manual page, but make it a group chat ✨

okay so bestie, listen. this is racksdb-web, and if you're here it's because you want the RacksDB web app with its REST API up and running. she's iconic, she's serving data over HTTP, and honestly? she ate. let me walk you through it fr fr 🎀

✨ SYNOPSIS ✨

racksdb-web [OPTIONS]

that's it. that's the whole vibe. you give her some OPTIONS and she goes 🦋

💖 OPTIONS 💖

no gatekeeping here — every single flag, exactly as it is:

  • -h, --help — shows this help message, then politely exits. the "hey bestie here's what I do" moment 🫶
  • -v, --version — prints the RacksDB version number and dips. iconic behaviour honestly.
  • --debug — turns on debug mode, so you get way more messages in the output. it's giving "tell me everything" 🔥 perfect for when you need to know what's actually going on.
  • -b, --db=DB — the path to your database. both files and directories are accepted, she's flexible like that ✨ if the path is a directory, every YAML file inside gets loaded, recursively — yes, recursive, she goes deep. if the path doesn't exist? error, sorry babe. default value is /var/lib/racksdb/ directory, or the environment variable RACKSDB_DB if that's set.
  • -s, --schema=SCHEMA — path to the RacksDB schema YAML file. if the file doesn't exist, it's an error, no cap. default value is /usr/share/racksdb/schemas/racksdb.yml, or the environment variable RACKSDB_SCHEMA if set.
  • -e, --ext=EXT — path to the optional RacksDB schema extensions. if the file doesn't exist, it's silently ignored by RacksDB — like, she just pretends she didn't see it 🙈 default value is /etc/racksdb/extensions.yml, or the environment variable RACKSDB_EXTENSIONS if set.
  • --host=HOST — the hostname to listen for incoming requests on. set it to 0.0.0.0 to listen on all the host's IP addresses. default value is localhost, which keeps connections restricted to the local host only (cozy, private, lowkey 🍓).
  • -p, --port=PORT — the TCP port to listen for incoming requests on. default value is 5000.
  • --drawings-schema=DRAWINGS_SCHEMA — path to the drawing parameters schema YAML file. default value is /usr/share/racksdb/drawings.yml.
  • --cors — enables CORS headers. cross-origin besties welcome 💜
  • --openapi — enables the OpenAPI endpoint so you can retrieve the REST API specifications. very "here are my receipts" of her.
  • --with-ui[=PATH] — enables the web UI. heads up: the web UI is disabled by default 🫠 when you use the option without a value, the default UI path /usr/share/racksdb/frontend is used. when you give it a path, racksdb-web loads the UI files from that path instead.

🌈 ENVIRONMENT VARIABLES 🌈

when a command-line option from up there is omitted, racksdb-web goes looking at these environment variables instead — but only if they're set to a non-empty value, she's picky like that ✋

  • RACKSDB_SCHEMA — path to the RacksDB schema YAML file.
  • RACKSDB_EXTENSIONS — path to optional schema extensions.
  • RACKSDB_DB — path to the database.
💅 and the golden rule: command-line options always override environment variables. always. don't argue with her.

⭐ EXIT STATUS ⭐

  • 0 — racksdb-web has processed the command with success. slay, she did it 👑
  • 1 — racksdb-web encountered an error. 😭 it happens to the best of us.

🦋 RESOURCES 🦋

RacksDB web site: https://github.com/rackslab/racksdb — go look, iykyk.

🧚 COPYING 🧚

Copyright © 2022-2023 Rackslab: https://rackslab.io.

RacksDB is distributed under the terms of the GNU General Public License v3.0 or later (GPLv3+). legal bestie rights, we love to see it 🫶

💜 AUTHOR 💜

Rackslab: https://rackslab.io

🌸 okay that's the whole page! this is RacksDB 0.7.0, dated 2026-08-20, and you can find it filed under RACKSDB-WEB(1). go forth and serve that REST API, bestie — main character energy only 💅✨🎀
📦 where this page comes from