mirror of
https://github.com/immich-app/immich.git
synced 2024-12-28 06:31:58 +00:00
docs: add new features (#2441)
* chore: add new features * Add facial recognition to docs site * Added partner sharing to the docs site * update developer docs --------- Co-authored-by: Alex Tran <alex.tran1502@gmail.com>
This commit is contained in:
parent
b50c621be8
commit
2fc8a0db92
10 changed files with 57 additions and 20 deletions
43
README.md
43
README.md
|
@ -60,25 +60,30 @@ Spec: Free-tier Oracle VM - Amsterdam - 2.4Ghz quad-core ARM64 CPU, 24GB RAM
|
|||
|
||||
# Features
|
||||
|
||||
| Features | Mobile | Web |
|
||||
| ------------------------------------------- | ------ | --- |
|
||||
| Upload and view videos and photos | Yes | Yes |
|
||||
| Auto backup when the app is opened | Yes | N/A |
|
||||
| Selective album(s) for backup | Yes | N/A |
|
||||
| Download photos and videos to local device | Yes | Yes |
|
||||
| Multi-user support | Yes | Yes |
|
||||
| Album and Shared albums | Yes | Yes |
|
||||
| Scrubbable/draggable scrollbar | Yes | Yes |
|
||||
| Support RAW (HEIC, HEIF, DNG, Apple ProRaw) | Yes | Yes |
|
||||
| Metadata view (EXIF, map) | Yes | Yes |
|
||||
| Search by metadata, objects and CLIP | Yes | Yes |
|
||||
| Administrative functions (user management) | N/A | Yes |
|
||||
| Background backup | Yes | N/A |
|
||||
| Virtual scroll | Yes | Yes |
|
||||
| OAuth support | Yes | Yes |
|
||||
| LivePhoto backup and playback | iOS | Yes |
|
||||
| User-defined storage structure | Yes | Yes |
|
||||
| Public Sharing | N/A | Yes |
|
||||
| Features | Mobile | Web |
|
||||
| -------------------------------------------- | ------ | --- |
|
||||
| Upload and view videos and photos | Yes | Yes |
|
||||
| Auto backup when the app is opened | Yes | N/A |
|
||||
| Selective album(s) for backup | Yes | N/A |
|
||||
| Download photos and videos to local device | Yes | Yes |
|
||||
| Multi-user support | Yes | Yes |
|
||||
| Album and Shared albums | Yes | Yes |
|
||||
| Scrubbable/draggable scrollbar | Yes | Yes |
|
||||
| Support RAW (HEIC, HEIF, DNG, Apple ProRaw) | Yes | Yes |
|
||||
| Metadata view (EXIF, map) | Yes | Yes |
|
||||
| Search by metadata, objects, faces, and CLIP | Yes | Yes |
|
||||
| Administrative functions (user management) | No | Yes |
|
||||
| Background backup | Yes | N/A |
|
||||
| Virtual scroll | Yes | Yes |
|
||||
| OAuth support | Yes | Yes |
|
||||
| API Keys | N/A | Yes |
|
||||
| LivePhoto backup and playback | iOS | Yes |
|
||||
| User-defined storage structure | Yes | Yes |
|
||||
| Public Sharing | No | Yes |
|
||||
| Archive and Favorites | Yes | Yes |
|
||||
| Global Map | No | Yes |
|
||||
| Partner Sharing | No | Yes |
|
||||
| Facial recognition and clustering | No | Yes |
|
||||
|
||||
# Support the project
|
||||
|
||||
|
|
|
@ -111,7 +111,7 @@ After making any changes in the `server/libs/database/src/entities`, a database
|
|||
2. Run
|
||||
|
||||
```bash
|
||||
npm run typeorm -- migration:generate ./libs/infra/src/db/<migration-name> -d ./libs/infra/src/db/config/database.config.ts
|
||||
npm run typeorm:migrations:generate ./libs/infra/src/<migration-name>
|
||||
```
|
||||
|
||||
3. Check if the migration file makes sense.
|
||||
|
|
15
docs/docs/features/facial-recognition.md
Normal file
15
docs/docs/features/facial-recognition.md
Normal file
|
@ -0,0 +1,15 @@
|
|||
# Facial Recognition
|
||||
|
||||
Immich recognizes faces in your photos and videos and groups them together. You can then assign names to the faces and search for them.
|
||||
|
||||
The list of people is shown in the Explore page.
|
||||
|
||||
<img src={require('./img/facial-recognition-1.png').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' />
|
||||
|
||||
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' />
|
BIN
docs/docs/features/img/facial-recognition-1.png
Normal file
BIN
docs/docs/features/img/facial-recognition-1.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 524 KiB |
BIN
docs/docs/features/img/facial-recognition-2.png
Normal file
BIN
docs/docs/features/img/facial-recognition-2.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 2.6 MiB |
BIN
docs/docs/features/img/facial-recognition-3.png
Normal file
BIN
docs/docs/features/img/facial-recognition-3.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 1.6 MiB |
BIN
docs/docs/features/img/partner-sharing-1.png
Normal file
BIN
docs/docs/features/img/partner-sharing-1.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 84 KiB |
BIN
docs/docs/features/img/partner-sharing-2.png
Normal file
BIN
docs/docs/features/img/partner-sharing-2.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 56 KiB |
BIN
docs/docs/features/img/partner-sharing-3.png
Normal file
BIN
docs/docs/features/img/partner-sharing-3.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 183 KiB |
17
docs/docs/features/partner-sharing.md
Normal file
17
docs/docs/features/partner-sharing.md
Normal file
|
@ -0,0 +1,17 @@
|
|||
# Partner Sharing
|
||||
|
||||
Immich allows you to share your library with other users. They can then view your library and download the assets.
|
||||
|
||||
You can manage one or multiple users to have access to your library from the [User Settings](docs/features/user-settings.md) page.
|
||||
|
||||
<img src={require('./img/partner-sharing-1.png').default} title='Partner Sharing 1' />
|
||||
|
||||
<img src={require('./img/partner-sharing-2.png').default} title='Partner Sharing 2' />
|
||||
|
||||
Accessing the shared library can be done from the Sharing page.
|
||||
|
||||
<img src={require('./img/partner-sharing-3.png').default} title='Partner Sharing 3' />
|
||||
|
||||
:::tip Sharing specific assets
|
||||
For sharing a specific set of assets, you can use the shared album feature of Immich.
|
||||
:::
|
Loading…
Reference in a new issue