Docs: minor changes (#8814)

* minor

* add image

* PR feedback

* npm run format:fix of course 4_4

* Remove what is not relevant

* pr feedback

* PR feedback

* revert npm run format

* Update docs/docs/FAQ.mdx

Co-authored-by: Ben McCann <322311+benmccann@users.noreply.github.com>

* Update FAQ.mdx

---------

Co-authored-by: Alex <alex.tran1502@gmail.com>
Co-authored-by: Ben McCann <322311+benmccann@users.noreply.github.com>

docs/README.md

@@ -1,6 +1,6 @@
 # Website
 
-This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
 
 ### Installation
 

docs/docs/FAQ.mdx

@@ -6,7 +6,7 @@
 
 The admin password can be reset by running the [reset-admin-password](/docs/administration/server-commands.md) command on the immich-server.
 
-### How can I see list of all users in Immich?
+### How can I see a list of all users in Immich?
 
 You can see the list of all users by running [list-users](/docs/administration/server-commands.md) Command on the Immich-server.
 
@@ -24,14 +24,14 @@ You can see the list of all users by running [list-users](/docs/administration/s
 
 ### I cannot log into the application after an update. What can I do?
 
-First, verify that the mobile app and server are both running the same version (major and minor).
+Verify that the mobile app and server are both running the same version (major and minor).
 
 :::note
-App store updates sometimes take longer because the stores (Google play store and Apple app store)
+App store updates sometimes take longer because the stores (Google Play Store and Apple App Store)
-need to approve the update first which may take some time.
+need to approve the update first, and it can take some time.
 :::
 
-If you still cannot login to the app, try the following:
+If you still cannot log in to the app, try the following:
 
 - Check the mobile logs
 - Make sure login credentials are correct by logging in on the web app
@@ -40,6 +40,11 @@ If you still cannot login to the app, try the following:
 
 ## Assets
 
+### Does Immich change the file?
+
+No, Immich does not touch the original file under any circumstances,  
+all edited metadata are saved in the companion sidecar file and the database.
+
 ### Can I add my existing photo library?
 
 Yes, with an [External Library](/docs/features/libraries.md).
@@ -50,11 +55,11 @@ Template changes will only apply to _new_ assets. To retroactively apply the tem
 
 ### Why are only photos and not videos being uploaded to Immich?
 
-This often happens when using a reverse proxy (such as nginx or Cloudflare tunnel) in front of Immich. Make sure to set your reverse proxy to allow large `POST` requests. In `nginx`, set `client_max_body_size 50000M;` or similar. Also check the disk space of your reverse proxy, in some cases proxies cache requests to disk before passing them on, and if disk space runs out the request fails.
+This often happens when using a reverse proxy (such as Nginx or Cloudflare tunnel) in front of Immich. Make sure to set your reverse proxy to allow large `POST` requests. In `nginx`, set `client_max_body_size 50000M;` or similar. Also, check the disk space of your reverse proxy. In some cases, proxies cache requests to disk before passing them on, and if disk space runs out, the request fails.
 
 ### Why are some photos stored in the file system with the wrong date?
 
-There are a few different scenarios that can lead to this situation. The solution is to run the storage migration job again. The job is only _automatically_ run once per asset, after upload. If metadata extraction originally failed, the jobs were cleared/cancelled, etc. the job may not have run automatically the first time.
+There are a few different scenarios that can lead to this situation. The solution is to rerun the storage migration job. The job is only automatically run once per asset after upload. If metadata extraction originally failed, the jobs were cleared/canceled, etc., the job may not have run automatically the first time.
 
 ### How can I hide photos from the timeline?
 
@@ -68,23 +73,27 @@ See [Backup and Restore](/docs/administration/backup-and-restore.md).
 
 No, it currently does not. There is an [open feature request on GitHub](https://github.com/immich-app/immich/discussions/4348).
 
-### Does Immich support filtering of NSFW images?
+### Does Immich support the filtering of NSFW images?
 
 No, it currently does not. There is an [open feature request on Github](https://github.com/immich-app/immich/discussions/2451).
 
 ### Why are there so many thumbnail generation jobs?
 
-There are three thubmanil jobs for each asset:
+There are three thumbnail jobs for each asset:
 
 - Blurred (thumbhash)
-- Small (webp)
+- Preview (Webp)
-- Large (jpeg)
+- Thumbnail (Jpeg)
 
 Also, there are additional jobs for person (face) thumbnails.
 
+### Why do files from WhatsApp not appear with the correct date?
+
+Files sent on WhatsApp are saved without metadata on the file. Therefore, Immich has no way of knowing the original date of the file when files are uploaded from WhatsApp, not the order of arrival on the device. [See #3527](https://github.com/immich-app/immich/issues/3527).
+
 ### What happens if an asset exists in more than one account?
 
-There are no requirements for assets to be unique across users. If multiple users upload the same image they are processed as if they were distinct assets and jobs run and thumbnails are generated accordingly.
+There are no requirements for assets to be unique across users. If multiple users upload the same image, it is processed as if it were a distinct asset, and jobs run and thumbnails are generated accordingly.
 
 ### Why do HDR videos appear pale in Immich player but look normal after download?
 
@@ -96,40 +105,36 @@ Immich always keeps your original files. Alongside that, it generates a transcod
 
 ### How can I delete transcoded videos without deleting the original?
 
-The transcoded version of an asset can be deleted by setting a transcode policy that makes it unnecessary, then running a transcoding job for that asset. This can be done on a per-asset basis by starting a transcoding job for a single asset with the _Refresh encoded videos_ button in the asset viewer options, or for all assets by running transcoding jobs for all assets from the administration page.
+The transcoded version of an asset can be deleted by setting a transcode policy that makes it unnecessary and then running a transcoding job for that asset. This can be done on a per-asset basis by starting a transcoding job for a single asset with the _Refresh encoded videos_ button in the asset viewer options or for all assets by running transcoding jobs for all assets from the administration page.
 
 To update the transcode policy, navigate to Administration > Video Transcoding Settings > Transcoding Policy and select a policy from the drop-down. This policy will determine whether an existing transcode will be deleted or overwritten in the transcoding job. If a video should be transcoded according to this policy, an existing transcode is overwritten. If not, then it is deleted.
 
 :::note
-For example, say you have existing transcodes with the policy "Videos higher than normal resolution or not in the desired format" and switch to a narrower policy: "Videos not in the desired format". If an asset was only transcoded due to its resolution, then running a transcoding job for it will now delete the existing transcode. This is because resolution is no longer part of the transcode policy and the transcode is unnecessary as a result. Likewise, if you set the policy to "Don't transcode any videos" and run transcoding jobs for all assets, this will delete all existing transcodes as they are all unnecessary.
+For example, say you have existing transcodes with the policy "Videos higher than normal resolution or not in the desired format" and switch to a narrower policy: "Videos not in the desired format." If an asset was only transcoded due to its resolution, running a transcoding job for it will delete the existing transcode. This is because resolution is no longer part of the transcode policy and the transcode is unnecessary. Likewise, if you set the policy to "Don't transcode any videos" and run transcoding jobs for all assets, this will delete all existing transcodes as they are unnecessary.
 :::
 
 ### Is it possible to compress images during backup?
 
-No. Our golden rule is that the original assets should always be untouched, so we don't think this feature is a good fit for Immich.
+No. Our design principle is that the original assets should always be untouched.
 
 ### How can I move all data (photos, persons, albums) from one user to another?
 
-This is not officially supported, but can be accomplished with some database updates. You can do this on the command line (in the PostgreSQL container using the `psql` command), or you can add for example an [Adminer](https://www.adminer.org/) container to the `docker-compose.yml` file, so that you can use a web-interface.
+This is not officially supported but can be accomplished with some database updates. You can do this on the command line (in the PostgreSQL container using the `psql` command), or you can add, for example, an [Adminer](https://www.adminer.org/) container to the `docker-compose.yml` file so that you can use a web interface.
-
-:::warning
-This is an advanced operation. If you can't do it with the steps described here, this is not for you.
-:::
 
 <details>
 <summary>Steps</summary>
 
 1. **MAKE A BACKUP** - See [backup and restore](/docs/administration/backup-and-restore.md).
 
-2. Find the id of both the 'source' and the 'destination' user (it's the id column in the users table)
+2. Find the ID of both the 'source' and the 'destination' user (it's the id column in the `users` table)
 
 3. Three tables need to be updated:
 
 ```sql
-// reassign albums
+// Reassign albums
 UPDATE albums SET "ownerId" = '<destinationId>' WHERE "ownerId" = '<sourceId>';
 
-// reassign people
+// Reassign people
 UPDATE person SET "ownerId" = '<destinationId>' WHERE "ownerId" = '<sourceId>';
 
 // reassign assets
@@ -159,7 +164,7 @@ No, not yet. For updates on this planned feature, follow the [GitHub discussion]
 
 ### Can I add an external library while keeping the existing album structure?
 
-We haven't put in an official mechanism to create albums from external libraries at the moment, but there are some [workarounds from the community](https://github.com/immich-app/immich/discussions/4279) to help you achieve that.
+We haven't implemented an official mechanism for creating albums from external libraries, but there are some [workarounds from the community](https://github.com/immich-app/immich/discussions/4279) to help you achieve that.
 
 ### What happens to duplicates in external libraries?
 
@@ -171,7 +176,7 @@ Duplicate checking only exists for upload libraries, using the file hash. Furthe
 
 ### How does smart search work?
 
-Immich uses CLIP models, for more information about CLIP and its capabilities read about it [here](https://openai.com/research/clip).
+Immich uses CLIP models. For more information about CLIP and its capabilities, read about it [here](https://openai.com/research/clip).
 
 ### How does facial recognition work?
 
@@ -189,12 +194,7 @@ However, disabling all jobs will not disable the machine learning service itself
 
 ### I'm getting errors about models being corrupt or failing to download. What do I do?
 
-You can delete the model cache volume, which is where models are downloaded to. This will give the service a clean environment to download the model again. If models are failing to download entirely, you can manually download them from [Huggingface](https://huggingface.co/immich-app) and place them in the cache folder.
+You can delete the model cache volume, where models are downloaded. This will give the service a clean environment to download the model again. If models are failing to download entirely, you can manually download them from [Huggingface](https://huggingface.co/immich-app) and place them in the cache folder.
-
-### Why did Immich decide to remove object detection?
-
-The feature added keywords to images for metadata search, but wasn't used for smart search. Smart search made it unnecessary as it isn't limited to exact keywords. Combined with it causing crashes on some devices, using many dependencies and causing user confusion as to how search worked, it was better to remove the job altogether.
-For more info see [here](https://github.com/immich-app/immich/pull/5903)
 
 ### Can I use a custom CLIP model?
 
@@ -208,14 +208,17 @@ You can change to a multilingual model listed [here](https://huggingface.co/coll
 Feel free to make a feature request if there's a model you want to use that isn't in [Immich Huggingface list](https://huggingface.co/immich-app).
 :::
 
-### Does Immich support Facial Recognition for videos ?
+### Does Immich support Facial Recognition for videos?
 
-Immich's machine learning feature operate on the generated thumbnail. If a face is visible in the video's thumbnail it will be picked up by facial recognition.
+Immich's machine learning feature operates on the generated thumbnail. If a face is visible in the video's thumbnail it will be picked up by facial recognition.
 Scanning the entire video for faces may be implemented in the future.
 
 ### Does Immich have animal recognition?
 
 No.
+:::tip
+You can use [Smart Search](/docs/features/smart-search.md) for this to some extent. For example, if you have a Golden Retriever and a Chihuahua, type these words in the smart search and watch the results.
+:::
 
 ### I'm getting a lot of "faces" that aren't faces, what can I do?
 
@@ -248,8 +251,8 @@ The initial backup is the most intensive due to the number of jobs running. The
 - Lower the job concurrency for these jobs to 1.
 - Under Settings > Transcoding Settings > Threads, set the number of threads to a low number like 1 or 2.
 - Under Settings > Machine Learning Settings > Facial Recognition > Model Name, you can change the facial recognition model to `buffalo_s` instead of `buffalo_l`. The former is a smaller and faster model, albeit not as good.
-  - You _must_ re-run the Face Detection job for all images after this for facial recognition on new images to work properly.
+- For facial recognition on new images to work properly, You must re-run the Face Detection job for all images after this.
-- If these changes are not enough, see [below](/docs/FAQ#how-can-i-disable-machine-learning) for how you can disable machine learning.
+- If these changes are not enough, see [below](/docs/FAQ#how-can-i-disable-machine-learning) for instructions on how to disable machine learning.
 
 ### Can I limit the amount of CPU and RAM usage?
 
@@ -280,13 +283,17 @@ On a normal machine, 2 or 3 concurrent jobs can probably max the CPU. Beyond thi
 
 Do not exaggerate with the amount of jobs because you're probably thoroughly overloading the server.
 
-More detail can be found [here](https://discord.com/channels/979116623879368755/994044917355663450/1174711719994605708)
+More details can be found [here](https://discord.com/channels/979116623879368755/994044917355663450/1174711719994605708)
 :::
 
 ### Why is Immich using so much of my CPU?
 
-When a large amount of assets are uploaded to Immich it makes sense that the CPU and RAM will be heavily used due to machine learning work and creating image thumbnails.
+When a large number of assets are uploaded to Immich, it makes sense that the CPU and RAM will be heavily used for machine learning work and creating image thumbnails.
-Once this process completes, the percentage of CPU usage will drop to around 3-5% usage
+Once this process is completed, the percentage of CPU usage will drop to around 3-5% usage
+
+### My server shows Server Status Offline | Version Unknown what can I do?
+
+You need to enable Websocket on your reverse proxy.
 
 ---
 
@@ -311,7 +318,7 @@ For a further hardened system, you can add the following block to every containe
 
 ```yaml
 security_opt:
-  # Prevent escalation of privileges after container is started
+  # Prevent escalation of privileges after the container is started
   - no-new-privileges:true
 cap_drop:
   # Prevent access to raw network traffic
@@ -322,7 +329,7 @@ cap_drop:
 
 Data for Immich comes in two forms:
 
-1. **Metadata** stored in a postgres database, persisted via the `pg_data` volume
+1. **Metadata** stored in a Postgres database, persisted via the `pg_data` volume
 2. **Files** (originals, thumbs, profile, etc.), stored in the `UPLOAD_LOCATION` folder, more [info](/docs/administration/backup-and-restore#asset-types-and-storage-locations).
 
 To remove the **Metadata** you can stop Immich and delete the volume.

docs/docs/developer/pr-checklist.md

@@ -9,7 +9,7 @@ When contributing code through a pull request, please check the following:
 - [ ] `npm run check:svelte` (Type checking via SvelteKit)
 - [ ] `npm test` (unit tests)
 
-:::tip
+:::tip AIO
 Run all web checks with `npm run check:all`
 :::
 
@@ -20,10 +20,14 @@ Run all web checks with `npm run check:all`
 - [ ] `npm run check` (Type checking via `tsc`)
 - [ ] `npm test` (unit tests)
 
-:::tip
+:::tip AIO
 Run all server checks with `npm run check:all`
 :::
 
+:::info Auto Fix
+You can use `npm run __:fix` to potentially correct some issues automatically for `npm run format` and `lint`.
+:::
+
 ## OpenAPI
 
 The OpenAPI client libraries need to be regenerated whenever there are changes to the `immich-openapi-specs.json` file. Note that you should not modify this file directly as it is auto-generated. See [OpenAPI](/docs/developer/open-api.md) for more details.

docs/docs/features/libraries.md

@@ -161,7 +161,7 @@ The christmas trip library will now be scanned in the background. In the meantim
 
 - Click on Create External Library.
 
-:::info Note
+:::note
 If you get an error here, please rename the other external library to something else. This is a bug that will be fixed in a future release.
 :::
 
@@ -175,3 +175,14 @@ If you get an error here, please rename the other external library to something
 - Click on Scan Library Files
 
 Within seconds, the assets from the old-pics and videos folders should show up in the main timeline.
+
+### Set Custom Scan Interval
+
+:::note
+Only an admin can do this.
+:::
+
+You can define a custom interval for the trigger external library rescan under Administration -> Settings -> Library.  
+You can set the scanning interval using the preset or cron format. For more information please refer to e.g. [Crontab Guru](https://crontab.guru/)
+
+<img src={require('./img/library-custom-scan-interval.png').default} width="75%" title='Set custom scan interval for external library' />

docs/docs/features/ml-hardware-acceleration.md

@@ -10,7 +10,7 @@ You do not need to redo any machine learning jobs after enabling hardware accele
 ## Supported Backends
 
 - ARM NN (Mali)
-- CUDA (NVIDIA)
+- CUDA (NVIDIA) Note: It is supported with [compute capability](https://developer.nvidia.com/cuda-gpus) 5.2 or higher
 - OpenVINO (Intel)
 
 ## Limitations

docs/docs/guides/database-gui.md

@@ -45,5 +45,5 @@ Open pgAdmin and click "Add New Server".
 Click on "Save" to connect to the Immich database.
 
 :::tip
-View [Database Queries](https://immich.app/docs/guides/database-queries/) for common database queries.
+View [Database Queries](/docs/guides/database-queries/) for common database queries.
 :::

docs/docs/guides/database-queries.md

@@ -86,3 +86,9 @@ SELECT "key", "value" FROM "system_config";
 ```
 
 (Only used when not using the [config file](/docs/install/config-file))
+
+## Persons
+
+```sql title="Delete person and unset it for the faces it was associated with"
+DELETE FROM person WHERE name = 'PersonNameHere';
+```

docs/docs/guides/external-library.md

@@ -14,12 +14,6 @@ Edit `docker-compose.yml` to add two new mount points under `volumes:`
       - ${EXTERNAL_PATH}:/usr/src/app/external
 ```
 
-```
-  immich-microservices:
-    volumes:
-      - ${EXTERNAL_PATH}:/usr/src/app/external
-```
-
 Be sure to add exactly the same line to both `immich-server:` and `immich-microservices:`.
 
 Edit `.env` to define `EXTERNAL_PATH`, substituting in the correct path for your computer:

docs/docs/guides/remote-machine-learning.md

@@ -6,10 +6,14 @@ To alleviate [performance issues on low-memory systems](/docs/FAQ.mdx#why-is-imm
 - Copy the following `docker-compose.yml` to your ML system.
 - Start the container by running `docker compose up -d`.
 
-:::note Info
+:::info
 Starting with version v1.93.0 face detection work and face recognize were split. From now on face detection is done in the immich_machine_learning service, but facial recognition is done in the immich_microservices service.
 :::
 
+:::note
+The [hwaccel.ml.yml](https://github.com/immich-app/immich/releases/latest/download/hwaccel.ml.yml) file also needs to be in the same folder if trying to use [hardware acceleration](/docs/features/ml-hardware-acceleration).
+:::
+
 ```yaml
 version: '3.8'
 

docs/docs/install/docker-compose.mdx

@@ -8,6 +8,7 @@ import ExampleEnv from '!!raw-loader!../../../docker/example.env';
 # Docker Compose [Recommended]
 
 Docker Compose is the recommended method to run Immich in production. Below are the steps to deploy Immich with Docker Compose.  
+Immich requires Docker Compose version 2.x.
 
 ### Step 1 - Download the required files
 

docs/docs/partials/_user-create.md

@@ -1,3 +1,3 @@
-If you have friends or family members who want to use the application as well, you can create addition accounts. The default password is `password`, and the user can change their password after logging in to the application for the first time.
+If you have friends or family members who want to use the application as well, you can create addition accounts. The default password is `password`, and the user has to change their password after logging in to the application for the first time. The system administrator can disable this option by unchecking the option "Require user to change password on first login" in the user registration interface.
 
-<img src={require('./img/create-new-user.png').default} title='Admin Registration' />
+<img src={require('./img/create-new-user.png').default} width="90%" title='New User Registration' />

docs/docusaurus.config.js

@@ -144,6 +144,10 @@ const config = {
                 label: 'Discord',
                 href: 'https://discord.com/invite/D8JsnBEuKb',
               },
+              {
+                label: 'Reddit',
+                href: 'https://www.reddit.com/r/immich/',
+              },
             ],
           },
           {
@@ -157,6 +161,10 @@ const config = {
                 label: 'GitHub',
                 href: 'https://github.com/immich-app/immich',
               },
+              {
+                label: 'YouTube',
+                href: 'https://www.youtube.com/@immich-app',
+              },
             ],
           },
         ],

docs/src/pages/milestones.tsx

@@ -51,12 +51,22 @@ import {
   mdiVideo,
   mdiWeb,
   mdiScaleBalance,
+  mdiMagnifyScan,
 } from '@mdi/js';
 import Layout from '@theme/Layout';
 import React from 'react';
 import Timeline, { DateType, Item } from '../components/timeline';
 
 const items: Item[] = [
+  {
+    icon: mdiMagnifyScan,
+    description: 'Advanced search with filters by date, location and more',
+    title: 'Search enhancement with advanced filters',
+    release: 'v1.95.0',
+    tag: 'v1.95.0',
+    date: new Date(2024, 1, 20),
+    dateType: DateType.RELEASE,
+  },
   {
     icon: mdiScaleBalance,
     description: 'Immich switches to AGPLv3 license',

machine-learning/README.md

@@ -7,7 +7,7 @@
 
 This project uses [Poetry](https://python-poetry.org/docs/#installation), so be sure to install it first.
 Running `poetry install --no-root --with dev --with cpu` will install everything you need in an isolated virtual environment.
-CUDA and OpenVINO are supported as acceleration APIs. To use them, you can replace `--with cpu` with either of `--with cuda` or `--with openvino`.
+CUDA and OpenVINO are supported as acceleration APIs. To use them, you can replace `--with cpu` with either of `--with cuda` or `--with openvino`. In the case of CUDA, a [compute capability](https://developer.nvidia.com/cuda-gpus) of 5.2 or higher is required.
 
 To add or remove dependencies, you can use the commands `poetry add $PACKAGE_NAME` and `poetry remove $PACKAGE_NAME`, respectively.
 Be sure to commit the `poetry.lock` and `pyproject.toml` files with `poetry lock --no-update` to reflect any changes in dependencies.