From 4d6d5537b713ca80bb2a670fdc7be66882b12d5c Mon Sep 17 00:00:00 2001 From: Matthew Momjian <50788000+mmomjian@users.noreply.github.com> Date: Wed, 1 Jan 2025 19:58:53 -0500 Subject: [PATCH] fix(docs): discourage docker desktop (#15020) * discourage docker desktop * callout *nix OS as supported * change order, clarify mac --- docs/docs/install/requirements.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/docs/install/requirements.md b/docs/docs/install/requirements.md index ffb89c5c1331f..fd09486dd362b 100644 --- a/docs/docs/install/requirements.md +++ b/docs/docs/install/requirements.md @@ -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: @@ -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