Skip to content

Commit

Permalink
docs: add new features (#2441)
Browse files Browse the repository at this point in the history
* 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>
  • Loading branch information
jrasm91 and alextran1502 committed May 18, 2023
1 parent b50c621 commit 2fc8a0d
Show file tree
Hide file tree
Showing 10 changed files with 57 additions and 20 deletions.
43 changes: 24 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/developer/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
15 changes: 15 additions & 0 deletions docs/docs/features/facial-recognition.md
Original file line number Diff line number Diff line change
@@ -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' />
Binary file added docs/docs/features/img/facial-recognition-1.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/features/img/facial-recognition-2.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/features/img/facial-recognition-3.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/features/img/partner-sharing-1.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/features/img/partner-sharing-2.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/features/img/partner-sharing-3.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 17 additions & 0 deletions docs/docs/features/partner-sharing.md
Original file line number Diff line number Diff line change
@@ -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.
:::

1 comment on commit 2fc8a0d

@vercel
Copy link

@vercel vercel bot commented on 2fc8a0d May 18, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.