Skip to content

Commit

Permalink
fix(docs): discourage docker desktop (immich-app#15020)
Browse files Browse the repository at this point in the history
* discourage docker desktop

* callout *nix OS as supported

* change order, clarify mac
  • Loading branch information
mmomjian authored Jan 2, 2025
1 parent fabf878 commit 4d6d553
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions docs/docs/install/requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,9 @@ sidebar_position: 10

Hardware and software requirements for Immich:

## Software

Immich requires [**Docker**](https://docs.docker.com/get-started/get-docker/) with the **Docker Compose plugin**:

- **Docker Engine**: This CLI variant is suitable for Linux servers (or Windows via WSL2).
- **Docker Desktop**: This GUI variant is suitable for Linux desktop (or Windows or macOS).

The Compose plugin will be installed by both Docker Engine and Desktop by following the linked installation guides; it can also be [separately installed](https://docs.docker.com/compose/install/).

:::note
Immich requires the command `docker compose`; the similarly named `docker-compose` is [deprecated](https://docs.docker.com/compose/migrate/) and is no longer supported by Immich.
:::

## Hardware

- **OS**: Recommended Linux operating system (Ubuntu, Debian, etc).
- **OS**: Recommended Linux or \*nix operating system (Ubuntu, Debian, etc).
- Non-Linux OSes tend to provide a poor Docker experience and are strongly discouraged.
Our ability to assist with setup or troubleshooting on non-Linux OSes will be severely reduced.
If you still want to try to use a non-Linux OS, you can set it up as follows:
Expand All @@ -40,6 +27,19 @@ Additionally, if Docker resource limits are used, the Postgres database requires
Windows users may run into issues with non-Unix-compatible filesystems, see below for more details.
:::

## Software

Immich requires [**Docker**](https://docs.docker.com/get-started/get-docker/) with the **Docker Compose plugin**:

- **Docker Engine**: This CLI variant is designed for Linux servers (or Windows via WSL2).
- **Docker Desktop**: This GUI variant is **not recommended** for Linux, but is available for Windows or macOS.

The Compose plugin will be installed by both Docker Engine and Desktop by following the linked installation guides; it can also be [separately installed](https://docs.docker.com/compose/install/).

:::note
Immich requires the command `docker compose`; the similarly named `docker-compose` is [deprecated](https://docs.docker.com/compose/migrate/) and is no longer supported by Immich.
:::

### Special requirements for Windows users

<details>
Expand Down

0 comments on commit 4d6d553

Please sign in to comment.