Cheat Sheet - Wichtigste Befehle (Übersicht)

bffh Daemon (bffhd) Befehlsübersicht (-h, --help)

/opt/fabinfra/bffh/target/release/bffhd --help

-c, --config <config>            Path to the config file to use
    --check                      Check config for validity
    --dump                       Dump all internal databases
    --dump-users <FILE>          Dump the users db to the given file as TOML
    --force                      force ops that may clobber
-h, --help                       Print help information
    --load <load>                Load values into the internal databases
    --log-format <log format>    Use an alternative log formatter. Available: Full, Compact,
                                 Pretty [possible values: Full, Compact, Pretty]
    --log-level <log level>      Set the desired log levels.
    --print-default              Print a default config to stdout instead of running
    --quiet                      Decrease logging verbosity
    --tls-key-log [<PATH>...]    log TLS keys into PATH. If no path is specified the value of
                                 the envvar SSLKEYLOGFILE is used.
-v, --verbose                    Increase logging verbosity
-V, --version                    Print version information

Logging-Konfiguration (--log-level, --log-format, --quiet, -v, --verbose, --tls-key-log)

Log-spezifische Parameter inklusive Audit Log sind zusammenfassend in Server Logs konfigurieren genauer erklärt.

Überschreibende Operationen erzwingen (--force)

Eklärung ToDo

Benutzerdatenbank importieren (--load <users.toml file>)

Dieses Kommando lädt die angegebene *.toml Datei in die interne Benutzerdatenbank (state db file namens bffh) hinein. Praxistipps zum Umgang mit der users.toml findest du unter Nutzerdatenbank laden / hashen / prüfen.

BFFH Datenbank exportieren (--dump)

Die BFFH Datenbank soll sich ebenso dumpen lassen. Dazu muss --config <Pfad zu bffh.dhall> angegeben werden, damit bffhd weiß, welche Datenbank angefragt werden soll.

/opt/fabinfra/bffh/target/release/bffhd -c /opt/fabinfra/bffh-data/config/bffh.dhall --dump

Error: 
  × DB Dumping is currently not implemented, except for the users db, using `--dump-users`

Dieser Befehl ist aktuell nicht implementiert!

Benutzerdatenbank exportieren (--dump-users)

Einmal importiere Nutzerdaten können genauso wieder aus der bffh Datenbank exportiert werden. Dazu muss --config <Pfad zu bffh.dhall> angegeben werden, damit bffhd weiß, welche Datenbank angefragt werden soll.

/opt/fabinfra/bffh/target/release/bffhd -c /opt/fabinfra/bffh-data/config/bffh.dhall --dump-users

Konfigurationsdatei prüfen (--check)

Dieser Parameter prüft die angegebene Konfigurationsdatei auf fehlende oder fehlerhafte Angaben und überprüft generell, ob die *.dhall Datei geparsed werden kann. Sobald eine z.B. eine eckige oder geschweifte Klammer, ein Hochkomma oder normales Komma fehlt, gibt es in der Regel Probleme. Für das Prüfen muss ebenso --config <Pfad zu bffh.dhall> angegeben werden

Konfigurationsstandard ausgeben (--print-default)

/opt/fabinfra/bffh/target/release/bffhd --print-default

Dieser Befehl gibt eine minimale Beispielkonfiguration im Dhall-Format aus. Die ausführliche Erläuterung der bffh-Konfiguration findest du hier.

{
actor_connections = [
  {
    _1 = "Testmachine",
    _2 = "Actor"
    }
  ],
actors = {
  Actor = {
    module = "Shelly",
    params = {=} 
  }
  },
auditlog_path = "/var/log/bffh/audit.log", 
certfile = "./bffh.crt", 
db_path = "/run/bffh/database", 
init_connections = [
  { 
    _1 = "Initiator", 
    _2 = "Testmachine"
    }
  ],
initiators = {
  Initiator = {
    module = "TCP-Listen",
    params = {=}
    }
  },
instanceurl = "",
keyfile = "./bffh.key",
listens = [
  {
    address = "127.0.0.1"
  }
],
machines = {=},
mqtt_url = "tcp://localhost:1883",
roles = {=},
spacename = ""
}

Version anzeigen (--version, -V)

/opt/fabinfra/bffh/target/release/bffhd -V

diflouroborane 0.4.2

Helfer-Skripte

Diverse Helfer-Scripts, die verschiedene Optionen/Parameter automatisieren (z.B. Benutzerdankbank sichern) finden sich in der Script-Sammlung.