diff --git a/docker/example.env b/docker/example.env index 5697a97ce0..319bb39c27 100644 --- a/docker/example.env +++ b/docker/example.env @@ -1,116 +1,19 @@ -################################################################################### -# Database -################################################################################### +# You can find documentation for all the supported env variables at https://immich.app/docs/install/environment-variables -# NOTE: The following four database variables support Docker secrets by adding a *_FILE suffix to the variable name -# See the docker-compose documentation on secrets for additional details: https://docs.docker.com/compose/compose-file/compose-file-v3/#secrets +# The location where your uploaded files are stored +UPLOAD_LOCATION=./library + +# The Immich version to use. You can pin this to a specific version like "v1.71.0" +IMMICH_VERSION=release + +# Connection secrets for postgres and typesense. You should change these to random passwords +TYPESENSE_API_KEY=some-random-text +DB_PASSWORD=postgres + +# The values below this line do not need to be changed +################################################################################### DB_HOSTNAME=immich_postgres DB_USERNAME=postgres -DB_PASSWORD=postgres DB_DATABASE_NAME=immich -# Optional Database settings: -# DB_PORT=5432 - -################################################################################### -# Redis -################################################################################### - REDIS_HOSTNAME=immich_redis - -# REDIS_URL will be used to pass custom options to ioredis. -# Example for Sentinel -# {"sentinels":[{"host":"redis-sentinel-node-0","port":26379},{"host":"redis-sentinel-node-1","port":26379},{"host":"redis-sentinel-node-2","port":26379}],"name":"redis-sentinel"} -# REDIS_URL=ioredis://eyJzZW50aW5lbHMiOlt7Imhvc3QiOiJyZWRpcy1zZW50aW5lbDEiLCJwb3J0IjoyNjM3OX0seyJob3N0IjoicmVkaXMtc2VudGluZWwyIiwicG9ydCI6MjYzNzl9XSwibmFtZSI6Im15bWFzdGVyIn0= - -# Optional Redis settings: - -# Note: these parameters are not automatically passed to the Redis Container -# to do so, please edit the docker-compose.yml file as well. Redis is not configured -# via environment variables, only redis.conf or the command line - -# REDIS_PORT=6379 -# REDIS_DBINDEX=0 -# REDIS_USERNAME= -# REDIS_PASSWORD= -# REDIS_SOCKET= - -################################################################################### -# 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 - - -################################################################################### -# Typesense -################################################################################### -TYPESENSE_API_KEY=some-random-text -# TYPESENSE_ENABLED=false -# TYPESENSE_URL uses base64 encoding for the nodes json. -# Example JSON that was used: -# [ -# { "host": "typesense-1.example.net", "port": "443", "protocol": "https" }, -# { "host": "typesense-2.example.net", "port": "443", "protocol": "https" }, -# { "host": "typesense-3.example.net", "port": "443", "protocol": "https" }, -# ] -# TYPESENSE_URL=ha://WwogIHsgImhvc3QiOiAidHlwZXNlbnNlLTEuZXhhbXBsZS5uZXQiLCAicG9ydCI6ICI0NDMiLCAicHJvdG9jb2wiOiAiaHR0cHMiIH0sCiAgeyAiaG9zdCI6ICJ0eXBlc2Vuc2UtMi5leGFtcGxlLm5ldCIsICJwb3J0IjogIjQ0MyIsICJwcm90b2NvbCI6ICJodHRwcyIgfSwKICB7ICJob3N0IjogInR5cGVzZW5zZS0zLmV4YW1wbGUubmV0IiwgInBvcnQiOiAiNDQzIiwgInByb3RvY29sIjogImh0dHBzIiB9Cl0= - -################################################################################### -# Reverse Geocoding -# -# 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 -# 3 - Cities > 500 population: ~200MB RAM -# 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" -#################################################################################### - -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. -# 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 - -#################################################################################### -# Alternative API's External Address - Optional -# -# This is an advanced feature used to control the public server endpoint returned to clients during Well-known discovery. -# You should only use this if you want mobile apps to access the immich API over a custom URL. Do not include trailing slash. -# NOTE: At this time, the web app will not be affected by this setting and will continue to use the relative path: /api -# Examples: http://localhost:3001, http://immich-api.example.com, etc -#################################################################################### - -#IMMICH_API_URL_EXTERNAL=http://localhost:3001 - -################################################################################### -# Immich Version - Optional -# -# This allows all immich docker images to be pinned to a specific version. By default, -# the version is "release" but could be a specific version, like "v1.59.0". -################################################################################### - -#IMMICH_VERSION=