Skip to main content

Reference

Dry technical material — the stuff that exists so you can paste it into a search engine.

:::note Status Stub. Reference content fills in alongside each user-guide page. :::

Planned sections​

  • CLI reference — every Hub-managed CLI tool (logcolor, the install script, the backup helper). Yes, even though we don't want you using them.
  • REST API — every endpoint the dashboard exposes (/api/security/antivirus, /api/antivirus/scan, etc). Useful for automation against the Hub.
  • File layout — where the Hub puts things on disk. /home/mark/serveraihub for the dashboard, /home/mark/corpus for the corpus backend, /var/lib/clamav for signatures.
  • Compose files — what the bundled docker-compose.yml files look like, by service.
  • Environment variables — every AV_IOWAIT_MAX, FRESHCLAM_CHECKS, etc, with defaults and meaning.
  • Cron schedules — every cron entry the Hub installs, what it does, when, and how to override.