Skip to content

Authoring Templates

Jump to bottom
Théophile Diot edited this page Oct 22, 2025 · 1 revision

Layout:

  • templates/<template-name>/
    • template.json
    • configs/ (optional, e.g., configs/modsec/)
    • README.md (optional)

Conventions:

  • Directory names: lowercase-kebab-case.
  • JSON: two-space indent, double quotes, no trailing commas.
  • Self-contained: do not reference files outside the template directory.
  • Steps: concise titles/subtitles; group related settings and configs.

ModSecurity/NGINX notes:

  • Keep snippets minimal and commented when relaxing defaults.
  • Lint where possible; document assumptions in the template README.

Licensing:

  • Submit only GPL-3.0 compatible content. See LICENSE.

Helpful references:

Clone this wiki locally