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

Update added and re -arrangement of FAQ

Browse Source
This commit is contained in:
aviv
2023-12-24 01:13:13 +02:00
parent 83da1c74fc
commit 83315804be
23 changed files with 437 additions and 123 deletions
Download Patch File Download Diff File Expand all files Collapse all files

122
docs/docs/FAQ.md
View File

@@ -1,122 +0,0 @@
---
sidebar_position: 7
---
# FAQ
### What is the difference between the cloud icon on the mobile app?
| Icon | Description |
| ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| ![cloud](/img/cloud.svg) | Asset is only available in the cloud and was uploaded from some other device (like the web client) or was deleted from this device after upload |
| ![cloud-cross](/img/cloud-off.svg) | Asset is only available locally and has not yet been backed up |
| ![cloud-done](/img/cloud-done.svg) | Asset was uploaded from this device and is now backed up in the cloud/server and still available in original on the device |
### Can I add my existing photo library?
Yes, with an [external library](/docs/features/libraries.md).
### Why are only photos and not videos being uploaded to Immich?
This often happens when using a reverse proxy 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. Cloudflare tunnels are limited to 100 mb file sizes. Also check the disk space of your reverse proxy, in some cases proxies caches requests to disk before passing them on, and if disk space runs out the request fails.
### Why is Immich slow on low-memory systems like the Raspberry Pi?
Immich optionally uses machine learning for several features. However, it can be too heavy to run on a Raspberry Pi. You can [mitigate](/docs/FAQ#how-can-i-lower-immichs-cpu-usage) this or [disable](/docs/FAQ.md#how-can-i-disable-machine-learning) machine learning entirely.
### How can I lower Immich's CPU usage?
The initial backup is the most intensive due to the number of jobs running. The most CPU-intensive ones are transcoding and machine learning jobs (Tag Images, Smart Search, Recognize Faces), and to a lesser extent thumbnail generation. Here are some ways to lower their CPU usage:
- 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 Recognize Faces job for all images after this for facial recognition on new images to work properly.
- If these changes are not enough, see [below](/docs/FAQ.md#how-can-i-disable-machine-learning) for how you can disable machine learning.
### How can I disable machine learning?
:::info
Disabling machine learning will result in a poor experience for searching and the 'Explore' page, as these are reliant on it to work as intended.
:::
Machine learning can be disabled under Settings > Machine Learning Settings, either entirely or by model type. For instance, you can choose to disable smart search with CLIP, but keep facial recognition enabled. This means that the machine learning service will only process the enabled jobs.
However, disabling all jobs will not disable the machine learning service itself. To prevent it from starting up at all in this case, you can comment out the `immich-machine-learning` section of the docker-compose.yml.
### 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. This will give the service a clean environment to download the model again.
### What happens to existing files after I choose a new [Storage Template](/docs/administration/storage-template.mdx)?
Template changes will only apply to new assets. To retroactively apply the template to previously uploaded assets, run the Storage Migration Job, available on the [Jobs](/docs/administration/jobs.md) page.
### In the uploads folder, why are photos stored in the wrong date?
This is fixed by running the storage migration job.
### Why are there so many thumbnail generation jobs?
Immich generates three thumbnails for each asset (blurred, small, and large), as well as a thumbnail for each recognized face.
### How can I see Immich logs?
Most Immich components are typically deployed using docker. To see logs for deployed docker containers, you can use the [Docker CLI](https://docs.docker.com/engine/reference/commandline/cli/), specifically the `docker logs` command. For examples, see [Docker Help](/docs/guides/docker-help.md)
### How can I run Immich as a non-root user?
1. Set the `PUID`/`PGID` environment variables (in `.env`).
2. Set the corresponding `user` argument in `docker-compose` for each service.
3. Add an additional volume to `immich-microservices` that mounts internally to `/usr/src/app/.reverse-geocoding-dump`.
The non-root user/group needs read/write access to the volume mounts, including `UPLOAD_LOCATION`.
### How can I reset the admin password?
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 backup data from Immich?
See [backup and restore](/docs/administration/backup-and-restore.md).
### How can I **purge** data from Immich?
Data for Immich comes in two forms:
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.
To remove the **Metadata** you can stop Immich and delete the volume.
```bash title="Remove Immich (containers and volumes)"
docker-compose down -v
```
After removing the containers and volumes, the **Files** can be cleaned up (if necessary) from the `UPLOAD_LOCATION` by simply deleting an unwanted files or folders.
### How can I move all data (photos, persons, albums) from one user to another?
This requires some database queries. 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 to do it with the steps described here, this is not for you.
:::
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)
3. Three tables need to be updated:
```sql
// reassign albums
update albums set "ownerId" = '<destinationId>' where "ownerId" = '<sourceId>';
// reassign people
update person set "ownerId" = '<destinationId>' where "ownerId" = '<sourceId>';
// reassign assets
update assets set "ownerId" = '<destinationId>' where "ownerId" = '<sourceId>'
and checksum not in (select checksum from assets where "ownerId" = '<destinationId>');
```
4. There might be left-over assets in the 'source' user's library if they are skipped by the last query because of duplicate checksums. These are probably duplicates anyway, and can probably be removed.

12
docs/docs/FAQ/Albums-FAQ.md Normal file
View File

@@ -0,0 +1,12 @@
---
sidebar_position: 4
---
# Albums
### Can I import assets to Immich while maintaining Existing Structure Albume?
Yes you can by using Immich CLI with -a command, see [this document](http://localhost:3005/docs/features/command-line-interface) for more info.
### there is a way to select the order in which photos are presented when an album is opened?
Not yet, but it's [something planned](https://github.com/immich-app/immich/discussions/1689)

63
docs/docs/FAQ/Assets-FAQ.md Normal file
View File

@@ -0,0 +1,63 @@
---
sidebar_position: 3
---
# Assets
### Can I add my existing photo library?
Yes, with an [external library](/docs/features/libraries.md).
### What happens to existing files after I choose a new [Storage Template](/docs/administration/storage-template.mdx)?
Template changes will only apply to new assets. To retroactively apply the template to previously uploaded assets, run the Storage Migration Job, available on the [Jobs](/docs/administration/jobs.md) page.
### Why are only photos and not videos being uploaded to Immich?
This often happens when using a reverse proxy 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 caches requests to disk before passing them on, and if disk space runs out the request fails.
### In the uploads folder, why are photos stored in the wrong date?
This is fixed by running the storage migration job.
### How can I backup data from Immich?
See [backup and restore](/docs/administration/backup-and-restore.md).
### Does Immich supports reading faces tags from the Exif?
not at this moment
### Does Immich support filtering of images defined as NSFW?
As of now, this option is not implemented, but it seems that there is an [open discussion about it
On Github](https://github.com/immich-app/immich/discussions/2451) you can submit a pull request or vote for the discussion
### Why are there so many thumbnail generation jobs?
Immich generates three thumbnails for each asset (blurred, small, and large), as well as a thumbnail for each recognized face.
### How can I move all data (photos, persons, albums) from one user to another?
This requires some database queries. 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 to do it with the steps described here, this is not for you.
:::
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)
3. Three tables need to be updated:
```sql
// reassign albums
UPDATE albums SET "ownerId" = '<destinationId>' WHERE "ownerId" = '<sourceId>';
// reassign people
UPDATE person SET "ownerId" = '<destinationId>' WHERE "ownerId" = '<sourceId>';
// reassign assets
UPDATE assets SET "ownerId" = '<destinationId>' WHERE "ownerId" = '<sourceId>'
AND CHECKSUM NOT IN (SELECT CHECKSUM FROM assets WHERE "ownerId" = '<destinationId>');
```
4. There might be left-over assets in the 'source' user's library if they are skipped by the last query because of duplicate checksums. These are probably duplicates anyway, and can probably be removed.

62
docs/docs/FAQ/Docker-FAQ.md Normal file
View File

@@ -0,0 +1,62 @@
---
sidebar_position: 6
---
# Docker
## Docker General
### How can I see Immich logs?
Most Immich components are typically deployed using docker. To see logs for deployed docker containers, you can use the [Docker CLI](https://docs.docker.com/engine/reference/commandline/cli/), specifically the `docker logs` command. For examples, see [Docker Help](/docs/guides/docker-help.md)
### How can I run Immich as a non-root user?
1. Set the `PUID`/`PGID` environment variables (in `.env`).
2. Set the corresponding `user` argument in `docker-compose` for each service.
3. Add an additional volume to `immich-microservices` that mounts internally to `/usr/src/app/.reverse-geocoding-dump`.
The non-root user/group needs read/write access to the volume mounts, including `UPLOAD_LOCATION`.
### How can I **purge** data from Immich?
Data for Immich comes in two forms:
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.
To remove the **Metadata** you can stop Immich and delete the volume.
```bash title="Remove Immich (containers and volumes)"
docker compose down -v
```
After removing the containers and volumes, the **Files** can be cleaned up (if necessary) from the `UPLOAD_LOCATION` by simply deleting an unwanted files or folders.
## Docker errors
### I am getting `Could not find image processor` ERROR class in ML containers what can i do?
:::note
This problem is irrelevant if Immich runs on a higher version from V1.91.5 and above
:::
if you getting this logs:
<details>
<summary>Could not find image processor class in the image processor config or the model config.</summary>
```
2023-12-14 12:44:17 Could not find image processor class in the image processor config or the model config. Loading based on pattern matching with the model's feature extractor configuration.
ERROR [JobService] Unable to run job handler (objectTagging/classify-image): TypeError: fetch failed
ERROR [JobService] TypeError: fetch failed
at Object.fetch (node:internal/deps/undici/undici:11730:11)
at async MachineLearningRepository.post (/usr/src/app/dist/infra/repositories/machine-learning.repository.js:16:21)
at async SmartInfoService.handleClassifyImage (/usr/src/app/dist/domain/smart-info/smart-info.service.js:55:22)
at async /usr/src/app/dist/domain/job/job.service.js:112:37
at async Worker.processJob (/usr/src/app/node_modules/bullmq/dist/cjs/classes/worker.js:387:28)
at async Worker.retryIfFailed (/usr/src/app/node_modules/bullmq/dist/cjs/classes/worker.js:574:24)
```
</details>
It means the model could not be exported to ONNX. I think this error happens is specific to ARM devices. You can disable Image Tagging in the admin settings to avoid this issue[[1]](https://discord.com/channels/979116623879368755/1184823648364798092/1184823806708166696)

14
docs/docs/FAQ/External Library-FAQ.md Normal file
View File

@@ -0,0 +1,14 @@
---
sidebar_position: 3
---
# External Library
### Can I add external library with existing structure albume?
We haven't put in an official mechanism to create album from your external library yet, but there are some [workarounds from the community](https://github.com/immich-app/immich/discussions/4279) which you can find here to help you achieve that.
### I got Duplicate files on Uploaded and External Library
It is important to remember that Immich does not filter duplicate files from [external Library](/docs/features/libraries),
Uploaded and External library use different dedup mechanism, upload library use file hash/checksum while external library use [file path](http://localhost:3005/docs/features/libraries#:~:text=In%20external%20libraries%2C%20the%20file%20path%20is%20used%20for%20duplicate%20detection.)
Therefore, a situation where the same file appears twice in the timeline is possible

6
docs/docs/FAQ/FAQ-General.md Normal file
View File

@@ -0,0 +1,6 @@
---
sidebar_position: 1
---
# FAQ General

125
docs/docs/FAQ/Machine-Learning-FAQ.md Normal file
View File

@@ -0,0 +1,125 @@
---
sidebar_position: 6
---
# Machine Learning
### What is the technology that Immich use for machine learning?
- For search function (smart search) - Immich uses Clip Models, for more information about Clip and its capabilities can be [read here](https://openai.com/research/clip) and [experience here](https://huggingface.co/models?pipeline_tag=zero-shot-image-classification&sort=trending).
- For face detection and recognition, Immich uses [Insightface Model Zoo models](https://github.com/deepinsight/insightface/tree/master/model_zoo).
### How can I disable machine learning?
:::info
Disabling machine learning will result in a poor experience for searching and the 'Explore' page, as these are reliant on it to work as intended.
:::
Machine learning can be disabled under Administration > Settings > Machine Learning Settings, either entirely or by model type. For instance, you can choose to disable smart search with CLIP, but keep facial recognition enabled. This means that the machine learning service will only process the enabled jobs.
However, disabling all jobs will not disable the machine learning service itself. To prevent it from starting up at all in this case, you can comment out the `immich-machine-learning` section of the docker-compose.yml.
### 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. This will give the service a clean environment to download the model again.
### What is the technology that Immich works on for machine learning?
* For image classification models listed [here](https://huggingface.co/models?pipeline_tag=image-classification&sort=trending). It must be tagged with the 'Image Classification' task and must support ONNX conversion
* For the search function ~ smart search Immich uses CLIP models. More information about CLIP and its capabilities can be read [here](https://openai.com/research/clip) and tried [here](https://huggingface.co/models?pipeline_tag=zero-shot-image-classification)
* For facial recognition Immich uses each of the InsightFace Model Zoo models. You can look at the model differences in detail [here](https://github.com/deepinsight/insightface/blob/c2db41402c627cab8ea32d55da591940f2258276/model_zoo/README.md#insightface-model-zoo)
### Why did Immich decide to remove object detection?
It was deprecated because it wasn't really used and caused crashes for some users.
users often confuse it with the more useful smart search feature.
For more info see [here](https://github.com/immich-app/immich/pull/5903)
### What is the best order for ML to best work
Because Immich is relies on thumbnail generation
For machine learning [[1](http://localhost:3005/docs/developer/architecture#:~:text=For%20example%2C%20Smart%20Search%20and%20Facial%20Recognition%20relies%20on%20thumbnail%20generation)], it is recommended to wait for the thumbnail generation job to finish and then run the machine learning jobs (Smart Search and Facial Recognition)
* Let all jobs run except the machine learning jobs and wait for them to finish
* Run Smart Search
* Run Facial Recognition
### What are the best ML models I can use for Immich
:::info
It is important to know that these models greatly enhance the Immich ML, but you should know that they require more processing power and more storage and working memory (RAM) If you are using an old computer or Raspberry Pi for Immich you may want to look at [how to use machine learning remotely](/docs/guides/machine-learning) to run the machine learning on a higher performance computer.
:::
:::tip
You can check how much model processing power will be required by checking Flops(B) in [this table](https://github.com/mlfoundations/open_clip/blob/main/docs/openclip_results.csv)
The higher the value this indicates increased consumption of server resources.
:::
* For Facial recognition the best model will be `buffalo_l`.
<details>
<summary>why is it?</summary>
from this [deepinsight/insightface#1820](https://github.com/deepinsight/insightface/issues/1820) it looks like the "r100 glint360k model" (which seems [antelopev2](https://github.com/deepinsight/insightface/blob/master/python-package/README.md)) performs worse than the `buffalo_l` model because the latter is trained on more data with a better training schedule. Seems like there is a reason that insightface does not promote the `antelopev2` model and prefers the `buffalo_l`[[1](https://github.com/deepinsight/insightface/issues/1820#issuecomment-968200625)].
Glint360k (of `antelopev2`) is 360k identities and 17M images.
WebFace600K(600K identities) is same as WebFace12M(12 million images), a subset of WebFace42M(cleaned WebFace260M)[[2](https://github.com/deepinsight/insightface/issues/1770#issuecomment-927131443)].
See the [full discussion](https://github.com/immich-app/immich/discussions/5028) in GitHub for more information.
</details>
* For the smart search feature the best Clip model will be `ViT-H-14-378-quickgelu` or `vit-H-14-Qickgelu`.
<details>
<summary>why is it?</summary>
You might want to consider `ViT-H-14-quickgelu` over `ViT-H-14-378-quickgeludfn5b`
because it takes much less processing power and the difference between the
Average perf. on 38 datasets is really "nothing"
to be precise a difference of 0.0118.
And the advantage of ViT-H-14-quickgelu is that it requires much less processing power
381.68 compared to 1054.05.
Sources:
[Discord](https://discord.com/channels/979116623879368755/1174254430221254738),
[openclip results](https://github.com/mlfoundations/open_clip/blob/main/docs/openclip_results.csv#L3),
[openclip retrieval results](https://github.com/mlfoundations/open_clip/blob/main/docs/openclip_retrieval_results.csv).
</details>
<details>
<summary>How to apply?</summary>
1. In the browser, log in to your Admin user
2. Go to the url [http://localhost:2283/admin/system-settings?open=job-settings](http://localhost:2283/admin/system-settings?open=job-settings)
3. Go to Machine Learning Settings
4. change the models and save
5. rerun the jobs of ML to take effect
</details>
:::note
Changing a model does not delete the previous model, pay attention to delete the old model to save space in drive.
Models are stored in IMMICH_MODEL-CACHE.
:::
### I would like to use the Clip model i created, how can i do that?
you can't, because we have a [whitelist](https://github.com/immich-app/immich/blob/main/machine-learning/app/models/constants.py) of models in the server code that has each model’s [dimension size](https://github.com/immich-app/immich/blob/main/server/src/domain/smart-info/smart-info.constant.ts). We use this to update the index to the right dim size when the model changes so custom models aren’t supported.
The [export script](https://github.com/immich-app/immich/tree/main/machine-learning/export) in Immich Github page is meant for us to be able to automate exporting and uploading to Huggingface you can send a [pull request](https://github.com/immich-app/immich/pulls) via Github to add this model to Immich check if Immich already have this model in the list of models in [Huggingface](https://huggingface.co/immich-app) before you send pull request.
([Sources](https://discord.com/channels/979116623879368755/1071165397228855327/1187088114599071855))
### I don't speak English, is there a way I can use the Smart Serach in my language?
Yes, you can get such an option, to do this you need to check what is the best model according to your language, you can do it by checking the [table](https://github.com/mlfoundations/open_clip/blob/main/docs/openclip_multilingual_retrieval_results.csv).
:::note
If you found a suitable model for your language and you want to use it you may not be able to because Immich didn't add it to their list of models in [Huggingface](https://huggingface.co/immich-app), you can make it happen by send a [pull request](https://github.com/immich-app/immich/pulls) via Github to add this model to Immich.
It is important to check the level of accuracy of the model and the amount of use of processing power Flops(B) in [this table](https://github.com/mlfoundations/open_clip/blob/main/docs/openclip_results.csv) so you can know it will work well with your system.
:::
### Does Immich support Facial Recognition in video ?
Although it seems that insightface is able to [recognize faces in video](https://github.com/deepinsight/insightface#arcface-video-demo) as of now the option is not yet implemented in Immich.
On the other hand, Immich uses a thumbnail image created from the video in order to scan it for a face, if there is a face in the thumbnail image of the video, Immich will try to recognize a face in thumbnail.

24
docs/docs/FAQ/Mobile-App-FAQ.md Normal file
View File

@@ -0,0 +1,24 @@
---
sidebar_position: 55
---
# Mobile App
### What is the difference between the cloud icon on the mobile app?
| Icon | Description |
| ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| ![cloud](/img/cloud.svg) | Asset is only available in the cloud and was uploaded from some other device (like the web client) or was deleted from this device after upload |
| ![cloud-cross](/img/cloud-off.svg) | Asset is only available locally and has not yet been backed up |
| ![cloud-done](/img/cloud-done.svg) | Asset was uploaded from this device and is now backed up in the cloud/server and still available in original on the device |
### IOS app
### No albums&photos seen by Immich on Iphone
there are some reporting issue with iPhoneXR regarding the problem with scanning the album,we haven't yet to find the cause [see more info here](https://discord.com/channels/979116623879368755/1107718197655908412)
:::note
If you think you know what the solution to the problem might be, we'd be happy to discuss it on [Discord](https://discord.com/channels/979116623879368755/1071165397228855327)/[Github](https://github.com/immich-app/immich/discussions)
:::

48
docs/docs/FAQ/Performance-FAQ.md Normal file
View File

@@ -0,0 +1,48 @@
---
sidebar_position: 7
---
# Performance
### Why is Immich slow on low-memory systems like the Raspberry Pi?
Immich optionally uses machine learning for several features. However, it can be too heavy to run on a Raspberry Pi. You can [mitigate](/docs/FAQ/Performance-FAQ#how-can-i-lower-immichs-cpu-usage) this or [disable](/docs/FAQ/Machine-Learning-FAQ#how-can-i-disable-machine-learning) machine learning entirely.
### How can I lower Immich's CPU and RAM usage?
The initial backup is the most intensive due to the number of jobs running. The most CPU-intensive ones are transcoding and machine learning jobs (Tag Images, Smart Search, Recognize Faces), and to a lesser extent thumbnail generation. Here are some ways to lower their CPU usage:
- 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 Recognize Faces job for all images after this for facial recognition on new images to work properly.
- If these changes are not enough, see [below](/docs/FAQ/Machine-Learning-FAQ#how-can-i-disable-machine-learning) for how you can disable machine learning.
### How can I change the amount of CPU and RAM that Immich uses?
By default, a container has no resource constraints and can use as much of a given resource as the host's kernel scheduler allows.
You can look at the [original docker docs](https://docs.docker.com/config/containers/resource_constraints/) or use this [guide](https://www.baeldung.com/ops/docker-memory-limit) to learn how to do this.
### Can I boost machine learning speed?
Yes, you can do it by increasing the amount of job concurrency, as the amount increases, the computer will work on several assets at the same time.
You can do it by
1. Admin user login
2. Administration
3. jobs
4. On the left side Manage Concurrency
5. Change the settings as needed
:::danger
On a normal machine, 2 or 3 concurrent jobs can probably max the CPU, so if you're not hitting those maximums with, say, 30 jobs,
Also, it is important to know that the Storage should have INPUT & OUTPUT at high speed in order to handle all of this
For reference I never went above 32/job while testing with an RTX 4090 GPU
Or for example if machine learning is enabled by a CPU such as I7 8700 a bit higher than default here would be like 16/job.
Do not exaggerate with the amount of jobs because you're probably thoroughly overloading the database.
more info [here](https://discord.com/channels/979116623879368755/994044917355663450/1174711719994605708)
:::
### When you run machine learning my processor is 100% usge is it noraml?
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 after that, the percentage of CPU usage will drop to around 3-5% usage

12
docs/docs/FAQ/Privacy-FAQ.md Normal file
View File

@@ -0,0 +1,12 @@
---
sidebar_position: 1
---
# Privacy
### Is all data local?
Everything stays local, the models get downloaded from a repository the first time you run it.
Machine learning is also done locally,
Machine learning URL isn't pointing to the external page. It is the DNS of the container within the docker's network context.
Model retrievals are done automatically from the [hugging face repository](https://huggingface.co/immich-app). more info [here](https://www.reddit.com/r/immich/comments/17obeyj/is_all_data_local/).

13
docs/docs/FAQ/User-FAQ.md Normal file
View File

@@ -0,0 +1,13 @@
---
sidebar_position: 2
---
# User
### How can I reset the admin password?
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
You can see the list of all users by running [List-Users](/docs/administration/server-commands.md) Command on the Immich-server.

4
docs/docs/FAQ/_category_.json Normal file
View File

@@ -0,0 +1,4 @@
{
"label": "FAQ",
"position": 8
}

2
docs/docs/developer/architecture.mdx
View File

@@ -107,4 +107,4 @@ See [Database Migrations](./database-migrations.md) for more information about h
### Redis
Immich uses [Redis](https://redis.com/) via [BullMQ](https://docs.bullmq.io/) to manage job queues. Some jobs trigger subsequent jobs. For example, object detection relies on thumbnail generation and automatically run after one is generated.
Immich uses [Redis](https://redis.com/) via [BullMQ](https://docs.bullmq.io/) to manage job queues. Some jobs trigger subsequent jobs. For example, Smart Search and Facial Recognition relies on thumbnail generation and automatically run after one is generated.

BIN
docs/docs/guides/assets/20231219_183007_add-new-server-option.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 39 KiB

42
docs/docs/guides/database-GUI-view.md Normal file
View File

@@ -0,0 +1,42 @@
# Access database (GUI)
:::note
in order to connect to the database the immich_postgres container **must be on**.
:::
:::info
The password and name data comes from the `.env` file. If you have changed the values of the name and password, **they must be changed accordingly in the Connection screen** as explained below
:::
- The software must be installed [pgAdmin](https://www.pgadmin.org/download)
- Open pgAdmin and select the add new server option
<img src={require('./img/add-new-server-option.png').default} width="50%" title="new server option" />
- enter a value for `name` (can be any name you want)
- in Connection we will enter the following details:
| Details | Final Result |
| :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------: |
| Host name/address =`Local host`<br />Port = `5432`<br />Maintenance database = `immich`<br />Username = `postgres`<br />Password = `postgres`<br /><br /><br /><br /><br /><br /><br /> | <img src={require('./img/Connection-Pgadmin.png').default} width="75%" title="Connection" /> |
* click on Save to connect to the Immich database
now you have access to the Immich database.
:::tip
follow [Database Queries](https://immich.app/docs/guides/database-queries/) guide for more information
:::
# EXTRA
---
if you want to be able to use pgAdmin in your brwoser you can follow this steps
* In pgAdmin click on file --> runtime --> view log
<img src={require('./img/view-log.png').default} width="30%" title="view log" />
* The link will appear there with a unique key (which changes every time you reconnect to pgAdmin) through which you can enter the GUI in the browser
<img src={require('./img/unique-key.png').default} width="50%" title="new server option" />

BIN
docs/docs/guides/img/Connection-Pgadmin.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 36 KiB

BIN
docs/docs/guides/img/add-new-server-option.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 39 KiB

BIN
docs/docs/guides/img/unique-key.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 18 KiB

BIN
docs/docs/guides/img/view-log.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 8.5 KiB

1
docs/docs/guides/remote-access.md
View File

@@ -1,6 +1,7 @@
# Remote Access
This page gives a few pointers on how to access your Immich instance from outside your LAN.
You can read the [full discussion in discount](https://discord.com/channels/979116623879368755/1122615710846308484)
:::danger
Never forward port 2283 directly to the internet without additional configuration. This will expose the web interface via http to the internet, making you succeptible to [man in the middle](https://en.wikipedia.org/wiki/Man-in-the-middle_attack) attacks.

6
docs/docs/overview/Comparison.md Normal file
View File

@@ -0,0 +1,6 @@
---
sidebar_position: 6
---
# Help Me!

3
docs/src/pages/index-FAQ.tsx Normal file
View File

@@ -0,0 +1,3 @@
import TOCInline from '@theme/TOCInline';
<TOCInline toc={toc} />

1
docs/src/pages/index.tsx
View File

@@ -1,6 +1,7 @@
import React from 'react';
import Link from '@docusaurus/Link';
import Layout from '@theme/Layout';
import TOCInline from '@theme/TOCInline';
function HomepageHeader() {
return (