bordeaux(8)

📦 version 0.9.7, in alpine 3.24

💅 bordeaux(8) — System Manager's Manual 🍷

okay bestie, welcome to bordeaux(8), the page where we learn how to run a bordeaux service. buckle up, it's giving sysadmin main character energy ✨

🌸 NAME 🌸

bordeaux — run a bordeaux service. that's it. that's the whole vibe. 🫶

🦋 SYNOPSIS 🦋

bordeaux [options]

literally just the binary and some options. slay, no args required to see it, but keep reading, bestie 💀

🎀 DESCRIPTION 🎀

okay so here's the tea ☕ — this starts up an instance of the Bordeaux server. script files get loaded, and a driver gets executed. that's the whole little routine, and honestly? iconic.

normally Bordeaux is started from an init service, but you can just run it directly in the foreground, especially when you're testing stuff. ngl that's the move when you're debugging 🐛

quick vibe check on the builds:

  • debug builds start in the source test directory
  • release builds operate on live systems 😭 (yes, be careful)

at minimum you gotta specify a driver so Bordeaux has something to load and run. for testing though, the dummy test driver may be chosen if none is specified — lowkey convenient fr fr 🧚

and one more thing: static builds of bordeaux may be named with the -driver suffix, since the driver is pre-linked. iykyk 💅

✨ OPTIONS ✨

  • -6 — Enable IPV6 operation. This forces all name resolutions to be ipv6. no cap, everything goes v6 🌈
  • --config=path — Alternate config file to use. the default is /etc/bordeaux.conf. also, a custom.conf can also exist in the server prefix directory with site specific config overrides. two configs, one server, we love to see it 💖
  • --driver=name — Loadable Bayonne driver to execute. only a single driver can be loaded — one driver only, bestie, don't get greedy 🙈
  • --paths — Display server paths used, 🗺️ (yes the original has a lil comma, we keep it, character for character)
  • --prefix=path — Specify alternate data volume. this normally would be /var/lib/bordeaux. the most common use might be to remap the data volume for use in a container 🐳✨
  • --verbose — Display verbose output. this is useful when running locally to test the service. talkative king 👑
  • --help — Outputs help screen for the user. the classic. the icon. when in doubt, --help 🫶

Copyright © 2020 Tycho Softworks. 🎀

This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. like, none. zero. don't come for them if it breaks 💀

okay that's the whole page bestie, go forth and run your service 💜

— brought to you by Tycho Softworks, under the Bordeaux name, and yes this page is dated bordeaux(8) because we stay consistent 🌸✨🦋

📦 where this page comes from