diff --git a/README.md b/README.md index 1dac1b91ec..c1bb6a883d 100644 --- a/README.md +++ b/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 diff --git a/docs/docs/developer/setup.md b/docs/docs/developer/setup.md index a088ab87ba..bbd2a75980 100644 --- a/docs/docs/developer/setup.md +++ b/docs/docs/developer/setup.md @@ -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/ -d ./libs/infra/src/db/config/database.config.ts +npm run typeorm:migrations:generate ./libs/infra/src/ ``` 3. Check if the migration file makes sense. diff --git a/docs/docs/features/facial-recognition.md b/docs/docs/features/facial-recognition.md new file mode 100644 index 0000000000..b9efba4286 --- /dev/null +++ b/docs/docs/features/facial-recognition.md @@ -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. + + + +Upon clicking on a person, a list of assets that contain their face will be shown. + + + +The asset detail view will also show the faces that are recognized in the asset. + + diff --git a/docs/docs/features/img/facial-recognition-1.png b/docs/docs/features/img/facial-recognition-1.png new file mode 100644 index 0000000000..c6b6000541 Binary files /dev/null and b/docs/docs/features/img/facial-recognition-1.png differ diff --git a/docs/docs/features/img/facial-recognition-2.png b/docs/docs/features/img/facial-recognition-2.png new file mode 100644 index 0000000000..f339380d30 Binary files /dev/null and b/docs/docs/features/img/facial-recognition-2.png differ diff --git a/docs/docs/features/img/facial-recognition-3.png b/docs/docs/features/img/facial-recognition-3.png new file mode 100644 index 0000000000..73ab7dc894 Binary files /dev/null and b/docs/docs/features/img/facial-recognition-3.png differ diff --git a/docs/docs/features/img/partner-sharing-1.png b/docs/docs/features/img/partner-sharing-1.png new file mode 100644 index 0000000000..49ab3aa402 Binary files /dev/null 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 new file mode 100644 index 0000000000..8cfc8e39c1 Binary files /dev/null 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 new file mode 100644 index 0000000000..7aa2590f68 Binary files /dev/null and b/docs/docs/features/img/partner-sharing-3.png differ diff --git a/docs/docs/features/partner-sharing.md b/docs/docs/features/partner-sharing.md new file mode 100644 index 0000000000..fa9367fbda --- /dev/null +++ b/docs/docs/features/partner-sharing.md @@ -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. + + + + + +Accessing the shared library can be done from the Sharing page. + + + +:::tip Sharing specific assets +For sharing a specific set of assets, you can use the shared album feature of Immich. +:::