From 676813ab18f84378abd6b73e9e37ee1fb6357848 Mon Sep 17 00:00:00 2001 From: Juhyung Park Date: Mon, 4 Mar 2024 15:13:42 +0900 Subject: [PATCH] Briefly explain what the install script does Signed-off-by: Juhyung Park --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 95a2a58..14a9ad3 100644 --- a/README.md +++ b/README.md @@ -103,6 +103,20 @@ Clone this repository to somewhere anyone can access (like /tmp) and run `instal Anytime Immich is updated, all you have to do is run it again. +In summary, the `install.sh` script does the following: + +#### 1. Clones and builds Immich. + +#### 2. Installs Immich to `/var/lib/immich` with minor patches. + + * Sets up a dedicated Python venv to `/var/lib/immich/app/machine-learning/venv`. + + * Replaces `/usr/src` to `/var/lib/immich`. + + * Limits listening host from 0.0.0.0 to 127.0.0.1 for microservices and machine-learning. + + * Installs systemd services. + ## Done! Your Immich installation should be running at :3001 port.