cjones/immich
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore(docs): clean up and add new content (#15003)

Browse Source 
* wip: Install

* wip: sharing

* wip: features

* wip: features

* wip: tags and folder view

* update links

* fix: broken reference to page sections

* pr feedback

* Update docs/docs/overview/comparison.md

Co-authored-by: Daniel Dietzler <36593685+danieldietzler@users.noreply.github.com>

* webp

* webp is glory

* webp is glory

---------

Co-authored-by: Daniel Dietzler <36593685+danieldietzler@users.noreply.github.com>
This commit is contained in:
Alex
2025-01-02 10:04:14 -06:00
committed by GitHub
parent 8641ab82e1
commit 6239365f68
258 changed files with 311 additions and 530 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/docs/partials/_storage-template.md
+9 -6
View File
@@ -1,9 +1,5 @@
Immich allows the admin user to set the uploaded filename pattern at the directory and filename level as well as the [storage label for a user](/docs/administration/user-management/#set-storage-label-for-user).
:::note new version
On new machines running version 1.92.0 storage template engine is off by default, for [more info](https://github.com/immich-app/immich/releases/tag/v1.92.0#:~:text=the%20partner%E2%80%99s%20assets.-,Hardening%20storage%20template,-We%20have%20further).
:::
:::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)
:::
@@ -16,11 +12,18 @@ Year/Year-Month-Day/Filename.Extension
If you want to change the storage template during the initial setup, first enable the feature.
<img src={require('./img/enable-storage-template.png').default} width="100%" title="Enable Storage Template Setting" />
<img src={require('./img/enable-storage-template.webp').default} width="80%" title="Enable Storage Template Setting" />
Then, customize your storage template.
<img src={require('./img/storage-template.png').default} width="100%" title="Storage Template Setting" />
<img src={require('./img/storage-template.webp').default} width="80%" title="Storage Template Setting" />
:::info
The `Storage Template Migration` job can be run after enabling this feature or changing the template, in order to apply the changes to the existing library.
<img src={require('./img/storage-template-migration-job.webp').default} width="80%" title="Storage Template Setting" />
:::
:::tip
If an asset is in multiple albums, `{{album}}` will be set to the name of the album which was most recently created. By default, special characters will be converted to an HTML entity (for example, `&` -> `&amp;`). 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).