Переменные окружения
Чтобы изменить переменные окружения, необходимо пересоздать контейнеры Immich. Просто перезапуск контейнеров не заменяет окружение внутри контейнера!
Чтобы пересоздать контейнер с использованием docker compose, выполните команду docker compose up -d.
В большинстве случаев Docker распознает, что файл .env был изменён, и пересоздаст соответствующие контейнеры.
Если это не работает, попробуйте выполнить команду docker compose up -d --force-recreate.
Docker Compose
| Переменная | Описание | Значение по умолчанию | Контейнеры |
|---|---|---|---|
IMMICH_VERSION | Теги образа | release | server, machine learning |
UPLOAD_LOCATION | Путь хоста для загрузок | server | |
DB_DATA_LOCATION | Путь хоста для базы данных Postgres | database |
Эти переменные окружения используются файлом docker-compose.yml и не влияют непосредственно на контейнеры.
Общие
| Переменная | Описание | Значение по умолчанию | Контейнеры | Воркеры |
|---|---|---|---|---|
TZ | Часовой пояс | *1 | server | microservices |
IMMICH_ENV | Окружение (production, development) | production | server, machine learning | api, microservices |
IMMICH_LOG_LEVEL | Уровень логирования (verbose, debug, log, warn, error) | log | server, machine learning | api, microservices |
IMMICH_MEDIA_LOCATION | Путь хранения файлов внутри контейнера ⚠️Скорее всего, не стоит это менять*2⚠️ | /usr/src/app/upload | server | api, microservices |
IMMICH_CONFIG_FILE | Путь к конфигурационному файлу | server | api, microservices | |
NO_COLOR | Установите true, чтобы отключить цветной вывод логов | false | server, machine learning | |
CPU_CORES | Число ядер CPU, доступных серверу Immich | автоматически обнаруживается | server | |
IMMICH_API_METRICS_PORT | Порт для метрик OTEL | 8081 | server | api |
IMMICH_MICROSERVICES_METRICS_PORT | Порт для метрик OTEL | 8082 | server | microservices |
IMMICH_PROCESS_INVALID_IMAGES | Если true, создаёт уменьшенные изображения для недействительных изображений | server | microservices | |
IMMICH_TRUSTED_PROXIES | Список доверенных прокси в формате IP, разделенных запятыми | server | api | |
IMMICH_IGNORE_MOUNT_CHECK_ERRORS | См. Системная целостность | server | api, microservices |
*1: TZ должен быть установлен в идентификатор часового пояса из этого списка. Например, TZ="Etc/UTC".
TZ используется инструментом exiftool в случае, если невозможно определить часовой пояс из метаданных изображения. Также используется для отметок времени в логах и выполнения cron задач.
*2: Этот путь определяет, где код Immich ищет файлы, и используется внутри Docker контейнера. Установка пути на вашем хосте может привести к сбоям. Лучше использовать переменную UPLOAD_LOCATION.
Воркеры
| Переменная | Описание | Значение по умолчанию | Контейнеры |
|---|---|---|---|
IMMICH_WORKERS_INCLUDE | Запуск только указанных воркеров | server | |
IMMICH_WORKERS_EXCLUDE | Не запускать указ анных воркеров. Сравнивается с воркерами по умолчанию или IMMICH_WORKERS_INCLUDE, если они указаны | server |
Информация о текущих воркерах доступна здесь.
Порты
| Переменная | Описание | Значение по умолчанию |
|---|---|---|
IMMICH_HOST | Хост для прослушивания | 0.0.0.0 |
IMMICH_PORT | Порт для прослушивания | 2283 (сервер), 3003 (машинное обучение) |
База данных
| Переменная | Описание | Значение по умолчанию | Контейнеры |
|---|---|---|---|
DB_URL | URL базы данных | сервер | |
DB_HOSTNAME | Хост базы данных | database | сервер |
DB_PORT | Порт базы данных | 5432 | сервер |
DB_USERNAME | Пользователь базы данных | postgres | сервер, database*1 |
DB_PASSWORD | Пароль базы данных | postgres | сервер, database*1 |
DB_DATABASE_NAME | Имя базы данных | immich | сервер, database*1 |
DB_SSL_MODE | SSL-режим для базы данных | сервер | |
DB_VECTOR_EXTENSION*2 | Расширение для базы данных (одно из [vectorchord, pgvector, pgvecto.rs]) | сервер | |
DB_SKIP_MIGRATIONS | Пропускать миграции на этапе запуска (одно из [true, false]) | false | сервер |
DB_STORAGE_TYPE | Оптимизация конкурентного IO на SSD или последовательного IO на HDD ([SSD, HDD]) *3 | SSD | сервер |
*1: Значения DB_USERNAME, DB_PASSWORD, и DB_DATABASE_NAME передаются контейнеру Postgres как переменные POSTGRES_USER, POSTGRES_PASSWORD, и POSTGRES_DB в docker-compose.yml.
*2: Если не указано, соответствующее расширение будет автоматически определено при запуске путём интроспекции базы данных. При установленных нескольких расширениях, порядок предпочтений такой: VectorChord, pgvecto.rs, pgvector.
*3: Используется либо postgresql.ssd.conf, либо postgresql.hdd.conf, что в основном управляет параметром effective_io_concurrency PostgreSQL для поддержки конкурентного IO на SSD и последовательного IO на HDD.
Все переменные DB_ должны быть предоставлены всем воркерам Immich, включая api и microservices.
DB_URL должен быть в формате postgresql://immichdbusername:immichdbpassword@postgreshost:postgresport/immichdatabasename.
Вы можете требовать SSL, добавив ?sslmode=require в конец строки DB_URL, или требовать SSL и пропустить проверку сертификатов, добавив ?sslmode=require&sslmode=no-verify.
Если задан DB_URL, переменные базы данных DB_HOSTNAME, DB_PORT, DB_USERNAME, DB_PASSWORD и DB_DATABASE_NAME игнорируются.
Redis
| Переменная | Описание | Зна чение по умолчанию | Контейнеры |
|---|---|---|---|
REDIS_URL | URL Redis | server | |
REDIS_SOCKET | Сокет Redis | server | |
REDIS_HOSTNAME | Хост Redis | redis | server |
REDIS_PORT | Порт Redis | 6379 | server |
REDIS_USERNAME | Пользователь Redis | server | |
REDIS_PASSWORD | Пароль Redis | server | |
REDIS_DBINDEX | Индекс БД Redis | 0 | server |
Все переменные REDIS_ д олжны быть предоставлены всем воркерам Immich, включая api и microservices.
REDIS_URL должен начинаться с ioredis://, и далее включать JSON-строку в кодировке base64 для конфигурации.
Больше информации можно найти в [документации ioredis].
Когда определены переменные REDIS_URL или REDIS_SOCKET, переменные REDIS_HOSTNAME, REDIS_PORT, REDIS_USERNAME, REDIS_PASSWORD и REDIS_DBINDEX игнорируются.
Пример URL для Redis (Sentinel) в формате JSON до кодирования:
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_MODEL_TTL | Время бездействия (с), после которого модель выгружается (выключено, если <= 0) | 300 | машинное обучение |
MACHINE_LEARNING_MODEL_TTL_POLL_S | Интервал проверки (с) для времени жизни модели (выключено, если <= 0) | 10 | машинное обучение |
MACHINE_LEARNING_CACHE_FOLDER | Директория, куда скачиваются модели | /cache | машинное обучение |
MACHINE_LEARNING_REQUEST_THREADS*1 | Количество потоков в пуле запросов (выключено, если <= 0) | количество ядер процессора | машинное обучение |
MACHINE_LEARNING_MODEL_INTER_OP_THREADS | Количество параллельных операций модели | 1 | машинное обучение |
MACHINE_LEARNING_MODEL_INTRA_OP_THREADS | Количество потоков для каждой операции модели | 2 | машинное обучение |
MACHINE_LEARNING_WORKERS*2 | Количество создаваемых рабочих процессов | 1 | машинное обучение |
MACHINE_LEARNING_HTTP_KEEPALIVE_TIMEOUT_S*3 | Время HTTP Keep-alive в секундах | 2 | машинное обучение |
MACHINE_LEARNING_WORKER_TIMEOUT | Максимальное время (с) отсутствия ответа, после которого рабочий процесс завершается | 120 (300 при использовании OpenVINO) | машинное обучение |
MACHINE_LEARNING_PRELOAD__CLIP__TEXTUAL | Список (текстовых) моделей CLIP для предварительной загрузки и кэширования, разделенный запятыми | машинное обучение | |
MACHINE_LEARNING_PRELOAD__CLIP__VISUAL | Список (визуальных) моделей CLIP для предварительной загрузки и кэширования, разделенный запятыми | машинное обучение | |
MACHINE_LEARNING_PRELOAD__FACIAL_RECOGNITION__RECOGNITION | Список (распознавания) моделей распознавания лиц для предварительной загрузки и кэширования, разделенный запятыми | машинное обучение | |
MACHINE_LEARNING_PRELOAD__FACIAL_RECOGNITION__DETECTION | Список (детекции) моделей распознавания лиц для предварительной загрузки и кэширования, разделенный запятыми | машинное обучение | |
MACHINE_LEARNING_ANN | Включить аппаратное ускорение ARM-NN, если поддерживается | True | машинное обучение |
MACHINE_LEARNING_ANN_FP16_TURBO | Выполнять операции в точности FP16: увеличение скорости, снижение точности (применяется только к ARM-NN) | False | машинное обучение |
MACHINE_LEARNING_ANN_TUNING_LEVEL | Уровень настройки GPU ARM-NN (1: быстро, 2: нормально, 3: тщательно) | 2 | машинное обучение |
MACHINE_LEARNING_DEVICE_IDS*4 | ID устройств для использования в средах с несколькими GPU | 0 | машинное обучение |
MACHINE_LEARNING_MAX_BATCH_SIZE__FACIAL_RECOGNITION | Установить максимальное количество лиц, которые будут обработаны одновременно моделью распознавания | None (1 при использовании OpenVINO) | машинное обучение |
MACHINE_LEARNING_PING_TIMEOUT | Время ожидания (мс) ответа PING при проверке доступности сервера ML | 2000 | сервер |
MACHINE_LEARNING_AVAILABILITY_BACKOFF_TIME | Время игнорирования отключенных серверов ML перед повто рной попыткой | 30000 | сервер |
MACHINE_LEARNING_RKNN | Включить аппаратное ускорение RKNN, если поддерживается | True | машинное обучение |
MACHINE_LEARNING_RKNN_THREADS | Количество потоков RKNN, которые должны быть запущены во время выполнения инференса | 1 | машинное обучение |
*1: Рекомендуется начинать с этого параметра при изменении уровня параллелизма службы машинного обучения, а затем настраивать остальные.
*2: Поскольку каждый процесс дублирует модели в памяти, изменение этого параметра не рекомендуется, если только у вас нет достаточного объема памяти.
*3: Для сценариев, таких как HPA в K8S. https://github.com/immich-app/immich/discussions/12064
*4: Использование нескольких GPU требует установки MACHINE_LEARNING_WORKERS больше 1. Каждое устройство назначается одному рабочему процессу в порядке приоритетов round-robin.
Хотя модель textual является единственной, необходимой для интеллектуального поиска, некоторые пользователи могут столкнуться с медленным первичным поиском
из-за загрузки, инициирующей загрузку других моделей в память, что блокирует другие запросы до завершения.
Чтобы избежать этого, вы можете предварительно загрузить другие модели (visual, recognition и detection), если у вас достаточно оперативной памяти.
Дополнительные параметры машинного обучения можно настроить из пользовательского интерфейса администратора.
Prometheus
| Переменная | Описание | Значение по умолчанию | Контейнеры | Рабочие процессы |
|---|---|---|---|---|
IMMICH_TELEMETRY_INCLUDE | Собирать эти телеметрии. Список host, api, io, repo, job. Примечание: Вы также можете указать all, чтобы включить все | сервер | api, микросервисы | |
IMMICH_TELEMETRY_EXCLUDE | Не собирать эти телеметрии. Список host, api, io, repo, job | сервер | api, микросервисы |
Секреты Docker
Следующие переменные поддерживают использование секретов Docker для повышения безопасности.
Чтобы использовать любую из них, замените обычную переменную окружения на эквивалентную переменную окружения _FILE. Значение переменной _FILE должно быть установлено в путь файла, содержащего значение переменной.
| Обычная переменная | Эквивалентная переменная из секретов Docker '_FILE' |
|---|---|
DB_HOSTNAME | DB_HOSTNAME_FILE*1 |
DB_DATABASE_NAME | DB_DATABASE_NAME_FILE*1 |
DB_USERNAME | DB_USERNAME_FILE*1 |
DB_PASSWORD | DB_PASSWORD_FILE*1 |
DB_URL | DB_URL_FILE*1 |
REDIS_PASSWORD | REDIS_PASSWORD_FILE*2 |
*1: См. официальную документацию для подробностей об использовании секретов Docker в образе Postgres.
*2: См. этот комментарий, чтобы узнать пример использования секрета Docker для пароля в контейнере Redis.