Getting help

xtandard-image is a personal project, maintained by one person in their spare time and provided as is (disclaimer). There is no paid support and no SLA; help is best effort. These are the places to go, in order:

1. Docs first. Start with Getting started. The rest of the documentation:

   • CONFIG: every setting;
   • SOURCES: where images come from;
   • URL-DIALECTS: how to write URLs in each dialect;
   • FORMATS: what each flavour reads and writes;
   • DEPLOY and OPERATIONS: running it in production.

   xtandard-image config validate explains most startup errors. The server’s 4xx error bodies name the failed check, for example the source allowlist, a limit or the unsigned policy.

2. Search the issues, open and closed.

3. Open an issue. Use the bug report template for something broken. Use the feature request template for a missing option, format, dialect or platform. Questions are welcome as issues too. Include your flavour, version and the URL or configuration involved, with secrets removed.

A security vulnerability never goes in an issue. Report it privately, as SECURITY.md explains.

The official clients in clients/, @xtandard/image included, are supported here too. Open issues for them in this repository.