2022-05-21 09:23:55 +02:00
###################################################################################
2022-02-03 18:06:44 +02:00
# Database
2022-05-21 09:23:55 +02:00
###################################################################################
2022-05-24 15:49:38 +02:00
DB_HOSTNAME = immich_postgres
2022-02-03 22:42:27 +02:00
DB_USERNAME = postgres
DB_PASSWORD = postgres
2022-04-29 20:10:42 +02:00
DB_DATABASE_NAME = immich
2022-02-03 18:06:44 +02:00
2022-07-13 05:21:11 +02:00
# Optional Database settings:
# DB_PORT=5432
2022-05-21 09:23:55 +02:00
2022-05-24 00:23:02 +02:00
###################################################################################
# Redis
###################################################################################
REDIS_HOSTNAME = immich_redis
2023-03-31 22:33:21 +02:00
# 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=
2022-07-13 05:21:11 +02:00
# Optional Redis settings:
2023-03-11 14:41:08 +02:00
# 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
2022-07-13 05:21:11 +02:00
# REDIS_PORT=6379
# REDIS_DBINDEX=0
2023-03-31 22:33:21 +02:00
# REDIS_USERNAME=
2022-07-13 05:21:11 +02:00
# REDIS_PASSWORD=
# REDIS_SOCKET=
2022-05-21 09:23:55 +02:00
###################################################################################
2022-11-21 00:44:33 +02:00
# Upload File Location
#
# This is the location where uploaded files are stored.
2022-05-21 09:23:55 +02:00
###################################################################################
2022-02-12 06:23:06 +02:00
UPLOAD_LOCATION = absolute_location_on_your_machine_where_you_want_to_store_the_backup
2022-02-03 18:06:44 +02:00
2023-03-03 04:47:08 +02:00
###################################################################################
# Typesense
###################################################################################
TYPESENSE_API_KEY = some-random-text
# TYPESENSE_ENABLED=false
2023-04-04 03:16:45 +02:00
# 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://WwogICAgeyAnaG9zdCc6ICd0eXBlc2Vuc2UtMS5leGFtcGxlLm5ldCcsICdwb3J0JzogJzQ0MycsICdwcm90b2NvbCc6ICdodHRwcycgfSwKICAgIHsgJ2hvc3QnOiAndHlwZXNlbnNlLTIuZXhhbXBsZS5uZXQnLCAncG9ydCc6ICc0NDMnLCAncHJvdG9jb2wnOiAnaHR0cHMnIH0sCiAgICB7ICdob3N0JzogJ3R5cGVzZW5zZS0zLmV4YW1wbGUubmV0JywgJ3BvcnQnOiAnNDQzJywgJ3Byb3RvY29sJzogJ2h0dHBzJyB9LApd
2023-03-03 04:47:08 +02:00
2022-05-21 09:23:55 +02:00
###################################################################################
2022-09-23 04:50:05 +02:00
# Reverse Geocoding
2022-11-21 00:44:33 +02:00
#
2022-09-23 04:50:05 +02:00
# 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
2022-11-21 00:44:33 +02:00
####################################################################################
2022-09-23 04:50:05 +02:00
2022-11-21 00:44:33 +02:00
# DISABLE_REVERSE_GEOCODING=false
2022-09-23 04:50:05 +02:00
# REVERSE_GEOCODING_PRECISION=3
2022-05-21 09:23:55 +02:00
2022-07-11 05:31:17 +02:00
####################################################################################
# WEB - Optional
2022-11-21 00:44:33 +02:00
#
2022-07-11 05:31:17 +02:00
# Custom message on the login page, should be written in HTML form.
2022-11-21 00:44:33 +02:00
# For example:
# PUBLIC_LOGIN_PAGE_MESSAGE="This is a demo instance of Immich.<br><br>Email: <i>demo@demo.de</i><br>Password: <i>demo</i>"
####################################################################################
2022-07-11 05:31:17 +02:00
2022-09-12 21:40:18 +02:00
PUBLIC_LOGIN_PAGE_MESSAGE =
2022-11-09 13:11:32 +02:00
####################################################################################
# Alternative Service Addresses - Optional
2022-11-21 00:44:33 +02:00
#
# 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.
2022-11-09 13:11:32 +02:00
# Note: immich-microservices is bound to 3002, but no references are made
2022-11-21 00:44:33 +02:00
####################################################################################
2022-11-09 13:11:32 +02:00
2022-12-23 05:51:47 +02:00
IMMICH_WEB_URL = http://immich-web:3000
IMMICH_SERVER_URL = http://immich-server:3001
IMMICH_MACHINE_LEARNING_URL = http://immich-machine-learning:3003
2023-01-19 17:45:37 +02:00
####################################################################################
# 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
####################################################################################
2023-03-03 04:47:08 +02:00
#IMMICH_API_URL_EXTERNAL=http://localhost:3001