Skip to main content

Environment Variables

caution

To change environment variables, you must recreate the Immich containers. Just restarting the containers does not replace the environment within the container!

In order to recreate the container using docker compose, run docker compose up -d. In most cases docker will recognize that the .env file has changed and recreate the affected containers. If this should not work, try running docker compose up -d --force-recreate.

Docker Compose​

VariableDescriptionDefaultServices
IMMICH_VERSIONImage tagsreleaseserver, microservices, machine learning
UPLOAD_LOCATIONHost Path for uploadsserver, microservices
DB_DATA_LOCATIONHost Path for Postgres databasedatabase
tip

These environment variables are used by the docker-compose.yml file and do NOT affect the containers directly.

Supported filesystems​

The Immich Postgres database (DB_DATA_LOCATION) must be located on a filesystem that supports user/group ownership and permissions (EXT2/3/4, ZFS, APFS, BTRFS, XFS, etc.). It will not work on any filesystem formatted in NTFS or ex/FAT/32. It will not work in WSL (Windows Subsystem for Linux) when using a mounted host directory (commonly under /mnt). If this is an issue, you can change the bind mount to a Docker volume instead.

Regardless of filesystem, it is not recommended to use a network share for your database location due to performance and possible data loss issues.

General​

VariableDescriptionDefaultServices
TZTimezonemicroservices
NODE_ENVEnvironment (production, development)productionserver, microservices, machine learning
LOG_LEVELLog Level (verbose, debug, log, warn, error)logserver, microservices, machine learning
IMMICH_MEDIA_LOCATIONMedia Location./upload*1server, microservices
IMMICH_CONFIG_FILEPath to config fileserver, microservices
IMMICH_WEB_ROOTPath of root index.html/usr/src/app/wwwserver
IMMICH_REVERSE_GEOCODING_ROOTPath of reverse geocoding dump directory/usr/src/resourcesmicroservices

*1: With the default WORKDIR of /usr/src/app, this path will resolve to /usr/src/app/upload. It only need to be set if the Immich deployment method is changing.

tip

TZ should be set to a TZ identifier from this list. For example, TZ="Etc/UTC".

TZ is only used by exiftool, which is present in the microservices container, as a fallback in case the timezone cannot be determined from the image metadata.

Ports​

VariableDescriptionDefaultServices
HOSTHost0.0.0.0server, microservices
SERVER_PORTServer Port3001server
MICROSERVICES_PORTMicroservices Port3002microservices
MACHINE_LEARNING_HOSTMachine Learning Host0.0.0.0machine learning
MACHINE_LEARNING_PORTMachine Learning Port3003machine learning

Database​

VariableDescriptionDefaultServices
DB_URLDatabase URLserver, microservices
DB_HOSTNAMEDatabase Hostdatabaseserver, microservices
DB_PORTDatabase Port5432server, microservices
DB_USERNAMEDatabase Userpostgresserver, microservices, database*1
DB_PASSWORDDatabase Passwordpostgresserver, microservices, database*1
DB_DATABASE_NAMEDatabase Nameimmichserver, microservices, database*1
DB_VECTOR_EXTENSION*2Database Vector Extension (one of [pgvector, pgvecto.rs])pgvecto.rsserver, microservices
DB_SKIP_MIGRATIONSWhether to skip running migrations on startup (one of [true, false])falseserver, microservices

*1: The values of DB_USERNAME, DB_PASSWORD, and DB_DATABASE_NAME are passed to the Postgres container as the variables POSTGRES_USER, POSTGRES_PASSWORD, and POSTGRES_DB in docker-compose.yml.

*2: This setting cannot be changed after the server has successfully started up.

info

When DB_URL is defined, the DB_HOSTNAME, DB_PORT, DB_USERNAME, DB_PASSWORD and DB_DATABASE_NAME database variables are ignored.

Redis​

VariableDescriptionDefaultServices
REDIS_URLRedis URLserver, microservices
REDIS_HOSTNAMERedis Hostredisserver, microservices
REDIS_PORTRedis Port6379server, microservices
REDIS_DBINDEXRedis DB Index0server, microservices
REDIS_USERNAMERedis Usernameserver, microservices
REDIS_PASSWORDRedis Passwordserver, microservices
REDIS_SOCKETRedis Socketserver, microservices
info

REDIS_URL must start with ioredis:// and then include a base64 encoded JSON string for the configuration. More info can be found in the upstream ioredis documentation.

  • When REDIS_URL is defined, the other redis (REDIS_*) variables are ignored.
  • When REDIS_SOCKET is defined, the other redis (REDIS_*) variables are ignored.

Redis (Sentinel) URL example JSON before encoding:

JSON
{
  "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"
}

Machine Learning​

VariableDescriptionDefaultServices
MACHINE_LEARNING_MODEL_TTLInactivity time (s) before a model is unloaded (disabled if <= 0)300machine learning
MACHINE_LEARNING_MODEL_TTL_POLL_SInterval (s) between checks for the model TTL (disabled if <= 0)10machine learning
MACHINE_LEARNING_CACHE_FOLDERDirectory where models are downloaded/cachemachine learning
MACHINE_LEARNING_REQUEST_THREADS*1Thread count of the request thread pool (disabled if <= 0)number of CPU coresmachine learning
MACHINE_LEARNING_MODEL_INTER_OP_THREADSNumber of parallel model operations1machine learning
MACHINE_LEARNING_MODEL_INTRA_OP_THREADSNumber of threads for each model operation2machine learning
MACHINE_LEARNING_WORKERS*2Number of worker processes to spawn1machine learning
MACHINE_LEARNING_WORKER_TIMEOUTMaximum time (s) of unresponsiveness before a worker is killed120machine learning
MACHINE_LEARNING_PRELOAD__CLIPName of a CLIP model to be preloaded and kept in cachemachine learning
MACHINE_LEARNING_PRELOAD__FACIAL_RECOGNITIONName of a facial recognition model to be preloaded and kept in cachemachine learning

*1: It is recommended to begin with this parameter when changing the concurrency levels of the machine learning service and then tune the other ones.

*2: Since each process duplicates models in memory, changing this is not recommended unless you have abundant memory to go around.

info

Other machine learning parameters can be tuned from the admin UI.

Prometheus​

VariableDescriptionDefaultServices
IMMICH_METRICS*1Toggle all metrics (one of [true, false])server, microservices
IMMICH_API_METRICSToggle metrics for endpoints and response times (one of [true, false])server, microservices
IMMICH_HOST_METRICSToggle metrics for CPU and memory utilization for host and process (one of [true, false])server, microservices
IMMICH_IO_METRICSToggle metrics for database queries, image processing, etc. (one of [true, false])server, microservices
IMMICH_JOB_METRICSToggle metrics for jobs and queues (one of [true, false])server, microservices

*1: Overridden for a metric group when its corresponding environmental variable is set.

Docker Secrets​

The following variables support the use of Docker secrets for additional security.

To use any of these, replace the regular environment variable with the equivalent _FILE environment variable. The value of the _FILE variable should be set to the path of a file containing the variable value.

Regular VariableEquivalent Docker Secrets '_FILE' Variable
DB_HOSTNAMEDB_HOSTNAME_FILE*1
DB_DATABASE_NAMEDB_DATABASE_NAME_FILE*1
DB_USERNAMEDB_USERNAME_FILE*1
DB_PASSWORDDB_PASSWORD_FILE*1
DB_URLDB_URL_FILE*1
REDIS_PASSWORDREDIS_PASSWORD_FILE*2

*1: See the official documentation for details on how to use Docker Secrets in the Postgres image.

*2: See this comment for an example of how to use use a Docker secret for the password in the Redis container.