Merge branch 'immich-app:main' into FAQ-edit

docs/docs/features/facial-recognition.md

@@ -25,6 +25,6 @@ Additional actions you can do with a detected person are:
 - Merge two or more detected faces into one person
 - Hide face
 
-It can be found from the app bar when you access the detial view of a person
+It can be found from the app bar when you access the detail view of a person.
 
 <img src={require('./img/facial-recognition-4.png').default} title='Facial Recognition 4' width="70%"/>

docs/docs/features/hardware-transcoding.md

@@ -43,12 +43,28 @@ As this is a new feature, it is still experimental and may not work on all syste
 
 ## Setup
 
+#### Initial Setup
+
 1. If you do not already have it, download the latest [`hwaccel.yml`][hw-file] file and ensure it's in the same folder as the `docker-compose.yml`.
 2. Uncomment the lines that apply to your system and desired usage.
 3. In the `docker-compose.yml` under `immich-microservices`, uncomment the lines relating to the `hwaccel.yml` file.
 4. Redeploy the `immich-microservices` container with these updated settings.
 5. In the Admin page under `FFmpeg settings`, change the hardware acceleration setting to the appropriate option and save.
 
+#### All-In-One - Unraid Setup
+
+##### NVENC - NVIDIA GPUs
+
+- If you are using other backends. You will still need to implement [`hwaccel.yml`][hw-file] file into the `immich-microservices` service directly, please see the "Initial Setup" section above on how to do that.
+- As of v1.92.0, steps 1 and 2 are no longer necessary. If your version of Immich is below that or missing the environment variables, please follow these steps. Otherwise, skip to step 3.
+- Please note that`NVIDIA_DRIVER_CAPABILITIES` is no longer required to enter as a variable.
+
+1. Assuming you already have the Nvidia Driver Plugin installed on your Unraid Server. Please confirm that your Nvida GPU is showing up with its GPU ID in the Nvidia Driver Plugin. The ID will be `GPU-LONG_STRING_OF_CHARACTERS`. Copy the GPU ID.
+2. In the Imagegenius/Immich Docker Container app, add two new variables: Key=`NVIDIA_VISIBLE_DEVICES` Value=`GPU-LONG_STRING_OF_CHARACTERS` and Key=`NVIDIA_DRIVER_CAPABILITIES` Value=`all`
+3. While you are in the docker container app, change the Container from Basic Mode to Advanced Mode and add the following parameter to the Extra Parameters field: `--runtime=nvidia`
+4. Restart the Imagegenius/Immich Docker Container app.
+5. In the Admin page under FFmpeg settings, change the hardware acceleration setting to the appropriate option and save.
+
 ## Tips
 
 - You may want to choose a slower preset than for software transcoding to maintain quality and efficiency

docs/docs/features/libraries.md

@@ -12,6 +12,26 @@ Immich comes preconfigured with an upload library for each user. All assets uplo
 
 External libraries tracks assets stored outside of immich, i.e. in the file system. Immich will only read data from the files, and will not modify them in any way. Therefore, the delete button is disabled for external assets. When the external library is scanned, immich will read the metadata from the file and create an asset in the library for each image or video file. These items will then be shown in the main timeline, and they will look and behave like any other asset, including viewing on the map, adding to albums, etc.
 
+# Step by Step Guide
+
+In order to create an external library, the administrator must:
+
+- Click on 'Administration' (top right).
+- Click on 'Edit' next to the user.
+- Set the external path - this would be the path that is exposed to the immich microservices service.
+- Click 'Confirm'.
+- Click into the user profile (top right) then click into 'Libraries'.
+- Click 'Create External Library'.
+- Next to the new library, click the three dots, then click 'Edit Import Paths'.
+- Set up your path relative to the external path you set earlier - e.g., if you set the external path to be `/mnt/media/external` and your Import Paths to `/photos`, then you will end up with `/mnt/media/external/photos`.
+- Click 'Save'.
+- Click 'Scan All Libraries'.
+
+To confirm it's working, you can open up a Docker shell for the immich microservices, and you should see similar outputs to this:
+`[Nest] 7 - 11/24/2023, 1:06:39 AM LOG [MediaService] Successfully generated WEBP image thumbnail for asset b6d37673-5931-4b25-8380-89135021f48b`
+
+# Scanning functionality
+
 If a file is modified outside of Immich, the changes will not be reflected in immich until the library is scanned again. There are different ways to scan a library depending on the use case:
 
 - Scan Library Files: This is the default scan method and also the quickest. It will scan all files in the library and add new files to the library. It will notice if any files are missing (see below) but not check existing assets

docs/docs/guides/remote-access.md

@@ -42,7 +42,7 @@ If you are unable to open a port on your router for Wireguard or OpenVPN to your
 
 A reverse proxy is a service that sits between web servers and clients. A reverse proxy can either be hosted on the server itself or remotely. Clients can connect to the reverse proxy via https, and the proxy relays data to Immich. This setup makes most sense if you have your own domain and want to access your Immich instance just like any other website, from outside your LAN. You can also use a DDNS provider like DuckDNS or no-ip if you don't have a domain. This configuration allows the Immich Android and iphone apps to connect to your server without a VPN or tailscale app on the client side.
 
-If you're hosting your own reverse proxy, [Nginx](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/) is a great option. An example configuration for Nginx is provided [here](https://immich.app/docs/administration/reverse-proxy).
+If you're hosting your own reverse proxy, [Nginx](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/) is a great option. An example configuration for Nginx is provided [here](/docs/administration/reverse-proxy.md).
 
 You'll also need your own certificate to authenticate https connections. If you're making Immich publicly accesible, [Let's Encrypt](https://letsencrypt.org/) can provide a free certificate for your domain and is the recommended option. Alternatively, a [self-signed certificate](https://en.wikipedia.org/wiki/Self-signed_certificate) allows you to encrypt your connection to Immich, but it raises a security warning on the client's browser.
 

docs/docs/install/config-file.md

@@ -142,4 +142,4 @@ So you can just grab it from there, paste it into a file and you're pretty much
 ### Step 2 - Specify the file location
 
 In your `.env` file, set the variable `IMMICH_CONFIG_FILE` to the path of your config.
-For more information, refer to the [Environment Variables](https://docs.immich.app/docs/install/environment-variables) section.
+For more information, refer to the [Environment Variables](/docs/install/environment-variables.md) section.