Skip to content

Commit

Permalink
docs: update (#4893)
Browse files Browse the repository at this point in the history
* docs: update

* chore:format
  • Loading branch information
alextran1502 authored Nov 7, 2023
1 parent c2c26c4 commit bb28cae
Show file tree
Hide file tree
Showing 10 changed files with 66 additions and 8 deletions.
4 changes: 4 additions & 0 deletions docs/docs/features/bulk-upload.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ You can use the CLI to upload an existing gallery to the Immich server

[Immich CLI Repository](https://github.com/immich-app/CLI)

:::tip Google Photos Takeout
If you are looking to import your Google Photos takeout, we recommed this community maintained tool [immich-go](https://github.com/simulot/immich-go)
:::

## Requirements

- Node.js 16 or above
Expand Down
15 changes: 15 additions & 0 deletions docs/docs/features/facial-recognition.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Facial Recognition

## Overview

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.
Expand All @@ -13,3 +15,16 @@ Upon clicking on a person, a list of assets that contain their face will be show
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' />

## Actions

Additional actions you can do with a detected person are:

- Change the feature face photo of the person
- Set date of birth
- Merge two or more detected faces into one person
- Hide face

It can be found from the app bar when you access the detial view of a person

<img src={require('./img/facial-recognition-4.png').default} title='Facial Recognition 4' width="70%"/>
Binary file added docs/docs/features/img/facial-recognition-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/docs/features/mobile-app.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import MobileAppDownload from '../partials/_mobile-app-download.md';
import MobileAppLogin from '../partials/_mobile-app-login.md';
import MobileAppBackup from '../partials/_mobile-app-login.md';
import MobileAppBackup from '../partials/_mobile-app-backup.md';

# Mobile App

Expand Down
51 changes: 45 additions & 6 deletions docs/docs/install/config-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@ The default configuration looks like this:
"targetAudioCodec": "aac",
"targetResolution": "720",
"maxBitrate": "0",
"bframes": -1,
"refs": 0,
"gopSize": 0,
"npl": 0,
"temporalAQ": false,
"cqMode": "auto",
"twoPass": false,
"transcode": "required",
"tonemap": "hable",
Expand Down Expand Up @@ -44,9 +50,15 @@ The default configuration looks like this:
"sidecar": {
"concurrency": 5
},
"library": {
"concurrency": 5
},
"storageTemplateMigration": {
"concurrency": 5
},
"migration": {
"concurrency": 5
},
"thumbnailGeneration": {
"concurrency": 5
},
Expand All @@ -55,16 +67,16 @@ The default configuration looks like this:
}
},
"machineLearning": {
"enabled": true,
"url": "http://immich-machine-learning:3003",
"classification": {
"minScore": 0.7,
"enabled": true,
"modelName": "microsoft/resnet-50"
"modelName": "microsoft/resnet-50",
"minScore": 0.9
},
"enabled": true,
"url": "http://immich-machine-learning:3003",
"clip": {
"enabled": true,
"modelName": "ViT-B-32::openai"
"modelName": "ViT-B-32__openai"
},
"facialRecognition": {
"enabled": true,
Expand All @@ -74,6 +86,14 @@ The default configuration looks like this:
"minFaces": 1
}
},
"map": {
"enabled": true,
"tileUrl": "https://tile.openstreetmap.org/{z}/{x}/{y}.png"
},
"reverseGeocoding": {
"enabled": true,
"citiesFileOverride": "cities500"
},
"oauth": {
"enabled": false,
"issuerUrl": "",
Expand All @@ -96,8 +116,27 @@ The default configuration looks like this:
"thumbnail": {
"webpSize": 250,
"jpegSize": 1440,
"quality": 90,
"quality": 80,
"colorspace": "p3"
},
"newVersionCheck": {
"enabled": true
},
"trash": {
"enabled": true,
"days": 30
},
"theme": {
"customCss": ""
},
"library": {
"scan": {
"enabled": true,
"cronExpression": "0 0 * * *"
}
},
"stylesheets": {
"css": ""
}
}
```
Expand Down
Binary file modified docs/docs/partials/img/backup-header.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/docs/partials/img/sign-in-phone.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/docs/partials/img/storage-template.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/src/pages/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ function HomepageHeader() {
</Link>
</div>

<img src="/img/immich-screenshots.png" alt="logo" />
<img src="/img/immich-screenshots.png" alt="screenshots" width={'85%'} />

<div className="flex flex-col sm:flex-row place-items-center place-content-center mt-4 gap-1">
<div className="h-24">
Expand Down
Binary file modified docs/static/img/immich-screenshots.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

1 comment on commit bb28cae

@vercel
Copy link

@vercel vercel bot commented on bb28cae Nov 7, 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.