From 6db62fc8bed3395a9f703c38419f98fb78a3083f Mon Sep 17 00:00:00 2001 From: Michael Martin Date: Tue, 18 Jul 2023 15:12:17 -0700 Subject: [PATCH] docs(wasm): expand inline kong.conf doc strings --- kong.conf.default | 34 ++++++++++++++++++++++++++++++---- 1 file changed, 30 insertions(+), 4 deletions(-) diff --git a/kong.conf.default b/kong.conf.default index 3340ee0c75e2..b960bf2f1881 100644 --- a/kong.conf.default +++ b/kong.conf.default @@ -1957,8 +1957,34 @@ # WASM #------------------------------------------------------------------------------ -#wasm = off # Use this setting to enable wasm, this allows running - # wasm filters to process request data. +#wasm = off # Enable/disable wasm support. This must be enabled in + # order to use wasm filters and filter chains. -#wasm_filters_path = # Path to the directory containing Wasm filters - # that Kong must load on startup. +#wasm_filters_path = # Path to the directory containing wasm filter modules. + # + # At startup, Kong discovers available wasm filters by + # scanning this directory for files with the `.wasm` + # file extension. + # + # The name of a wasm filter module is derived from the + # filename itself, with the .wasm extension removed. So, + # given the following tree: + # + # ``` + # /path/to/wasm_filters + # ├── my_module.wasm + # ├── my_other_module.wasm + # └── not_a_wasm_module.txt + # ``` + # + # The resulting filter modules available for use in Kong + # will be: + # + # * `my_module` + # * `my_other_module` + # + # Notes: + # + # * No recursion is performed. Only .wasm files at the + # top level are registered + # * This path _may_ be a symlink to a directory.