You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: pages/templates/building-a-template.mdx
+40-14Lines changed: 40 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -163,32 +163,58 @@ public layoutMetadata = {
163
163
164
164
## Registering a Custom Template
165
165
166
-
### In the standard UI build
166
+
### Via additional-templates.json
167
167
168
-
Add the template path to your `.env`:
168
+
Templates are registered in `additional-templates.json` in the `uverify-ui` project root. This file is read at build time by `config.js` and supports two entry types.
Then rebuild the UI. The template will be available under the `id` you choose (the template ID used in `uverify_template_id` metadata is the key in this variable, lowercased).
196
+
<Callouttype="info">
197
+
The `commit` field pins the exact revision used in the build. This makes external templates fully auditable and prevents unexpected upstream changes from affecting your deployment. To update a template, change the `commit` hash and rebuild.
198
+
</Callout>
199
+
200
+
After editing `additional-templates.json`, run `node config.js` to regenerate the template registry and then start or rebuild the UI.
201
+
202
+
### Publishing to app.uverify.io
203
+
204
+
To have your template included in the standard deployment at [app.uverify.io](https://app.uverify.io), open a pull request against the [`uverify-ui`](https://github.com/UVerify-io/uverify-ui) repository adding a `repository` entry for your template. All proposed templates are reviewed for security issues before being merged.
205
+
206
+
Use the **Add External Template** issue template in `uverify-ui` to start the conversation before opening a PR.
181
207
182
-
### With Docker (custom image)
208
+
### With Docker (self-hosted)
183
209
184
-
Use the custom Docker image that builds at container start, and mount your template directory:
210
+
For self-hosted deployments, use the custom Docker image that builds at container start and mount your template directory:
0 commit comments