logwisp/doc/README.md

LogWisp Documentation

The README has LogWisp's features, a quick start and the system requirements.

• Installation: building, installing, services, the container image, packaging, the end-to-end test scripts
• Deployment: deploy/lw-deploy.sh for edges, aggregators, containers, services, jails
• Architecture: component model, data flow, concurrency, back-pressure, the configuration engine's WebAssembly API
• Configuration: TOML structure, precedence, environment and CLI overrides
• Sources and Sinks: every plugin and its options
• Filters and Formatters: pattern matching, output shaping and sanitization
• Chaining: multi-node topologies and the wire protocol
• Networking: listeners, dialers, timeouts, limits
• Security: TLS, mTLS, password (SCRAM) authentication, address ACLs, certificates made at startup; threat model and current limits
• CLI: filter use, flags, pipeline specifications, presets, environment, signals, exit codes, lw --tui, --schema, lw auth, lw tls, lw preset, lw config; also the lw(1) manual, lw.1
• Operations: running, monitoring, tuning, troubleshooting
• To Do: the maintainer's release and packaging steps, and what lw --tui and the schema leave for later

A fully annotated configuration covering every option ships as config/logwisp.toml.