DocsReference

Documentation

Technical reference notes · updated 2026

This site hosts internal documentation for the services we operate. Pages are plain HTML and are updated as the stack changes.

Contents

SectionDescription
Getting startedPrerequisites, environment setup, first run
ConfigurationService configuration files and defaults
OperationsHealth checks, logs, routine maintenance
API referenceHTTP endpoints, payloads, error codes

Getting started

Install the runtime, copy the configuration sample, then start the service. The default configuration listens on 127.0.0.1 only; put a reverse proxy in front of it if the service needs to be reachable externally.

Operations

Logs are rotated daily. Metrics are collected every minute and retained for fourteen days. For incidents, check the service status first, then the proxy configuration, then the upstream health.

API reference

All endpoints accept and return JSON. Errors use standard HTTP status codes with a short message field.