Skip to content

Getting Started

Théophile Diot edited this page Oct 22, 2025 · 2 revisions

Follow these steps to use a template:

  1. Pick a template
  • Browse the catalog and review its template.json and configs.
  1. Import the template
  • Web UI: Import the template via the RAW mode of the new template page (recommended)
  • Plugin bundle: copy the whole directory into your plugin’s templates/.
  1. Assign to your service
  • Easy mode UI: select the template.
  • Or set USE_TEMPLATE= for the service.
  1. Customize the essentials
  • SERVER_NAME, REVERSE_PROXY_HOST, upload size, rate limits, CRS plugins, etc.
  1. Validate quickly
  • JSON: jq . templates//template.json
  • NGINX snippet (where applicable): nginx -t -c <(printf 'events{} http{ include templates//configs/.conf; }')
  1. Test end-to-end
  • Confirm 200/304 for static assets, login flows, large uploads, and admin pages.

See:

Clone this wiki locally