chore(docs): clean up and add new content (#15003)
* wip: Install * wip: sharing * wip: features * wip: features * wip: tags and folder view * update links * fix: broken reference to page sections * pr feedback * Update docs/docs/overview/comparison.md Co-authored-by: Daniel Dietzler <36593685+danieldietzler@users.noreply.github.com> * webp * webp is glory * webp is glory --------- Co-authored-by: Daniel Dietzler <36593685+danieldietzler@users.noreply.github.com>
|
|
@ -1,8 +1,14 @@
|
|||
# Automatic Backup
|
||||
|
||||
A guide on how the foreground and background automatic backup works.
|
||||
Immich supports uploading photos and videos from your mobile device to the server automatically.
|
||||
|
||||
<img src={require('./img/background-foreground-backup.png').default} width="50%" title="Foreground&Background Backup" />
|
||||
---
|
||||
|
||||
You can enable the settings by accessing the upload options from the upload page
|
||||
|
||||
<img src={require('./img/backup-settings-access.webp').default} width="50%" title="Backup option selection" />
|
||||
|
||||
<img src={require('./img/background-foreground-backup.webp').default} width="50%" title="Foreground&Background Backup" />
|
||||
|
||||
## Foreground backup
|
||||
|
||||
|
|
@ -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 use. For initial bulk uploading, please use the foreground upload feature. For more information on why background upload is not working as expected, 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
|
||||
|
||||
|
|
@ -30,7 +36,7 @@ If background backup is enabled. The app will periodically check if there are an
|
|||
- You must enable **Background App Refresh** for the app to work in the background. You can enable it in the Settings app under General > Background App Refresh.
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
<img src={require('./img/background-app-refresh.png').default} width="30%" title="background-app-refresh" />
|
||||
<img src={require('./img/background-app-refresh.webp').default} width="30%" title="background-app-refresh" />
|
||||
</div>
|
||||
|
||||
:::
|
||||
|
|
|
|||
|
|
@ -170,4 +170,4 @@ immich upload --include-hidden --recursive directory/
|
|||
|
||||
The API key can be obtained in the user setting panel on the web interface.
|
||||
|
||||

|
||||

|
||||
|
|
|
|||
|
|
@ -6,15 +6,15 @@ Immich recognizes faces in your photos and videos and groups them together into
|
|||
|
||||
The list of people is shown in the Explore page.
|
||||
|
||||
<img src={require('./img/facial-recognition-1.png').default} title='Facial Recognition 1' />
|
||||
<img src={require('./img/facial-recognition-1.webp').default} title='Facial Recognition 1' />
|
||||
|
||||
Upon clicking on a person, a list of assets that contain their face will be shown.
|
||||
|
||||
<img src={require('./img/facial-recognition-2.png').default} title='Facial Recognition 2' />
|
||||
<img src={require('./img/facial-recognition-2.webp').default} title='Facial Recognition 2' />
|
||||
|
||||
The asset detail view will also show the faces that are recognized in the asset.
|
||||
|
||||
<img src={require('./img/facial-recognition-3.png').default} title='Facial Recognition 3' />
|
||||
<img src={require('./img/facial-recognition-3.webp').default} title='Facial Recognition 3' />
|
||||
|
||||
## Actions
|
||||
|
||||
|
|
@ -28,7 +28,7 @@ Additional actions you can do include:
|
|||
|
||||
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%"/>
|
||||
<img src={require('./img/facial-recognition-4.webp').default} title='Facial Recognition 4' width="70%"/>
|
||||
|
||||
## How Face Detection Works
|
||||
|
||||
|
|
|
|||
17
docs/docs/features/folder-view.md
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
# Folder View
|
||||
|
||||
Folder view provides an additional view besides the timeline that is similar to a file explorer. It allows you to navigate through the folders and files in the library. This feature is handy for a highly curated and customized external library or a nicely configured storage template.
|
||||
|
||||
You can enable this feature under [`Account Settings > Features > Folder View`](https://my.immich.app/user-settings?isOpen=feature+folders)
|
||||
|
||||
## Enable folder view
|
||||
|
||||
<img src={require('./img/folder-view-enable.webp').default} width="80%" title='Folder view enable' />
|
||||
|
||||
## Usage
|
||||
|
||||
You can then navigate to the view from the sidebar to explore the folders and files in your library.
|
||||
|
||||
<img src={require('./img/folder-access.webp').default} width="30%" title='Folder view access' />
|
||||
|
||||
<img src={require('./img/folder-view-1.webp').default} width="100%" title='Folder view' />
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
# Hardware Transcoding [Experimental]
|
||||
# Hardware Transcoding
|
||||
|
||||
This feature allows you to use a GPU to accelerate transcoding and reduce CPU load.
|
||||
Note that hardware transcoding produces significantly larger videos than software transcoding with similar settings, typically with lower quality. Using slow presets and preferring more efficient codecs can narrow this gap.
|
||||
|
|
|
|||
|
Before Width: | Height: | Size: 63 KiB |
BIN
docs/docs/features/img/background-app-refresh.webp
Normal file
|
After Width: | Height: | Size: 13 KiB |
|
Before Width: | Height: | Size: 220 KiB |
BIN
docs/docs/features/img/background-foreground-backup.webp
Normal file
|
After Width: | Height: | Size: 43 KiB |
BIN
docs/docs/features/img/backup-settings-access.webp
Normal file
|
After Width: | Height: | Size: 15 KiB |
|
Before Width: | Height: | Size: 524 KiB |
BIN
docs/docs/features/img/facial-recognition-1.webp
Normal file
|
After Width: | Height: | Size: 42 KiB |
|
Before Width: | Height: | Size: 2.6 MiB |
BIN
docs/docs/features/img/facial-recognition-2.webp
Normal file
|
After Width: | Height: | Size: 94 KiB |
|
Before Width: | Height: | Size: 1.6 MiB |
BIN
docs/docs/features/img/facial-recognition-3.webp
Normal file
|
After Width: | Height: | Size: 59 KiB |
|
Before Width: | Height: | Size: 416 KiB |
BIN
docs/docs/features/img/facial-recognition-4.webp
Normal file
|
After Width: | Height: | Size: 22 KiB |
BIN
docs/docs/features/img/folder-access.webp
Normal file
|
After Width: | Height: | Size: 14 KiB |
BIN
docs/docs/features/img/folder-view-1.webp
Normal file
|
After Width: | Height: | Size: 110 KiB |
BIN
docs/docs/features/img/folder-view-enable.webp
Normal file
|
After Width: | Height: | Size: 17 KiB |
|
Before Width: | Height: | Size: 1.5 MiB |
|
Before Width: | Height: | Size: 31 KiB |
BIN
docs/docs/features/img/library-custom-scan-interval.webp
Normal file
|
After Width: | Height: | Size: 12 KiB |
|
Before Width: | Height: | Size: 64 KiB |
BIN
docs/docs/features/img/me.webp
Normal file
|
After Width: | Height: | Size: 16 KiB |
|
Before Width: | Height: | Size: 379 KiB |
BIN
docs/docs/features/img/mobile-upload-open-photo.webp
Normal file
|
After Width: | Height: | Size: 20 KiB |
|
Before Width: | Height: | Size: 2.1 MiB |
BIN
docs/docs/features/img/mobile-upload-selected-photos.webp
Normal file
|
After Width: | Height: | Size: 180 KiB |
|
Before Width: | Height: | Size: 64 KiB |
BIN
docs/docs/features/img/my-wife.webp
Normal file
|
After Width: | Height: | Size: 16 KiB |
|
Before Width: | Height: | Size: 44 KiB |
BIN
docs/docs/features/img/obtain-api-key.webp
Normal file
|
After Width: | Height: | Size: 13 KiB |
|
Before Width: | Height: | Size: 43 KiB |
BIN
docs/docs/features/img/partner-sharing-1.webp
Normal file
|
After Width: | Height: | Size: 34 KiB |
|
Before Width: | Height: | Size: 32 KiB |
BIN
docs/docs/features/img/partner-sharing-2.webp
Normal file
|
After Width: | Height: | Size: 16 KiB |
|
Before Width: | Height: | Size: 236 KiB |
BIN
docs/docs/features/img/partner-sharing-3.webp
Normal file
|
After Width: | Height: | Size: 11 KiB |
|
Before Width: | Height: | Size: 30 KiB |
BIN
docs/docs/features/img/partner-sharing-4.webp
Normal file
|
After Width: | Height: | Size: 24 KiB |
|
Before Width: | Height: | Size: 28 KiB |
BIN
docs/docs/features/img/partner-sharing-5.webp
Normal file
|
After Width: | Height: | Size: 19 KiB |
|
Before Width: | Height: | Size: 1.6 MiB |
BIN
docs/docs/features/img/partner-sharing-6.webp
Normal file
|
After Width: | Height: | Size: 9.4 KiB |
|
Before Width: | Height: | Size: 37 KiB |
BIN
docs/docs/features/img/partner-sharing-7.webp
Normal file
|
After Width: | Height: | Size: 24 KiB |
BIN
docs/docs/features/img/partner-sharing-8.webp
Normal file
|
After Width: | Height: | Size: 12 KiB |
BIN
docs/docs/features/img/public-shared-link-album.webp
Normal file
|
After Width: | Height: | Size: 17 KiB |
BIN
docs/docs/features/img/public-shared-link-form.webp
Normal file
|
After Width: | Height: | Size: 23 KiB |
BIN
docs/docs/features/img/public-shared-link-individual.webp
Normal file
|
After Width: | Height: | Size: 99 KiB |
|
Before Width: | Height: | Size: 189 KiB |
BIN
docs/docs/features/img/reverse-geocoding-mobile1.webp
Normal file
|
After Width: | Height: | Size: 43 KiB |
|
Before Width: | Height: | Size: 277 KiB |
BIN
docs/docs/features/img/reverse-geocoding-mobile2.webp
Normal file
|
After Width: | Height: | Size: 31 KiB |
BIN
docs/docs/features/img/reverse-geocoding-mobile3.webp
Normal file
|
After Width: | Height: | Size: 44 KiB |
|
Before Width: | Height: | Size: 2.2 MiB |
BIN
docs/docs/features/img/search-ex-1.webp
Normal file
|
After Width: | Height: | Size: 99 KiB |
BIN
docs/docs/features/img/shared-album-mobile.webp
Normal file
|
After Width: | Height: | Size: 28 KiB |
BIN
docs/docs/features/img/shared-album-user-selection.webp
Normal file
|
After Width: | Height: | Size: 25 KiB |
BIN
docs/docs/features/img/shared-album.webp
Normal file
|
After Width: | Height: | Size: 85 KiB |
|
Before Width: | Height: | Size: 16 KiB |
BIN
docs/docs/features/img/sidecar-jobs.webp
Normal file
|
After Width: | Height: | Size: 12 KiB |
BIN
docs/docs/features/img/tag-creation.webp
Normal file
|
After Width: | Height: | Size: 20 KiB |
BIN
docs/docs/features/img/tag-enable.webp
Normal file
|
After Width: | Height: | Size: 39 KiB |
BIN
docs/docs/features/img/tag-form.webp
Normal file
|
After Width: | Height: | Size: 5.9 KiB |
BIN
docs/docs/features/img/tag-view.webp
Normal file
|
After Width: | Height: | Size: 73 KiB |
|
Before Width: | Height: | Size: 16 KiB |
BIN
docs/docs/features/img/user-change-password.webp
Normal file
|
After Width: | Height: | Size: 4.7 KiB |
|
Before Width: | Height: | Size: 16 KiB |
BIN
docs/docs/features/img/user-popup.webp
Normal file
|
After Width: | Height: | Size: 3.1 KiB |
|
Before Width: | Height: | Size: 23 KiB |
BIN
docs/docs/features/img/user-profile.webp
Normal file
|
After Width: | Height: | Size: 6.7 KiB |
BIN
docs/docs/features/img/user-settings-1.webp
Normal file
|
After Width: | Height: | Size: 2.9 KiB |
BIN
docs/docs/features/img/user-settings-2.webp
Normal file
|
After Width: | Height: | Size: 8.8 KiB |
BIN
docs/docs/features/img/user-settings-3.webp
Normal file
|
After Width: | Height: | Size: 57 KiB |
|
Before Width: | Height: | Size: 8.5 KiB |
BIN
docs/docs/features/img/xmp-sidecars.webp
Normal file
|
After Width: | Height: | Size: 11 KiB |
|
|
@ -151,19 +151,13 @@ Within seconds, the assets from the old-pics and videos folders should show up i
|
|||
|
||||
### Folder view
|
||||
|
||||
:::info
|
||||
This feature also exists for assets uploaded other than through external libraries.
|
||||
:::tip
|
||||
You can use the storage template migration feature for the best experience with uploaded assets in this view.
|
||||
:::
|
||||
Folder view provides an additional view besides the timeline that is similar to a file explorer. It allows you to navigate through the folders and files in the library. This feature is handy for a highly curated and customized external library or a nicely configured storage template.
|
||||
|
||||
You can browse your photos and videos by folder like in a file explorer.
|
||||
|
||||
Enable this feature from the Users Settings > Features > Folders.
|
||||
You can enable this feature under [`Account Settings > Features > Folder View`](https://my.immich.app/user-settings?isOpen=feature+folders)
|
||||
|
||||
The UI is currently only available for the web; mobile will come in a subsequent release.
|
||||
|
||||
<img src={require('./img/folder-view.png').default} width="75%" title='Folder-view' />
|
||||
<img src={require('./img/folder-view-1.webp').default} width="100%" title='Folder-view' />
|
||||
|
||||
### Set Custom Scan Interval
|
||||
|
||||
|
|
@ -174,4 +168,4 @@ 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 you can refer to [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' />
|
||||
<img src={require('./img/library-custom-scan-interval.webp').default} width="75%" title='Set custom scan interval for external library' />
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Hardware-Accelerated Machine Learning [Experimental]
|
||||
# Hardware-Accelerated Machine Learning
|
||||
|
||||
This feature allows you to use a GPU to accelerate machine learning tasks, such as Smart Search and Facial Recognition, while reducing CPU load.
|
||||
As this is a new feature, it is still experimental and may not work on all systems.
|
||||
|
|
|
|||
|
|
@ -45,12 +45,12 @@ This will enable a small cloud icon on the bottom right corner of the asset tile
|
|||
Now make sure that the local album is selected in the backup screen (steps 1-2 above). You can find these albums listed in **<ins>Library -> On this device</ins>**. To selectively upload photos from these albums, simply select the local-only photos and tap on "Upload" button in the dynamic bottom menu.
|
||||
|
||||
<img
|
||||
src={require('./img/mobile-upload-open-photo.png').default}
|
||||
src={require('./img/mobile-upload-open-photo.webp').default}
|
||||
width="50%"
|
||||
title="Upload button on local asset preview"
|
||||
/>
|
||||
<img
|
||||
src={require('./img/mobile-upload-selected-photos.png').default}
|
||||
src={require('./img/mobile-upload-selected-photos.webp').default}
|
||||
width="40%"
|
||||
title="Upload button after photos selection"
|
||||
/>
|
||||
|
|
|
|||
|
|
@ -1,57 +1,60 @@
|
|||
# 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.
|
||||
Partner sharing does _not_ include:
|
||||
|
||||
- Already existing partner albums
|
||||
- If an asset is favorited
|
||||
- People and facial recognition data
|
||||
|
||||
:::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, as duplicates are only detected on a per-user basis.
|
||||
|
||||
:::
|
||||
|
||||
## Sharing with a Partner
|
||||
|
||||
:::note Duplicates
|
||||
Partner sharing may result in displaying duplicate assets on the main timeline.
|
||||
:::
|
||||
<img src={require('./img/partner-sharing-1.webp').default} width="70%" title='Add Partner 1' />
|
||||
|
||||
<img src={require('./img/partner-sharing-1.png').default} width="70%" title='Add Partner 1' />
|
||||
<img src={require('./img/partner-sharing-2.webp').default} width="70%" title='Add Partner 2' />
|
||||
|
||||
<img src={require('./img/partner-sharing-2.png').default} width="70%" title='Add Partner 2' />
|
||||
|
||||
<img src={require('./img/partner-sharing-4.png').default} width="70%" title='Add Partner 4' />
|
||||
<img src={require('./img/partner-sharing-4.webp').default} width="70%" title='Add Partner 4' />
|
||||
|
||||
## Viewing Partner Assets
|
||||
|
||||
Access partner assets via the Sharing page.
|
||||
|
||||
<img src={require('./img/partner-sharing-3.png').default} width="70%" title='Access to the Shared Library' />
|
||||
<img src={require('./img/partner-sharing-3.webp').default} width="70%" title='Access to the Shared Library' />
|
||||
|
||||
## Timeline Integration
|
||||
|
||||
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
|
||||
The option can be found at [`Account Settings > Partner Sharing > Show in timeline`](https://my.immich.app/user-settings?isOpen=partner-sharing)
|
||||
|
||||
<img src={require('./img/partner-sharing-5.png').default} width="70%" title='Partner Sharing for the web interface' />
|
||||
<img src={require('./img/partner-sharing-5.webp').default} width="70%" title='Partner Sharing for the web interface' />
|
||||
|
||||
### 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
|
||||
|
||||
<img src={require('./img/partner-sharing-6.png').default} width="30%" title='Partner Sharing for the mobile app' />
|
||||
<img src={require('./img/partner-sharing-6.webp').default} width="30%" title='Partner Sharing for the mobile app' />
|
||||
|
||||
<img src={require('./img/partner-sharing-8.webp').default} width="30%" title='Partner Sharing for the mobile app' />
|
||||
|
||||
## 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.
|
||||
|
||||
<img src={require('./img/partner-sharing-7.png').default} width="70%" title='Remove Partner' />
|
||||
<img src={require('./img/partner-sharing-7.webp').default} width="70%" title='Remove Partner' />
|
||||
|
|
|
|||
|
|
@ -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. This data is loaded into the Postgres database on each minor version upgrade, allowing all queries to be run on your own server.
|
||||
|
||||
## Extraction
|
||||
|
||||
|
|
@ -8,7 +8,8 @@ During Exif Extraction, assets with latitudes and longitudes are reverse geocode
|
|||
|
||||
## Usage
|
||||
|
||||
Data from a reverse geocode is displayed in the image details, and used in [Smart Search](/docs/features/smart-search.md).
|
||||
Data from a reverse geocode is displayed in the image details, and used in [Smart Search](/docs/features/searching.md).
|
||||
|
||||
<img src={require('./img/reverse-geocoding-mobile1.png').default} width='33%' title='Reverse Geocoding' />
|
||||
<img src={require('./img/reverse-geocoding-mobile2.png').default} width='33%' title='Reverse Geocoding' />
|
||||
<img src={require('./img/reverse-geocoding-mobile3.webp').default} width='33%' title='Reverse Geocoding' />
|
||||
<img src={require('./img/reverse-geocoding-mobile1.webp').default} width='33%' title='Reverse Geocoding' />
|
||||
<img src={require('./img/reverse-geocoding-mobile2.webp').default} width='33%' title='Reverse Geocoding' />
|
||||
|
|
|
|||
|
|
@ -1,11 +1,11 @@
|
|||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Smart Search
|
||||
# Searching
|
||||
|
||||
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
|
||||
|
||||
|
|
@ -39,7 +39,7 @@ Some search examples:
|
|||
|
||||
<img src={require('./img/advanced-search-filters.webp').default} width="70%" title='Advanced search filters' />
|
||||
|
||||
<img src={require('./img/search-ex-1.png').default} width="70%" title='Search Example 1' />
|
||||
<img src={require('./img/search-ex-1.webp').default} width="70%" title='Search Example 1' />
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="Mobile" label="Mobile">
|
||||
|
|
@ -1,252 +0,0 @@
|
|||
# Shared Albums & Assets
|
||||
|
||||
## Shared Albums
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
Album sharing allows you to share assets with other users or with people from around the world via a link or invitation (for system users).
|
||||
|
||||
When sharing shared albums, whats shared is:
|
||||
|
||||
- The selected assets.
|
||||
- Metadata of the assets (Can be removed by sharing via link).
|
||||
|
||||
## 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.
|
||||
:::
|
||||
- Add a description to the album (Web only).
|
||||
- Slideshow view (Web only).
|
||||
- Add or remove photos to an album.
|
||||
- Comment on the album (for system users only).
|
||||
|
||||
:::info
|
||||
When you create an album and it is not shared with anyone, it will be added to the Albums category.
|
||||
:::
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="Computer" label="Computer" default>
|
||||
|
||||
### Create a Shared Album
|
||||
|
||||
1. Select the assets (Shift can be used for multiple selection).
|
||||
2. Click on the + on the top right -> add to a shared album.
|
||||
3. Name the new album and add the album.
|
||||
|
||||
## Sharing Between Users
|
||||
|
||||
### Shared Album Options
|
||||
|
||||
- Add or remove users from the album.
|
||||
:::info remove user(s)
|
||||
When a user is removed from the album, the photos he uploaded will still appear in the album.
|
||||
:::
|
||||
- Enable or disable comments & likes.
|
||||
- Replace the album cover.
|
||||
- Display order (newest first / oldest first).
|
||||
|
||||
To change these settings click on the 3 dots on the right -> options.
|
||||
|
||||
:::info Known bug
|
||||
Currently it is not possible to remove people through the options.
|
||||
This is a [known problem and it has a temporary solution](https://github.com/immich-app/immich/issues/7954)
|
||||
:::
|
||||
|
||||
## Share Album via Link
|
||||
|
||||
:::info
|
||||
When wanting to share with people outside the home network via a link, Immich needs to be exposed to the world wide web, read more to [learn the ways to do this](/docs/guides/remote-access.md).
|
||||
:::
|
||||
|
||||
1. Enter the shared album.
|
||||
2. Click on the share icon.
|
||||
3. Click on Create link.
|
||||
|
||||
You can edit the link properties, options include;
|
||||
|
||||
- **Description -** adding a description to the album (optional)
|
||||
- **Password -** adding a password to the album (optional), it is required to activate Require password.
|
||||
- **Show metadata -** whether to show metadata to whoever the link will be shared with (optional).
|
||||
- **Allow public user to download -** whether to allow whoever has the link to download all the images or a certain image (optional).
|
||||
- **Allow public user to upload -** whether to allow whoever has the link to upload assets to the album (optional).
|
||||
:::info
|
||||
Whoever has the link and have uploaded files cannot delete them.
|
||||
:::
|
||||
- **Expire after -** adding an expiration date to the link (optional).
|
||||
|
||||
## Share Specific Assets
|
||||
|
||||
A user can share specific assets without linking them to a specific album.
|
||||
In order to do this:
|
||||
|
||||
1. Go to the timeline
|
||||
2. Select the assets (Shift can be used for multiple selection)
|
||||
3. Click the share button
|
||||
|
||||
:::info
|
||||
Assets shared in this way will not be displayed in the Sharing category, in order to expect to remove or change the link settings of assets shared in this way, you must use the Manage generated links option.
|
||||
:::
|
||||
|
||||
:::tip
|
||||
For temporary sharing, you can add an expiration date to assets shared this way.
|
||||
:::
|
||||
|
||||
## Manage generated links
|
||||
|
||||
A user can copy, delete and change the link settings he created for specific albums or assets, in order to do so;
|
||||
|
||||
1. Go to the Immich home page.
|
||||
2. Select the Sharing category.
|
||||
3. On the top right, select Shared links.
|
||||
|
||||
:::info remove links/users.
|
||||
When making a shared album private, the added photos will **still** be saved in the album.
|
||||
:::
|
||||
|
||||
## Activity
|
||||
|
||||
:::info
|
||||
Activity is not visible when sharing an album via external link.
|
||||
New users added to the album will be able to see previous activity.
|
||||
:::
|
||||
|
||||
### Add a Comment or Like to the Album
|
||||
|
||||
1. Enter the shared album.
|
||||
2. From the bottom right you can add comment(s) or delete old comments.
|
||||
3. To add a like (heart) to the album, click the heart button to the left of the "say something" button.
|
||||
|
||||
#### Add a Comment or Like to a Specific Photo
|
||||
|
||||
:::info Activity
|
||||
Activity of a comment or heart on a specific photo will appear in the general activity of the album.
|
||||
:::
|
||||
|
||||
1. Enter the shared album.
|
||||
2. Enter the picture.
|
||||
3. From the bottom right you can add comment(s) or delete old comments.
|
||||
4. To add a like (heart) to the album, click the heart button to the left of the "say something" button.
|
||||
|
||||
### Viewing Activity in the Album
|
||||
|
||||
To view album activity on comments or likes
|
||||
|
||||
1. Enter the shared album
|
||||
2. On the bottom right click on the message icon
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="Mobile" label="Mobile">
|
||||
|
||||
:::note mobile app
|
||||
Some of the features are not available on mobile, to understand what the full features of shared albums are, it is recommended to additionally read the explanation for the computer version.
|
||||
:::
|
||||
|
||||
### Create a Shared Album
|
||||
|
||||
1. Select the assets.
|
||||
2. Swipe up and click on Create new album.
|
||||
3. Name the new album and add the album.
|
||||
|
||||
## Sharing Between Users
|
||||
|
||||
#### Add or remove users from the album
|
||||
|
||||
:::info remove user(s)
|
||||
When a user is removed from the album, the photos he uploaded will still appear in the album.
|
||||
:::
|
||||
|
||||
After creating the album, click the Add User button and select the user you want to share with.
|
||||
|
||||
### Shared Album Options
|
||||
|
||||
- Enable or disable comments & likes.
|
||||
- Add or remove users
|
||||
|
||||
To change these settings click on the 3 dots on the top right -> options.
|
||||
|
||||
## Share Album via Link
|
||||
|
||||
:::info
|
||||
When wanting to share with people outside the home network via a link, Immich needs to be exposed to the world wide web, read more to [learn the ways to do this](/docs/guides/remote-access.md).
|
||||
:::
|
||||
|
||||
1. Enter the shared album.
|
||||
2. Click 3 dots on the top right.
|
||||
3. Click on Share.
|
||||
|
||||
You can edit the link properties, options include;
|
||||
|
||||
- **Description -** adding a description to the album (optional)
|
||||
- **Password -** adding a password to the album (optional)
|
||||
- **Show metadata -** whether to show metadata to whoever the link will be shared with (optional).
|
||||
- **Allow public user to download -** whether to allow whoever has the link to download all the images or a certain image (optional).
|
||||
- **Allow public user to upload -** whether to allow whoever has the link to upload assets to the album (optional).
|
||||
::: info
|
||||
whoever has the link and have uploaded files cannot delete them.
|
||||
:::
|
||||
- **Expire after -** adding an expiration date to the link (optional).
|
||||
|
||||
## Share Specific Assets
|
||||
|
||||
A user can share specific assets without linking them to a specific album.
|
||||
in order to do so;
|
||||
|
||||
1. Go to the timeline
|
||||
2. Select the assets.
|
||||
3. Click the share button
|
||||
|
||||
:::info
|
||||
Assets shared in this way will not be displayed in the Sharing category, in order to expect to remove or change the link settings of assets shared in this way, you must use the Manage generated links option.
|
||||
:::
|
||||
|
||||
:::tip
|
||||
For temporary sharing, you can add an expiration date to assets shared this way.
|
||||
:::
|
||||
|
||||
## Manage generated links
|
||||
|
||||
A user can copy, delete and change the link settings he created for specific albums or assets, in order to do so;
|
||||
|
||||
1. Go to Sharing category.
|
||||
2. Select Shared links at the top right.
|
||||
|
||||
:::info remove links/users.
|
||||
When making a shared album private, the added photos will **still** be saved in the album.
|
||||
:::
|
||||
|
||||
## Activity
|
||||
|
||||
:::info
|
||||
Activity is not visible when sharing an album via external link.
|
||||
New users added to the album will be able to see previous activity.
|
||||
:::
|
||||
|
||||
### Add a Comment or Like to the Album
|
||||
|
||||
1. Enter the shared album.
|
||||
2. From the top right you can add comment(s) or delete old comments.
|
||||
3. To add a like (heart) to the album, click the heart button to the right of the "say something" button.
|
||||
|
||||
#### Add a Comment or Like to a Specific Photo
|
||||
|
||||
:::info Activity
|
||||
Activity of a comment or heart on a specific photo will appear in the general activity of the album.
|
||||
:::
|
||||
|
||||
1. Enter the shared album.
|
||||
2. Enter the picture.
|
||||
3. From the top right you can add comment(s) or delete old comments.
|
||||
4. To add a like (heart) to the album, click the heart button to the right of the "say something" button.
|
||||
|
||||
### Viewing Activity in the Album
|
||||
|
||||
To view album activity on comments or likes
|
||||
|
||||
1. Enter the shared album
|
||||
2. On the top right click on the message icon
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
51
docs/docs/features/sharing.md
Normal file
|
|
@ -0,0 +1,51 @@
|
|||
# Sharing
|
||||
|
||||
Immich supports local sharing, with users on the same Immich instance, and public sharing via public links.
|
||||
|
||||
## Local sharing
|
||||
|
||||
### Albums
|
||||
|
||||
Albums can be shared between users on the same Immich instance. The shared users can view and add their own photos and videos to the shared album.
|
||||
|
||||
After creating an album, you can access the sharing options by clicking on the share icon. When sharing an album, you can select the users you want to share the album with and assign them permissions either as editors (read-write) or viewers (read-only).
|
||||
|
||||
#### Web
|
||||
|
||||
<img src={require('./img/shared-album.webp').default} width='60%' title='Shared album option' caption='ok' />
|
||||
|
||||
<img src={require('./img/shared-album-user-selection.webp').default} width='30%' height='100%' title='Shared album user selection' />
|
||||
|
||||
#### Mobile App
|
||||
|
||||
<img src={require('./img/shared-album-mobile.webp').default} width='33%' title='Shared album option' />
|
||||
|
||||
### Partners
|
||||
|
||||
Partner sharing allows you to share your _entire_ library with other users of your choice. They can then view your library and download the assets.
|
||||
|
||||
You can read this guide to learn more about [partner sharing](/docs/features/partner-sharing).
|
||||
|
||||
## Public sharing
|
||||
|
||||
You can create a public link to share a group of photos or videos, or an album, with anyone. The public link can be shared via email, social media, or any other method. There are a varierity of options to customize the public link, such as setting an expiration date, password protection, and more. Public shared link is handy when you want to share a group of photos or videos with someone who doesn't have an Immich account and allow the shared user to upload their photos or videos to your account.
|
||||
|
||||
The public shared link is generated with a random URL, which acts as as a secret to avoid the link being guessed by unwanted parties, for instance.
|
||||
|
||||
```
|
||||
https://immich.yourdomain.com/share/JUckRMxlgpo7F9BpyqGk_cZEwDzaU_U5LU5_oNZp1ETIBa9dpQ0b5ghNm_22QVJfn3k
|
||||
```
|
||||
|
||||
### Creating a public share link
|
||||
|
||||
You can create a public share link by selecting the photos or videos, or from the share icon on an album.
|
||||
|
||||
<img src={require('./img/public-shared-link-individual.webp').default} width='60%' title='Creating public shared link from selection' />
|
||||
|
||||
<img src={require('./img/public-shared-link-album.webp').default} width='30%' title='Creating public shared link from album' />
|
||||
|
||||
### Customizing the public share link
|
||||
|
||||
You can customize the public share link by setting an expiration date, password protection, allow what actions can be performed on the shared assets, and more.
|
||||
|
||||
<img src={require('./img/public-shared-link-form.webp').default} width='33%' title='Creating public shared link from album' />
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
# Supported formats
|
||||
# Supported Media Formats
|
||||
|
||||
Immich supports a number of image and video formats, the most common of which are outlined here.
|
||||
|
||||
|
|
@ -15,9 +15,9 @@ For the full list, refer to the [Immich source code](https://github.com/immich-a
|
|||
| `GIF` | `.gif` | :white_check_mark: | |
|
||||
| `HEIC` | `.heic` | :white_check_mark: | |
|
||||
| `HEIF` | `.heif` | :white_check_mark: | |
|
||||
| `JPEG` | `.jpeg` `.jpg` `.jpe` `.insp` | :white_check_mark: | |
|
||||
| `JPEG` | `.webp` `.jpg` `.jpe` `.insp` | :white_check_mark: | |
|
||||
| `JPEG XL` | `.jxl` | :white_check_mark: | |
|
||||
| `PNG` | `.png` | :white_check_mark: | |
|
||||
| `PNG` | `.webp` | :white_check_mark: | |
|
||||
| `PSD` | `.psd` | :white_check_mark: | Adobe Photoshop |
|
||||
| `RAW` | `.raw` | :white_check_mark: | |
|
||||
| `RW2` | `.rw2` | :white_check_mark: | |
|
||||
|
|
|
|||
25
docs/docs/features/tags.md
Normal file
|
|
@ -0,0 +1,25 @@
|
|||
# Tags
|
||||
|
||||
Immich supports hierarchical tags, with the ability to read existing tags from the `TagList` and `Keywords` EXIF properties. Any changes to tags made through Immich are also written back to a [sidecar](/docs/features/xmp-sidecars) file. You can re-run the metadata extraction jobs for all assets to import your existing tags.
|
||||
|
||||
## Enable tags feature
|
||||
|
||||
You can enable this feature from the [`Account Settings > Features > Tags`](https://my.immich.app/user-settings?isOpen=feature+tags).
|
||||
|
||||
<img src={require('./img/tag-enable.webp').default} width="50%" title='Tag view enable' />
|
||||
|
||||
## Creating tags
|
||||
|
||||
Tags can be created and added to a photo or a video by clicking on the `+ Add` button at the bottom of the info panel.
|
||||
|
||||
<img src={require('./img/tag-creation.webp').default} width="40%" title='Tag view enable' />
|
||||
|
||||
The tag prompt will appear, and you find and select a tag, or type in a new tag to create it.
|
||||
|
||||
<img src={require('./img/tag-form.webp').default} width="40%" title='Tag form' />
|
||||
|
||||
## Viewing tags
|
||||
|
||||
You can navigate to the `Tags` view from the side navigation bar or by clicking on the tag in the info panel.
|
||||
|
||||
<img src={require('./img/tag-view.webp').default} width="80%" title='Tag form' />
|
||||
|
|
@ -1,21 +1,21 @@
|
|||
# User Settings
|
||||
|
||||

|
||||
Immich gives each user the ability to manage their own settings. This includes being able to update their profile, toggle certain feature, generate API keys, manage the logged in devices, a view of account usage statistics, and more.
|
||||
|
||||
## User Profile
|
||||
<img src={require('./img/user-settings-3.webp').default} width="60%" title='User settings lists' />
|
||||
|
||||
View your User ID and email, and update your first and last name.
|
||||
You can access the [user settings](https://my.immich.app/user-settings) by clicking on the user icon on the top right corner of the screen and selecting the `Account Settings` option.
|
||||
|
||||

|
||||
<img src={require('./img/user-settings-1.webp').default} width="33%" title='User settings location 1' />
|
||||
|
||||
## Change Password
|
||||
<br/>
|
||||
|
||||
Users can change their own passwords.
|
||||
<img src={require('./img/user-settings-2.webp').default} width="33%" title='User settings location 2' />
|
||||
|
||||

|
||||
---
|
||||
|
||||
:::tip Reset Password
|
||||
The admin can reset a password through the [User Management](/docs/administration/user-management.mdx) screen.
|
||||
The admin can reset a user password through the [User Management](/docs/administration/user-management.mdx) screen.
|
||||
:::
|
||||
|
||||
:::tip Reset Admin Password
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Immich can ingest XMP sidecars on file upload (via the CLI) as well as detect new sidecars that are placed in the filesystem for existing images.
|
||||
|
||||
<img src={require('./img/xmp-sidecars.png').default} title='XMP sidecars' />
|
||||
<img src={require('./img/xmp-sidecars.webp').default} title='XMP sidecars' />
|
||||
|
||||
XMP sidecars are external XML files that contain metadata related to media files. Many applications read and write these files either exclusively or in addition to the metadata written to image files. They can be a powerful tool for editing and storing metadata of a media file without modifying the media file itself. When Immich receives or detects an XMP sidecar for a media file, it will attempt to extract the metadata from both the sidecar as well as the media file. It will prioritize the metadata for fields in the sidecar but will fall back and use the metadata in the media file if necessary.
|
||||
|
||||
|
|
@ -10,4 +10,4 @@ When importing files via the CLI bulk uploader or parsing photo metadata for ext
|
|||
|
||||
There are 2 administrator jobs associated with sidecar files: `SYNC` and `DISCOVER`. The sync job will re-scan all media with existing sidecar files and queue them for a metadata refresh. This is a great use case when third-party applications are used to modify the metadata of media. The discover job will attempt to scan the filesystem for new sidecar files for all media that does not currently have a sidecar file associated with it.
|
||||
|
||||
<img src={require('./img/sidecar-jobs.png').default} title='Sidecar Administrator Jobs' />
|
||||
<img src={require('./img/sidecar-jobs.webp').default} title='Sidecar Administrator Jobs' />
|
||||
|
|
|
|||