From b4d5f14e134a8e3b54cc214d67c0dae3cd034df4 Mon Sep 17 00:00:00 2001 From: mmomjian <50788000+mmomjian@users.noreply.github.com> Date: Tue, 30 Jan 2024 14:30:58 -0500 Subject: [PATCH] Document how to prevent HTML entity escaping. (#6773) * Update _storage-template.md * Update _storage-template.md --- docs/docs/partials/_storage-template.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/docs/partials/_storage-template.md b/docs/docs/partials/_storage-template.md index acf730e06..1156a6f9e 100644 --- a/docs/docs/partials/_storage-template.md +++ b/docs/docs/partials/_storage-template.md @@ -7,6 +7,7 @@ On new machines running version 1.92.0 storage template engine is off by default :::tip You can read more about the differences between storage template engine on and off [here](/docs/administration/backup-and-restore#asset-types-and-storage-locations) ::: + The admin user can set the template by using the template builder in the `Administration -> Settings -> Storage Template`. Immich provides a set of variables that you can use in constructing the template, along with additional custom text. If the template produces [multiple files with the same filename, they won't be overwritten](https://github.com/immich-app/immich/discussions/3324) as a sequence number is appended to the filename. ```bash title="Default template" @@ -15,4 +16,8 @@ Year/Year-Month-Day/Filename.Extension +:::tip +By default, special characters will be converted to an HTML entity (for example, `&` -> `&`). To prevent this, wrap the variable in an extra set of braces (for example, `{{{album}}}`). You can learn more about this [here](https://handlebarsjs.com/guide/expressions.html#html-escaping) and [here](https://github.com/immich-app/immich/issues/4917). +::: + Immich also provides a mechanism to migrate between templates so that if the template you set now doesn't work in the future, you can always migrate all the existing files to the new template. The mechanism is run as a job on the Job page.