From 18a4346d2be8fa90eaa7143fe279e9668df0b3c5 Mon Sep 17 00:00:00 2001 From: Jason Rasmussen Date: Sat, 6 Jan 2024 20:29:17 -0500 Subject: [PATCH] chore: updates --- docs/docs/FAQ/Albums-FAQ.md | 5 ++- docs/docs/FAQ/Assets-FAQ.md | 39 +++++++++++-------- docs/docs/FAQ/Docker-FAQ.md | 4 +- docs/docs/FAQ/External-Library-FAQ.md | 2 +- docs/docs/FAQ/Machine-Learning-FAQ.md | 1 + docs/docs/FAQ/Mobile-App-FAQ.md | 12 +++--- docs/docs/FAQ/Privacy-FAQ.md | 4 +- docs/docs/FAQ/User-FAQ.md | 4 +- .../docs/administration/backup-and-restore.md | 31 ++++++++------- docs/docs/developer/setup.md | 1 + docs/docs/features/libraries.md | 2 +- docs/docs/guides/database-GUI-view.md | 11 +++--- docs/docs/overview/Comparison.md | 3 +- 13 files changed, 65 insertions(+), 54 deletions(-) diff --git a/docs/docs/FAQ/Albums-FAQ.md b/docs/docs/FAQ/Albums-FAQ.md index 70a76e1bd7..bbf872138f 100644 --- a/docs/docs/FAQ/Albums-FAQ.md +++ b/docs/docs/FAQ/Albums-FAQ.md @@ -6,7 +6,8 @@ sidebar_position: 4 ### Can I import assets to Immich while maintaining existing album structure? -Yes you can by using Immich CLI with -a command, see [this document](/docs/features/command-line-interface) for more info. +Yes. You can by use [Immich CLI](/docs/features/command-line-interface) along with the `--album` flag. ### Is there a way to select the order in which photos are presented when an album is opened? -Not yet, but this is a [planned feature](https://github.com/immich-app/immich/discussions/1689). \ No newline at end of file + +No, not yet. For updates on this planned feature, follow the [GitHub discussion](https://github.com/immich-app/immich/discussions/1689), diff --git a/docs/docs/FAQ/Assets-FAQ.md b/docs/docs/FAQ/Assets-FAQ.md index b455d62442..fe19d3c859 100644 --- a/docs/docs/FAQ/Assets-FAQ.md +++ b/docs/docs/FAQ/Assets-FAQ.md @@ -6,48 +6,53 @@ sidebar_position: 3 ### Can I add my existing photo library? -Yes, with an [external library](/docs/features/libraries.md). +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. +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 (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. -### In the uploads folder, why are photos stored in the wrong date? +### Why are some photos stored in the file system with the wrong date? -This is fixed by running the storage migration job. +There are a few different scenarios that can lead to this situation. The solution is to simply 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. ### How can I hide photos from the timeline? -You can archive them. +You can _archive_ them. ### How can I backup data from Immich? -See [backup and restore](/docs/administration/backup-and-restore.md). +See [Backup and Restore](/docs/administration/backup-and-restore.md). -### Does Immich supports reading faces tags from exif? +### Does Immich support reading existing face tag metadata? -For now, it doesn't. +No, it currently does not. ### Does Immich support filtering of NSFW images? -This option is not implemented, but 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. +No, it currently does not, but 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. +There are three thubmanil jobs for each asset: + +- Blurred (thumbhash) +- Small (webp) +- Large (jpeg) + +Also, there are additional jobs for person (face) thumbnails. ### What happens if an asset exists in more than one account? -All machine learning jobs and thumbnail images are recreated. +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. ### How can I delete transcoded videos without deleting the original? -The transcode 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 an asset (with the _Refresh encoded videos_ button in the asset viewer options, or for all assets by running transcoding jobs for all assets. +The transcode 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 an asset (with the _Refresh encoded videos_ button in the asset viewer options. Or, for all assets by running transcoding jobs for all assets. 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. @@ -55,14 +60,13 @@ To update the transcode policy, navigate to Administration > Video Transcoding S 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. ::: - ### 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. ### 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. +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. @@ -83,4 +87,5 @@ This is an advanced operation. If you can't do it with the steps described here, UPDATE assets SET "ownerId" = '' WHERE "ownerId" = '' AND CHECKSUM NOT IN (SELECT CHECKSUM FROM assets WHERE "ownerId" = ''); ``` -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. \ No newline at end of file + +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. diff --git a/docs/docs/FAQ/Docker-FAQ.md b/docs/docs/FAQ/Docker-FAQ.md index 6e140ac79f..cfaae9d345 100644 --- a/docs/docs/FAQ/Docker-FAQ.md +++ b/docs/docs/FAQ/Docker-FAQ.md @@ -8,7 +8,7 @@ sidebar_position: 8 ### 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) +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? @@ -47,4 +47,4 @@ If the error mentions SIGKILL or error code 137, it most likely means the servic If it mentions SIGILL (note the lack of a K) or error code 132, it most likely means your server's CPU is incompatible. This is unlikely to occur on version 1.92.0 or later. Consider upgrading if your version of Immich is below that. -If your version of Immich is below 1.92.0 and the crash occurs after logs about tracing or exporting a model, consider either upgrading or disabling the Tag Objects job. \ No newline at end of file +If your version of Immich is below 1.92.0 and the crash occurs after logs about tracing or exporting a model, consider either upgrading or disabling the Tag Objects job. diff --git a/docs/docs/FAQ/External-Library-FAQ.md b/docs/docs/FAQ/External-Library-FAQ.md index 999ccc8902..4010426b44 100644 --- a/docs/docs/FAQ/External-Library-FAQ.md +++ b/docs/docs/FAQ/External-Library-FAQ.md @@ -17,4 +17,4 @@ Upload library and external library use different mechanisms to detect duplicate - Upload library: hashes the file - External library: uses the file path -Therefore, a situation where the same file appears twice in the timeline is possible. \ No newline at end of file +Therefore, a situation where the same file appears twice in the timeline is possible. diff --git a/docs/docs/FAQ/Machine-Learning-FAQ.md b/docs/docs/FAQ/Machine-Learning-FAQ.md index d22af855d8..6dea135095 100644 --- a/docs/docs/FAQ/Machine-Learning-FAQ.md +++ b/docs/docs/FAQ/Machine-Learning-FAQ.md @@ -1,6 +1,7 @@ --- sidebar_position: 6 --- + # Machine Learning ### How does smart search work? diff --git a/docs/docs/FAQ/Mobile-App-FAQ.md b/docs/docs/FAQ/Mobile-App-FAQ.md index 6e4105400d..26725c0960 100644 --- a/docs/docs/FAQ/Mobile-App-FAQ.md +++ b/docs/docs/FAQ/Mobile-App-FAQ.md @@ -10,15 +10,15 @@ sidebar_position: 2 | ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | | ![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 to the server; the original file is still on the device | - +| ![cloud-done](/img/cloud-done.svg) | Asset was uploaded from this device and is now backed up to the server; the original file is still on the device | ### IOS app - ### I can't log into the application after the server update, what can I do? - Make sure you've updated the app as well. +### I can't log into the application after the server update, what can I do? + +Make sure you've updated the app as well. :::note -app store updates sometimes take longer because the stores (play store; Google and app store; Apple) +App store updates sometimes take longer because the stores (play store; Google and app store; Apple) need to approve the update first which may take some time. -::: \ No newline at end of file +::: diff --git a/docs/docs/FAQ/Privacy-FAQ.md b/docs/docs/FAQ/Privacy-FAQ.md index dbb503554f..e946bdbfcb 100644 --- a/docs/docs/FAQ/Privacy-FAQ.md +++ b/docs/docs/FAQ/Privacy-FAQ.md @@ -1,14 +1,16 @@ --- sidebar_position: 9 --- + import TOCInline from '@theme/TOCInline'; # 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/). +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/). console.log(node),true)}/> diff --git a/docs/docs/FAQ/User-FAQ.md b/docs/docs/FAQ/User-FAQ.md index b80080c52e..68adbc2baf 100644 --- a/docs/docs/FAQ/User-FAQ.md +++ b/docs/docs/FAQ/User-FAQ.md @@ -8,6 +8,6 @@ sidebar_position: 1 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 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. +You can see the list of all users by running [list-users](/docs/administration/server-commands.md) Command on the Immich-server. diff --git a/docs/docs/administration/backup-and-restore.md b/docs/docs/administration/backup-and-restore.md index 97b53624f3..6d5cf51816 100644 --- a/docs/docs/administration/backup-and-restore.md +++ b/docs/docs/administration/backup-and-restore.md @@ -66,31 +66,32 @@ Immich stores two types of content in the filesystem: (1) original, unmodified c 1. `UPLOAD_LOCATION/profile` **1. User-Specific Folders:** + - Each user has a unique string representing them. - - The main user is "Admin" (but only for `\library\library\`) - - Other users have different string identifiers. -- You can find your user ID in Account Account Settings > Account > User ID. + - The main user is "Admin" (but only for `\library\library\`) + - Other users have different string identifiers. +- You can find your user ID in Account Account Settings > Account > User ID. **2. Asset Types and Storage Locations:** - **Source Assets:** - - Original assets uploaded through the browser interface&mobile&CLI. - - Stored in `\library\library\`. + - Original assets uploaded through the browser interface&mobile&CLI. + - Stored in `\library\library\`. - **Avatar Images:** - - User profile images. - - Stored in `\library\profile\`. + - User profile images. + - Stored in `\library\profile\`. - **Thumbs Images:** - - Preview images (blurred, small, large) for each asset and thumbnails for recognized faces. - - Stored in `\library\thumbs\`. + - Preview images (blurred, small, large) for each asset and thumbnails for recognized faces. + - Stored in `\library\thumbs\`. - **Encoded Assets:** - - By default, unless otherwise specified re-encoded video assets for wider compatibility . - - Stored in `\library\encoded-video\`. + - By default, unless otherwise specified re-encoded video assets for wider compatibility . + - Stored in `\library\encoded-video\`. - **Files in Upload Queue (Mobile):** - - Files uploaded through mobile apps. - - Temporarily located in `\library\upload\`. - - Transferred to `\library\library\` upon successful upload. + - Files uploaded through mobile apps. + - Temporarily located in `\library\upload\`. + - Transferred to `\library\library\` upon successful upload. :::danger Do not touch the files inside these folders under any circumstances except taking a backup, changing or removing an asset can cause untracked and missing files. You can think of it as App-Which-Must-Not-Be-Named, the only access to viewing, changing and deleting assets is only through the mobile or browser interface. -::: \ No newline at end of file +::: diff --git a/docs/docs/developer/setup.md b/docs/docs/developer/setup.md index 40e2b7720c..18da63e1f4 100644 --- a/docs/docs/developer/setup.md +++ b/docs/docs/developer/setup.md @@ -1,6 +1,7 @@ --- sidebar_position: 2 --- + # Setup :::note diff --git a/docs/docs/features/libraries.md b/docs/docs/features/libraries.md index 81faaf9e99..bd7639dd54 100644 --- a/docs/docs/features/libraries.md +++ b/docs/docs/features/libraries.md @@ -149,7 +149,7 @@ Only an admin can do this. - Click on the user edit button. - Set `/mnt/media` to be the external path. This folder will only contain the three folders that we want to import, so nothing else can be accessed. :::note -Spaces in the internal path aren't currently supported. + Spaces in the internal path aren't currently supported. You must import it as: `..:/mnt/media/my-media:ro` diff --git a/docs/docs/guides/database-GUI-view.md b/docs/docs/guides/database-GUI-view.md index 678d0aa8ac..38951dbf14 100644 --- a/docs/docs/guides/database-GUI-view.md +++ b/docs/docs/guides/database-GUI-view.md @@ -12,15 +12,15 @@ Password and username match the ones specified in the `.env` file. If you have c - Open pgAdmin and select the add 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`
Port = `5432`
Maintenance database = `immich`
Username = `postgres`
Password = `postgres`






| | -* click on Save to connect to the Immich database +- click on Save to connect to the Immich database now you have access to the Immich database. @@ -34,9 +34,10 @@ follow [Database Queries](https://immich.app/docs/guides/database-queries/) guid 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 +- In pgAdmin click on file --> runtime --> 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 + +- 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 diff --git a/docs/docs/overview/Comparison.md b/docs/docs/overview/Comparison.md index db7e6284e6..f900ebc7c9 100644 --- a/docs/docs/overview/Comparison.md +++ b/docs/docs/overview/Comparison.md @@ -7,7 +7,6 @@ sidebar_position: 2 If you're new here and came from other photo self-hosting alternatives you might want to look at a comparison between Immich and your current self-hosting. Here you can see a [comparison between the various OpenSource Photo Libraries](https://meichthys.github.io/foss_photo_libraries/) including Immich. - :::note It is important to remember, Immich is under very active development. Expect bugs and changes. Do not use it as the only way to store your photos and videos! -::: \ No newline at end of file +:::