diff --git a/docs/docs/features/automatic-backup.md b/docs/docs/features/automatic-backup.md index 81444d9f37..443f048ad3 100644 --- a/docs/docs/features/automatic-backup.md +++ b/docs/docs/features/automatic-backup.md @@ -1,6 +1,12 @@ # Automatic Backup -A guide on how the foreground and background automatic backup works. +Immich supports uploading the photos and videos from your mobile device to the server automatically. + +--- + +You can enable the settings by accessing the upload options from the upload page + + @@ -10,9 +16,9 @@ If foreground backup is enabled: whenever the app is opened or resumed, it will ## Background backup -Background backup is available thanks to the contribution effort of [@fyfrey](https://github.com/fyfrey) and [@martyfuhry](https://github.com/martyfuhry). +This feature is intended for everyday usage, for initial bulk uploading, please use the foreground upload feature. For more FAQ on why background upload is not working, please refer to the [FAQ](/docs/FAQ#why-does-foreground-backup-stop-when-i-navigate-away-from-the-app-shouldnt-it-transfer-the-job-to-background-backup). -If background backup is enabled. The app will periodically check if there are any new photos or videos in the selected album(s) to be uploaded to the cloud. If there are, it will upload them to the cloud in the background. +If background backup is enabled. The app will periodically check if there are any new photos or videos in the selected album(s) to be uploaded to the server. If there are, it will upload them to the cloud in the background. :::info Note diff --git a/docs/docs/features/img/background-foreground-backup.png b/docs/docs/features/img/background-foreground-backup.png index 72a64aeba4..cc383cd69e 100644 Binary files a/docs/docs/features/img/background-foreground-backup.png and b/docs/docs/features/img/background-foreground-backup.png differ diff --git a/docs/docs/features/img/backup-settings-access.png b/docs/docs/features/img/backup-settings-access.png new file mode 100644 index 0000000000..3d99926ef5 Binary files /dev/null and b/docs/docs/features/img/backup-settings-access.png differ diff --git a/docs/docs/features/img/partner-sharing-1.png b/docs/docs/features/img/partner-sharing-1.png index 48785a353c..88dde42a47 100644 Binary files a/docs/docs/features/img/partner-sharing-1.png and b/docs/docs/features/img/partner-sharing-1.png differ diff --git a/docs/docs/features/img/partner-sharing-2.png b/docs/docs/features/img/partner-sharing-2.png index 086795b232..da5976c4f1 100644 Binary files a/docs/docs/features/img/partner-sharing-2.png and b/docs/docs/features/img/partner-sharing-2.png differ diff --git a/docs/docs/features/img/partner-sharing-3.png b/docs/docs/features/img/partner-sharing-3.png index a8627cf859..3c0acea4ef 100644 Binary files a/docs/docs/features/img/partner-sharing-3.png and b/docs/docs/features/img/partner-sharing-3.png differ diff --git a/docs/docs/features/img/partner-sharing-4.png b/docs/docs/features/img/partner-sharing-4.png index eca121ff78..b54d01d00d 100644 Binary files a/docs/docs/features/img/partner-sharing-4.png and b/docs/docs/features/img/partner-sharing-4.png differ diff --git a/docs/docs/features/img/partner-sharing-5.png b/docs/docs/features/img/partner-sharing-5.png index 3759e13d9a..bd6e019b04 100644 Binary files a/docs/docs/features/img/partner-sharing-5.png and b/docs/docs/features/img/partner-sharing-5.png differ diff --git a/docs/docs/features/img/partner-sharing-6.png b/docs/docs/features/img/partner-sharing-6.png index b9aee5143a..69a1cc2206 100644 Binary files a/docs/docs/features/img/partner-sharing-6.png and b/docs/docs/features/img/partner-sharing-6.png differ diff --git a/docs/docs/features/img/partner-sharing-7.png b/docs/docs/features/img/partner-sharing-7.png index 4cd4be60b5..8892a6b601 100644 Binary files a/docs/docs/features/img/partner-sharing-7.png and b/docs/docs/features/img/partner-sharing-7.png differ diff --git a/docs/docs/features/img/partner-sharing-8.png b/docs/docs/features/img/partner-sharing-8.png new file mode 100644 index 0000000000..14c136b797 Binary files /dev/null and b/docs/docs/features/img/partner-sharing-8.png differ diff --git a/docs/docs/features/img/reverse-geocoding-mobile1.jpeg b/docs/docs/features/img/reverse-geocoding-mobile1.jpeg new file mode 100644 index 0000000000..a6be295c36 Binary files /dev/null and b/docs/docs/features/img/reverse-geocoding-mobile1.jpeg differ diff --git a/docs/docs/features/img/reverse-geocoding-mobile1.png b/docs/docs/features/img/reverse-geocoding-mobile1.png deleted file mode 100644 index 54ffad3f96..0000000000 Binary files a/docs/docs/features/img/reverse-geocoding-mobile1.png and /dev/null differ diff --git a/docs/docs/features/img/reverse-geocoding-mobile2.jpeg b/docs/docs/features/img/reverse-geocoding-mobile2.jpeg new file mode 100644 index 0000000000..f35474208b Binary files /dev/null and b/docs/docs/features/img/reverse-geocoding-mobile2.jpeg differ diff --git a/docs/docs/features/img/reverse-geocoding-mobile2.png b/docs/docs/features/img/reverse-geocoding-mobile2.png deleted file mode 100644 index f6858c50c4..0000000000 Binary files a/docs/docs/features/img/reverse-geocoding-mobile2.png and /dev/null differ diff --git a/docs/docs/features/img/reverse-geocoding-mobile3.jpeg b/docs/docs/features/img/reverse-geocoding-mobile3.jpeg new file mode 100644 index 0000000000..5a4909cb53 Binary files /dev/null and b/docs/docs/features/img/reverse-geocoding-mobile3.jpeg differ diff --git a/docs/docs/features/partner-sharing.md b/docs/docs/features/partner-sharing.md index c80ff384f3..990e071744 100644 --- a/docs/docs/features/partner-sharing.md +++ b/docs/docs/features/partner-sharing.md @@ -1,27 +1,21 @@ # Partner Sharing -:::tip Sharing specific assets -For sharing a specific set of assets, you can use the shared album feature of Immich. -::: - Immich allows you to share your library with other users. They can then view your library and download the assets. You can manage Partner Sharing from the [User Settings](docs/features/user-settings.md) page on the web. -Partner Sharing includes: +Partner sharing includes: - Access to all non-archived and trashed photos and videos. - Access to all metadata, including GPS information. - Access to share assets via shared links, albums, etc. -:::info -Partner sharing is one-way. To view your partner's assets, they must also share them with you. -::: +:::note + +- Partner sharing is one-way. To view your partner's assets, they must also share them with you. +- Partner sharing may result in displaying duplicate assets on the main timeline. + ::: ## Sharing with a Partner -:::note Duplicates -Partner sharing may result in displaying duplicate assets on the main timeline. -::: - @@ -38,20 +32,22 @@ Access partner assets via the Sharing page. Partner shared photos can be displayed in the main timeline. This feature can be enabled on a per-partner basis and can be viewed and updated on both the web and mobile app. -### Web: +### Web Account Settings -> Sharing -> Show in timeline -### Mobile App: +### Mobile App -From the partner’s view, on the top right corner of the app bar +From the partner’s view, toggle the button + + ## Removing Access -In order to remove a partner, you can go to User -> Account Settings -> Sharing and click on the X button. +In order to remove a partner, you can go to `User > Account Settings > Sharing` and click on the X button. diff --git a/docs/docs/features/reverse-geocoding.md b/docs/docs/features/reverse-geocoding.md index 108a6ea1b1..58c5c37101 100644 --- a/docs/docs/features/reverse-geocoding.md +++ b/docs/docs/features/reverse-geocoding.md @@ -1,6 +1,6 @@ # Reverse Geocoding -Immich supports [Reverse Geocoding](https://en.wikipedia.org/wiki/Reverse_geocoding) using data from the [GeoNames](https://www.geonames.org/) geographical database. +Immich supports local [Reverse Geocoding](https://en.wikipedia.org/wiki/Reverse_geocoding) using data from the [GeoNames](https://www.geonames.org/) geographical database. ## Extraction @@ -10,5 +10,6 @@ During Exif Extraction, assets with latitudes and longitudes are reverse geocode Data from a reverse geocode is displayed in the image details, and used in [Smart Search](/docs/features/smart-search.md). - - + + + diff --git a/docs/docs/features/smart-search.md b/docs/docs/features/search.md similarity index 88% rename from docs/docs/features/smart-search.md rename to docs/docs/features/search.md index dcbed4f3b4..b39e3b342d 100644 --- a/docs/docs/features/smart-search.md +++ b/docs/docs/features/search.md @@ -1,11 +1,11 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# Smart Search +# Search -Immich uses Postgres as its search database for both metadata and smart search. +Immich uses Postgres as its search database for both metadata and contextual CLIP search. -Smart search is powered by the [pgvecto.rs](https://github.com/tensorchord/pgvecto.rs) extension, utilizing machine learning models like [CLIP](https://openai.com/research/clip) to provide relevant search results. This allows for freeform searches without requiring specific keywords in the image or video metadata. +Contextual CLIP search is powered by the [pgvecto.rs](https://github.com/tensorchord/pgvecto.rs) extension, utilizing machine learning models like [CLIP](https://openai.com/research/clip) to provide relevant search results. This allows for freeform searches without requiring specific keywords in the image or video metadata. ## Advanced Search Filters diff --git a/docs/docs/features/shared-albums.md b/docs/docs/features/sharing.md similarity index 96% rename from docs/docs/features/shared-albums.md rename to docs/docs/features/sharing.md index dcf884bc9b..ca4d29a72a 100644 --- a/docs/docs/features/shared-albums.md +++ b/docs/docs/features/sharing.md @@ -1,6 +1,8 @@ -# Shared Albums & Assets +# Sharing -## Shared Albums +Immich supports local sharing, with users on the same Immich instance and public sharing via public links. + +## Shared albums import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -15,9 +17,11 @@ When sharing shared albums, whats shared is: ## Shared Album Features - Download all assets as zip file (Web only). - :::info Archive size limited. - If the size of the album exceeds 4GB, the archive files will by default be divided into 4GB each. This can be changed on the user settings page. - ::: + +:::info Archive size limited. +If the size of the album exceeds 4GB, the archive files will by default be divided into 4GB each. This can be changed on the user settings page. +::: + - Add a description to the album (Web only). - Slideshow view (Web only). - Add or remove photos to an album.