]> git.kaiwu.me - haproxy.git/commit
DOC: lua: Document the filter instance declaration of Lua filters
authorChristopher Faulet <cfaulet@haproxy.com>
Wed, 7 Oct 2026 19:18:36 +0000 (21:18 +0200)
committerChristopher Faulet <cfaulet@haproxy.com>
Fri, 9 Oct 2026 14:17:36 +0000 (16:17 +0200)
commit73bd8d7e5667cf0fcc56991f62ca599154c71bc7
treef3cc8dfb2ee4c239eb564dcc5b43de236376ff0a
parent119636bef661b12ae176b63101c04496ce2aeae4
DOC: lua: Document the filter instance declaration of Lua filters

The filter instance mode documentation claims that the supported filter
classes are documented in the section 9 of the configuration manual, but
the Lua filters are missing: they are not built-in classes, they are
registered by the Lua scripts with core.register_filter() and are
declared with the "lua" filter class. The Lua API documentation only
shows the legacy declaration of a Lua filter.

Document the "filter-config lua id <name>" declaration in the Lua API
documentation, next to the legacy one: the instance id selects the
registered filter to instantiate, the optional "enabled" token activates
the instance, and the other arguments are the same as for the legacy
declaration. Mention that contrary to the legacy "filter" directive, the
Lua filters may be declared in defaults sections with the new mode, to
be inherited by the proxies using them. Finally, point to the Lua API
documentation from the introduction of the section 9.
doc/configuration.txt
doc/lua-api/index.rst