From caae874f98553667ab4a9926fd0d15576c69e354 Mon Sep 17 00:00:00 2001 From: mmomjian <50788000+mmomjian@users.noreply.github.com> Date: Wed, 1 Jan 2025 16:07:38 -0500 Subject: [PATCH 1/3] discourage docker desktop --- docs/docs/install/requirements.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docs/install/requirements.md b/docs/docs/install/requirements.md index ffb89c5c1331f..fe5da4739b8a0 100644 --- a/docs/docs/install/requirements.md +++ b/docs/docs/install/requirements.md @@ -10,8 +10,8 @@ Hardware and software requirements for Immich: 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). +- **Docker Engine**: This CLI variant is designed for Linux servers (or Windows via WSL2). +- **Docker Desktop**: This GUI variant is **not recommended**, but is available for Windows or macOS (please see OS requirements below). 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/). From 64831423505da81a98748d3f0333d58b5afc4c91 Mon Sep 17 00:00:00 2001 From: mmomjian <50788000+mmomjian@users.noreply.github.com> Date: Wed, 1 Jan 2025 16:19:08 -0500 Subject: [PATCH 2/3] callout *nix OS as supported --- docs/docs/install/requirements.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/install/requirements.md b/docs/docs/install/requirements.md index fe5da4739b8a0..88893089d96e4 100644 --- a/docs/docs/install/requirements.md +++ b/docs/docs/install/requirements.md @@ -21,7 +21,7 @@ Immich requires the command `docker compose`; the similarly named `docker-compos ## 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: From f94b3830ee1310def280e60f2e4008ebb3819c67 Mon Sep 17 00:00:00 2001 From: mmomjian <50788000+mmomjian@users.noreply.github.com> Date: Wed, 1 Jan 2025 16:22:01 -0500 Subject: [PATCH 3/3] change order, clarify mac --- docs/docs/install/requirements.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/docs/install/requirements.md b/docs/docs/install/requirements.md index 88893089d96e4..fd09486dd362b 100644 --- a/docs/docs/install/requirements.md +++ b/docs/docs/install/requirements.md @@ -6,19 +6,6 @@ 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 designed for Linux servers (or Windows via WSL2). -- **Docker Desktop**: This GUI variant is **not recommended**, but is available for Windows or macOS (please see OS requirements below). - -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 or \*nix operating system (Ubuntu, Debian, etc). @@ -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