From 3f18acdb1ad90a887cd6c4a518ec7eb0a65276c1 Mon Sep 17 00:00:00 2001 From: Nicholas Flamy <30300649+NicholasFlamy@users.noreply.github.com> Date: Sun, 2 Feb 2025 13:07:39 -0500 Subject: [PATCH] docs: TrueNAS: add danger message to external libraries (#15857) Add danger message to external libraries in truenas.md (Format fix included) --- docs/docs/install/truenas.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/docs/install/truenas.md b/docs/docs/install/truenas.md index c56eaf21b2bf7..049af1250e72c 100644 --- a/docs/docs/install/truenas.md +++ b/docs/docs/install/truenas.md @@ -41,7 +41,7 @@ className="border rounded-xl" :::info Permissions The **pgData** dataset must be owned by the user `netdata` (UID 999) for postgres to start. The other datasets must be owned by the user `root` (UID 0) or a group that includes the user `root` (UID 0) for immich to have the necessary permissions. -If the **library** dataset uses ACL it must have [ACL mode](https://www.truenas.com/docs/core/coretutorials/storage/pools/permissions/#access-control-lists) set to `Passthrough` if you plan on using a [storage template](/docs/administration/storage-template.mdx) and the dataset is configured for network sharing (its ACL type is set to `SMB/NFSv4`). When the template is applied and files need to be moved from **upload** to **library**, immich performs `chmod` internally and needs to be allowed to execute the command. [More info.](https://github.com/immich-app/immich/pull/13017) +If the **library** dataset uses ACL it must have [ACL mode](https://www.truenas.com/docs/core/coretutorials/storage/pools/permissions/#access-control-lists) set to `Passthrough` if you plan on using a [storage template](/docs/administration/storage-template.mdx) and the dataset is configured for network sharing (its ACL type is set to `SMB/NFSv4`). When the template is applied and files need to be moved from **upload** to **library**, Immich performs `chmod` internally and needs to be allowed to execute the command. [More info.](https://github.com/immich-app/immich/pull/13017) ::: ## Installing the Immich Application @@ -160,6 +160,10 @@ The image above has example values. ### Additional Storage [(External Libraries)](/docs/features/libraries) +:::danger Advanced Users Only +This feature should only be used by advanced users. If this is your first time installing Immich, then DO NOT mount an external library until you have a working setup. Also, your mount path MUST be something unique and should NOT be your library or upload location or a Linux directory like `/lib`. The picture below shows a valid example. +::: + You may configure [External Libraries](/docs/features/libraries) by mounting them using **Additional Storage**. -The **Mount Path** is the loaction you will need to copy and paste into the External Library settings within Immich. +The **Mount Path** is the location you will need to copy and paste into the External Library settings within Immich. The **Host Path** is the location on the TrueNAS SCALE server where your external library is located.