From 171e7ffa779a0bfbf3c2168ee22846e4d88bb7ef Mon Sep 17 00:00:00 2001 From: Alex Tran Date: Sat, 21 May 2022 08:30:27 -0500 Subject: [PATCH] Update readme --- README.md | 28 +++++++++++++++++++++++++--- 1 file changed, 25 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 57eed08e16..466b81e8e7 100644 --- a/README.md +++ b/README.md @@ -109,37 +109,59 @@ Pay attention to the key `UPLOAD_LOCATION`, this directory must exist and is own **Example** ```bash +################################################################################### # Database +################################################################################### DB_USERNAME=postgres DB_PASSWORD=postgres DB_DATABASE_NAME=immich +################################################################################### # Upload File Config +################################################################################### UPLOAD_LOCATION= +################################################################################### # JWT SECRET +################################################################################### JWT_SECRET=randomstringthatissolongandpowerfulthatnoonecanguess +################################################################################### # MAPBOX -## ENABLE_MAPBOX is either true of false -> if true, you have to provide MAPBOX_KEY +#################################################################################### +# ENABLE_MAPBOX is either true of false -> if true, you have to provide MAPBOX_KEY ENABLE_MAPBOX=false MAPBOX_KEY= + +################################################################################### +# WEB +################################################################################### +# This is the URL of your vm/server where you host Immich, so that the web frontend +# know where can it make the request to. +# For example: If your server IP address is 10.1.11.50, the environment variable will +# be VITE_SERVER_ENDPOINT=http://10.1.11.50:2283 +VITE_SERVER_ENDPOINT=http://192.168.1.216:2283 ``` ## Step 2: Start the server -To start, run +To **start**, run ```bash docker-compose -f ./docker/docker-compose.yml up ``` -If you have a few thousand photos/videos, I suggest running docker-compose with scaling option for the `immich_-erver` container to handle high I/O load when using fast scrolling. +If you have a few thousand photos/videos, I suggest running docker-compose with *scaling* option for the `immich_server` container to handle high I/O load when using fast scrolling. ```bash docker-compose -f ./docker/docker-compose.yml up --scale immich-server=5 ``` +To *update* docker-compose with newest image (if you have started the docker-compose previously) + +```bash +docker-compose -f ./docker/docker-compose.yml pull && docker-compose -f ./docker/docker-compose.yml up +``` The server will be running at `http://your-ip:2283` through `Nginx`