Skip to content

Operations guide

This section is the how-to-run-it guide for HOG: installing it, writing its configuration, wiring authentication and authorization, turning on observability, hardening it for production, scaling it, and diagnosing problems.

Running HOG always comes down to the same three things:

  • A binary. hog (or a custom binary composed with hog-build — see developer: building a custom binary).
  • A config directory. A single YAML file or a directory of *.yaml/*.yml files, by default /etc/hog, holding your Gateway, Route, and other resources.
  • Content, if you're serving one. A directory of static assets (a single-page app build, typically /srv/web) that a static route serves.

The entrypoint takes one flag:

hog --config /etc/hog

--config accepts either a single file or a directory; when it's a directory, files load in lexical filename order and that order becomes the document order used to resolve plugin and policy layering. Every value in the config supports ${ENV} interpolation, resolved once at startup.

In this section