High performance self-hosted photo and video management solution.
TypeScript backup-toolfluttergoogle-photosgoogle-photos-alternativejavascriptmobile-appnestjsnodejsphoto-galleryphotosphotos-managementself-hostedsveltesveltekittypescriptvideos
chore(docs): stronger discouraging of non-Linux installations (#14620)
Matthew Momjian345f918784ca
diff --git a/docs/docs/administration/backup-and-restore.md b/docs/docs/administration/backup-and-restore.mdindex 9ae4e3e51f..1f8d489728 100644--- a/docs/docs/administration/backup-and-restore.md+++ b/docs/docs/administration/backup-and-restore.md@@ -65,12 +65,17 @@ docker compose up -d # Start remainder of Immich appsdocker compose down -v # CAUTION! Deletes all Immich data to start from scratch## Uncomment the next line and replace DB_DATA_LOCATION with your Postgres path to permanently reset the Postgres database# Remove-Item -Recurse -Force DB_DATA_LOCATION # CAUTION! Deletes all Immich data to start from scratch+## You should mount the backup (as a volume, example: - 'C:\path\to\backup\dump.sql':/dump.sql) into the immich_postgres container using the docker-compose.ymldocker compose pull # Update to latest version of Immich (if desired)docker compose create # Create Docker containers for Immich apps without running themdocker start immich_postgres # Start Postgres serversleep 10 # Wait for Postgres server to start up+docker exec -it immich_postgres bash # Enter the Docker shell and run the following command# Check the database user if you deviated from the default-gc "C:\path\to\backup\dump.sql" | docker exec -i immich_postgres psql --username=postgres # Restore Backup+cat "/dump.sql" \+| sed "s/SELECT pg_catalog.set_config('search_path', '', false);/SELECT pg_catalog.set_config('search_path', 'public, pg_catalog', true);/g" \+| psql --username=postgres # Restore Backup+exit # Exit the Docker shelldocker compose up -d # Start remainder of Immich apps```diff --git a/docs/docs/install/requirements.md b/docs/docs/install/requirements.mdindex 74c4a2f831..6dc613389e 100644--- a/docs/docs/install/requirements.md+++ b/docs/docs/install/requirements.md@@ -18,8 +18,11 @@ Immich requires the command `docker compose` - the similarly named `docker-compo## Hardware- **OS**: Recommended Linux operating system (Ubuntu, Debian, etc).- - Windows is supported with [Docker Desktop on Windows](https://docs.docker.com/desktop/install/windows-install/) or [WSL 2](https://docs.docker.com/desktop/wsl/).- - macOS is supported with [Docker Desktop on Mac](https://docs.docker.com/desktop/install/mac-install/).+ - 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:+ - Windows: [Docker Desktop on Windows](https://docs.docker.com/desktop/install/windows-install/) or [WSL 2](https://docs.docker.com/desktop/wsl/).+ - macOS: [Docker Desktop on Mac](https://docs.docker.com/desktop/install/mac-install/).- **RAM**: Minimum 4GB, recommended 6GB.- **CPU**: Minimum 2 cores, recommended 4 cores.- **Storage**: Recommended Unix-compatible filesystem (EXT4, ZFS, APFS, etc.) with support for user/group ownership and permissions.