From 88b8d34aa60e84d3af99ba3be462e3788c97cd81 Mon Sep 17 00:00:00 2001 From: Alex Tran Date: Sun, 20 Nov 2022 16:44:33 -0600 Subject: [PATCH] Update .env.example file --- docker/.env.example | 45 ++++++++++++++++++++++++++++++++------------- 1 file changed, 32 insertions(+), 13 deletions(-) diff --git a/docker/.env.example b/docker/.env.example index a594f9c0bf..a2053e29af 100644 --- a/docker/.env.example +++ b/docker/.env.example @@ -23,7 +23,9 @@ REDIS_HOSTNAME=immich_redis # REDIS_SOCKET= ################################################################################### -# Upload File Config +# Upload File Location +# +# This is the location where uploaded files are stored. ################################################################################### UPLOAD_LOCATION=absolute_location_on_your_machine_where_you_want_to_store_the_backup @@ -36,19 +38,17 @@ LOG_LEVEL=simple ################################################################################### # JWT SECRET -################################################################################### - +# # This JWT_SECRET is used to sign the authentication keys for user login # You should set it to a long randomly generated value # You can use this command to generate one: openssl rand -base64 128 +################################################################################### + JWT_SECRET= ################################################################################### # Reverse Geocoding -#################################################################################### - -# DISABLE_REVERSE_GEOCODING=false - +# # Reverse geocoding is done locally which has a small impact on memory usage # This memory usage can be altered by changing the REVERSE_GEOCODING_PRECISION variable # This ranges from 0-3 with 3 being the most precise @@ -56,25 +56,44 @@ JWT_SECRET= # 2 - Cities > 1000 population: ~150MB RAM # 1 - Cities > 5000 population: ~80MB RAM # 0 - Cities > 15000 population: ~40MB RAM +#################################################################################### +# DISABLE_REVERSE_GEOCODING=false # REVERSE_GEOCODING_PRECISION=3 #################################################################################### # WEB - Optional -#################################################################################### - +# # Custom message on the login page, should be written in HTML form. -# For example PUBLIC_LOGIN_PAGE_MESSAGE="This is a demo instance of Immich.

Email: demo@demo.de
Password: demo" +# For example: +# PUBLIC_LOGIN_PAGE_MESSAGE="This is a demo instance of Immich.

Email: demo@demo.de
Password: demo" +#################################################################################### PUBLIC_LOGIN_PAGE_MESSAGE= #################################################################################### # Alternative Service Addresses - Optional -#################################################################################### - -# This is an advanced feature for users who may be running their immich services on different hosts. It will not change which address or port that services bind to within their containers, but it will change where other services look for their peers. +# +# This is an advanced feature for users who may be running their immich services on different hosts. +# It will not change which address or port that services bind to within their containers, but it will change where other services look for their peers. # Note: immich-microservices is bound to 3002, but no references are made +#################################################################################### # IMMICH_WEB_URL=http://immich-web:3000 # IMMICH_SERVER_URL=http://immich-server:3001 # IMMICH_MACHINE_LEARNING_URL=http://immich-machine-learning:3003 + +#################################################################################### +# OAuth Setting - Optional +# +# These setting will enable OAuth login for your instance of Immich +# Folow the instructions in the page https://immich.app/docs/usage/oauth to set up your OAuth provider +#################################################################################### + +# OAUTH_ENABLED=false +# OAUTH_ISSUER_URL= +# OAUTH_CLIENT_ID= +# OAUTH_CLIENT_SECRET= +# OAUTH_BUTTON_TEXT=Login with OAuth +# OAUTH_AUTO_REGISTER=true +# OAUTH_SCOPE="openid profile email"