docs

Documentation

This directory contains documentation for the WorkermanBundle.

Index

User-facing (included in Composer dist archives)

• README.md — This documentation index
• getting-started.md — Requirements, install, minimal config and first start
• configuration.md — Every config key and environment variable
• commands.md — Every console command with its options
• http-server.md — Listen address, workers, limits, keep-alive and streamed responses
• middlewares.md — Write and register middlewares, order, static files and their headers
• reload-strategies.md — When a worker is replaced: exception, max_requests, memory, file_monitor, always and your own
• scheduler.md — #[AsTask], the workerman.task tag, schedule formats, fixed-rate runs, jitter, locks and errors
• supervisor.md — #[AsProcess], the workerman.process tag, restarts and errors
• events.md — Task and process events, built-in listeners, an error listener example
• extending.md — Tags, response strategies and where to find the other extension points
• deployment.md — systemd unit, deploy script, user and group, OPcache, config cache owner, Docker, Kubernetes, logs and stop time
• reverse-proxy.md — nginx and Caddy, trusted proxies, trusted hosts, HTTPS and HTTP/2, limits and keep-alive
• logging-monitoring.md — where logs go, Monolog, log rotation, the status command, health checks
• build-packaging.md — PHAR and standalone binary packaging
• security.md — Security hardening and trusted hosts
• troubleshooting.md — Long-running worker pitfalls and mitigations

Contributor-facing (in the source repository, not the dist archive)

• workflow.md — Issue-to-merge workflow (shared across the organization)
• release-workflow.md — Cutting a release (changelog PR, tag, release notes, milestone close)
• AGENTS.md — Project commands, gates and specifics for contributors and coding agents
• helpers/ — Contributor knowledge base (FAQ and decisions)
• superpowers/ — Design and implementation plans

For bundle usage and configuration, see the main README; for a short contributor checklist, see CONTRIBUTING.md. Contributor links above point to GitHub so they also work when reading this index from an installed dist archive; in a source checkout, the same paths are local.