diff --git a/docs/docs/developer/architecture.md b/docs/docs/developer/architecture.md index 962270d8da..85295c4791 100644 --- a/docs/docs/developer/architecture.md +++ b/docs/docs/developer/architecture.md @@ -28,6 +28,7 @@ Immich is a full-stack [TypeScript](https://www.typescriptlang.org/) application - [Nest.js](https://nestjs.com/) - [TypeORM](https://typeorm.io/) for database management. - [Jest](https://jestjs.io/) for testing. +- [Python](https://www.python.org/) for Machine Learning. ### Database diff --git a/docs/docs/developer/img/app-architecture.png b/docs/docs/developer/img/app-architecture.png index f26b9b8b46..6d1f15226b 100644 Binary files a/docs/docs/developer/img/app-architecture.png and b/docs/docs/developer/img/app-architecture.png differ diff --git a/docs/docs/features/automatic-backup.md b/docs/docs/features/automatic-backup.md index c2889d5fba..8dbe113dd0 100644 --- a/docs/docs/features/automatic-backup.md +++ b/docs/docs/features/automatic-backup.md @@ -4,33 +4,31 @@ A guide on how the foreground and background automatic backup works. -On iOS, there is only one option for automatic backup - -- [Automatic Backup](#automatic-backup) - - [Foreground backup](#foreground-backup) - -On Android, there are two options for automatic backup - -- [Automatic Backup](#automatic-backup) - - [Foreground backup](#foreground-backup) - - [Background backup](#background-backup) - ## Foreground backup If foreground backup is enabled: whenever the app is opened or resumed, it will check if any photos or videos in the selected album(s) have yet to be uploaded to the cloud (the remainder count). If there are any, they will be uploaded. ## Background backup -Background backup is only available on Android thanks to the contribution effort of [@zoodyy](https://github.com/zoodyy). +Background backup is available thanks to the contribution effort of [@zoodyy](https://github.com/zoodyy) and [@martyfuhry](https://github.com/martyfuhry). 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. -A native Android notification shows up when the background upload is in progress. You can further customize the notification by going to the app's settings. :::info Note +#### General - The app must be in the background for the backup worker to start running. -- It is a well-known problem that some Android models are very strict with battery optimization settings, which can cause a problem with the background worker. Please visit [Don't kill my app](https://dontkillmyapp.com/) for a guide on disabling this setting on your phone. - If you reopen the app and the first page you see is the backup page, the counts will not reflect the background uploaded result. You have to navigate out of the page and come back to see the updated counts. +#### Android +- It is a well-known problem that some Android models are very strict with battery optimization settings, which can cause a problem with the background worker. Please visit [Don't kill my app](https://dontkillmyapp.com/) for a guide on disabling this setting on your phone. + +#### iOS +- 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. + +
+ +
+ ::: diff --git a/docs/docs/features/img/background-app-refresh.png b/docs/docs/features/img/background-app-refresh.png new file mode 100644 index 0000000000..c96f748f23 Binary files /dev/null and b/docs/docs/features/img/background-app-refresh.png differ diff --git a/docs/docs/features/img/user-popup.png b/docs/docs/features/img/user-popup.png index d12522836d..dc090f09c2 100644 Binary files a/docs/docs/features/img/user-popup.png and b/docs/docs/features/img/user-popup.png differ diff --git a/docs/docs/install/requirements.md b/docs/docs/install/requirements.md index fded1cb7b1..ec552eaf25 100644 --- a/docs/docs/install/requirements.md +++ b/docs/docs/install/requirements.md @@ -20,28 +20,3 @@ You can also use Podman to run the application. However, additional configuratio - **OS**: Preferred unix-based operating system (Ubuntu, Debian, MacOS, etc). Windows works too, with [Docker Desktop on Windows](https://docs.docker.com/desktop/install/windows-install/) - **RAM**: At least 2GB, preferred 4GB. - **CPU**: At least 2 cores, preferred 4 cores. - -:::info Machine Learning on older CPU - -The TensorFlow version used by Immich doesn't run on older CPU architectures. It requires a CPU with AVX and AVX2 instruction sets. If you encounter the error `illegal instruction core dump` check your CPU flags with the command below and make sure you see `avx` and `avx2`: - -```bash -grep -E 'avx2?' /proc/cpuinfo -``` - -#### Promox - -If you are running virtualization in Proxmox, the CPU type of the VM is probably configured incorrectly. - -You need to change the CPU type from `kvm64` to `host` under VMs hardware tab. - -`Hardware > Processors > Edit > Advanced > Type (dropdown menu) > host` - -#### Other platforms - -You can use the machine learning image that is built for Non-AVX CPU. The image is community maintained and can be found in the repository below - -https://github.com/bertmelis/immich-machine-learning-no-avx - -Otherwise, you can safely remove the `immich-machine-learning` service if you do not intend to use Immich's object detection features. Simply remove or comment out the declaration of the service in your compose file. -::: diff --git a/docs/docs/partials/img/admin-registration-form.png b/docs/docs/partials/img/admin-registration-form.png index 1ded0cbd2a..f25e028c8b 100644 Binary files a/docs/docs/partials/img/admin-registration-form.png and b/docs/docs/partials/img/admin-registration-form.png differ diff --git a/docs/docs/partials/img/create-new-user.png b/docs/docs/partials/img/create-new-user.png index 676058375a..06d046653d 100644 Binary files a/docs/docs/partials/img/create-new-user.png and b/docs/docs/partials/img/create-new-user.png differ