Docker Compose [Recomendado]

Docker Compose é o método recomendado para executar o Immich em produção. Abaixo estão os passos para implantar o Immich com Docker Compose.

Step 1 - Download the required files

Create a directory of your choice (e.g. ./immich-app) to hold the docker-compose.yml and .env files.

Move to the directory you created

mkdir ./immich-app
cd ./immich-app

Download docker-compose.yml and example.env by running the following commands:

Get docker-compose.yml file

wget -O docker-compose.yml https://github.com/immich-app/immich/releases/latest/download/docker-compose.yml

Get .env file

wget -O .env https://github.com/immich-app/immich/releases/latest/download/example.env

You can alternatively download these two files from your browser and move them to the directory that you created, in which case ensure that you rename example.env to .env.

Step 2 - Populate the .env file with custom values

Default environmental variable content

# You can find documentation for all the supported env variables at https://immich.app/docs/install/environment-variables

# The location where your uploaded files are stored
UPLOAD_LOCATION=./library

# The location where your database files are stored. Network shares are not supported for the database
DB_DATA_LOCATION=./postgres

# To set a timezone, uncomment the next line and change Etc/UTC to a TZ identifier from this list: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List
# TZ=Etc/UTC

# The Immich version to use. You can pin this to a specific version like "v1.71.0"
IMMICH_VERSION=release

# Connection secret for postgres. You should change it to a random password
# Please use only the characters `A-Za-z0-9`, without special characters or spaces
DB_PASSWORD=postgres

# The values below this line do not need to be changed
###################################################################################
DB_USERNAME=postgres
DB_DATABASE_NAME=immich

• Populate UPLOAD_LOCATION with your preferred location for storing backup assets. It should be a new directory on the server with enough free space.
• Consider changing DB_PASSWORD to a custom value. Postgres is not publicly exposed, so this password is only used for local authentication. To avoid issues with Docker parsing this value, it is best to use only the characters A-Za-z0-9. pwgen is a handy utility for this.
• Set your timezone by uncommenting the TZ= line.
• Populate custom database information if necessary.

Step 3 - Start the containers

From the directory you created in Step 1 (which should now contain your customized docker-compose.yml and .env files), run the following command to start Immich as a background service:

Start the containers

docker compose up -d

Versão do Docker

Se você receber um erro como unknown shorthand flag: 'd' in -d ou open <local do seu arquivo .env>: permissão negada, você provavelmente está executando a versão errada do Docker. (Isso acontece, por exemplo, com o pacote docker.io no Ubuntu 22.04.3 LTS.) Você pode corrigir o problema seguindo o procedimento completo de instalação do Docker Engine para sua distribuição, crucialmente as seções "Desinstalar versões antigas" e "Instalar usando o repositório apt/rpm". Essas etapas substituem os pacotes do Docker da distribuição pelos pacotes oficiais do Docker.

Note que o comando correto é realmente docker compose, não docker-compose. Se você tentar este último no Ubuntu 22.04 padrão, ocorrerá uma falha de outro tipo:

O arquivo Compose './docker-compose.yml' é inválido porque:
'name' não corresponde a nenhum dos padrões regex: '^x-'

Veja o parágrafo anterior sobre instalar a partir do repositório oficial do Docker.

Intervalo inicial do check de integridade

Se você receber um erro can't set healthcheck.start_interval as feature require Docker Engine v25 or later, ajuda comentar a linha para start_interval na seção database do arquivo docker-compose.yml.

Próximos Passos

Leia os passos Pós Instalação e as instruções de atualização.