diff --git a/docs/docs/FAQ.mdx b/docs/docs/FAQ.mdx index 21e620335..e9aaedfd1 100644 --- a/docs/docs/FAQ.mdx +++ b/docs/docs/FAQ.mdx @@ -1,5 +1,7 @@ # FAQ +import ComposeBuilder from '/docs/partials/_compose-builder.mdx'; + ## Commercial Guidelines ### Are you open to commercial partnerships and collaborations? @@ -411,6 +413,8 @@ You can change the user in the container by setting the `user` argument in `dock [Example docker-compose.rootless.yml file](https://github.com/immich-app/immich/blob/main/docker/docker-compose.rootless.yml) + + You may need to add mount points or docker volumes for the following internal container paths: - `redis:/data` diff --git a/docs/docs/administration/postgres-standalone.md b/docs/docs/administration/postgres-standalone.md index fa108995c..e65a2c4b9 100644 --- a/docs/docs/administration/postgres-standalone.md +++ b/docs/docs/administration/postgres-standalone.md @@ -1,5 +1,7 @@ # Pre-existing Postgres +import ComposeBuilder from '/docs/partials/_compose-builder.mdx'; + While not officially recommended, it is possible to run Immich using a pre-existing Postgres server. To use this setup, you should have a baseline level of familiarity with Postgres and the Linux command line. If you do not have these, we recommend using the default setup with a dedicated Postgres container. By default, Immich expects superuser permission on the Postgres database and requires certain extensions to be installed. This guide outlines the steps required to prepare a pre-existing Postgres server to be used by Immich. @@ -27,6 +29,8 @@ The current accepted range for VectorChord is `>= 0.3, < 2.0`. ## Specifying the connection URL + + You can connect to your pre-existing Postgres server by setting the `DB_URL` environment variable in the `.env` file. ``` diff --git a/docs/docs/features/hardware-transcoding.md b/docs/docs/features/hardware-transcoding.md index e68f6f698..1143cd404 100644 --- a/docs/docs/features/hardware-transcoding.md +++ b/docs/docs/features/hardware-transcoding.md @@ -1,5 +1,7 @@ # Hardware Transcoding +import ComposeBuilder from '/docs/partials/_compose-builder.mdx'; + This feature allows you to use a GPU to accelerate transcoding and reduce CPU load. Note that hardware transcoding produces significantly larger videos than software transcoding with similar settings, typically with lower quality. Using slow presets and preferring more efficient codecs can narrow this gap. As this is a new feature, it is still experimental and may not work on all systems. @@ -57,6 +59,8 @@ For RKMPP to work: ## Setup + + #### Basic Setup 1. If you do not already have it, download the latest [`hwaccel.transcoding.yml`][hw-file] file and ensure it's in the same folder as the `docker-compose.yml`. diff --git a/docs/docs/features/libraries.md b/docs/docs/features/libraries.md index 62831ab08..cdbfa53e0 100644 --- a/docs/docs/features/libraries.md +++ b/docs/docs/features/libraries.md @@ -1,5 +1,7 @@ # External Libraries +import ComposeBuilder from '/docs/partials/_compose-builder.mdx'; + :::info Currently an external library can only belong to a single user which is selected when the library is initially created. ::: @@ -98,6 +100,8 @@ First, we need to plan how we want to organize the libraries. The christmas trip ### Mount Docker Volumes + + The `immich-server` container will need access to the gallery. Modify your docker compose file as follows ```diff title="docker-compose.yml" diff --git a/docs/docs/features/ml-hardware-acceleration.md b/docs/docs/features/ml-hardware-acceleration.md index 5ad0bcd11..efcc98030 100644 --- a/docs/docs/features/ml-hardware-acceleration.md +++ b/docs/docs/features/ml-hardware-acceleration.md @@ -1,5 +1,7 @@ # Hardware-Accelerated Machine Learning +import ComposeBuilder from '/docs/partials/_compose-builder.mdx'; + This feature allows you to use a GPU to accelerate machine learning tasks, such as Smart Search and Facial Recognition, while reducing CPU load. As this is a new feature, it is still experimental and may not work on all systems. @@ -87,6 +89,8 @@ You do not need to redo any machine learning jobs after enabling hardware accele ## Setup + + 1. If you do not already have it, download the latest [`hwaccel.ml.yml`][hw-file] file and ensure it's in the same folder as the `docker-compose.yml`. 2. In `immich-machine-learning`, add one of -[armnn, cuda, rocm, openvino, rknn] to the `image` section's tag at the end of the line. 3. Still in the `docker-compose.yml` under `immich-machine-learning`, uncomment the `extends` section and change `cpu` to the appropriate backend. diff --git a/docs/docs/guides/custom-locations.md b/docs/docs/guides/custom-locations.md index e0274d3bd..312f8a9d5 100644 --- a/docs/docs/guides/custom-locations.md +++ b/docs/docs/guides/custom-locations.md @@ -1,7 +1,11 @@ # Files Custom Locations +import ComposeBuilder from '/docs/partials/_compose-builder.mdx'; + This guide explains how to store generated and raw files with docker's volume mount in different locations. + + :::caution Backup It is important to remember to update the backup settings after following the guide to back up the new backup paths if using automatic backup tools, especially `profile/`. ::: diff --git a/docs/docs/guides/external-library.md b/docs/docs/guides/external-library.md index a1c809273..4953bed4c 100644 --- a/docs/docs/guides/external-library.md +++ b/docs/docs/guides/external-library.md @@ -1,11 +1,15 @@ # External Library +import ComposeBuilder from '/docs/partials/_compose-builder.mdx'; + This guide walks you through adding an [External Library](/features/libraries). This guide assumes you are running Immich in Docker and that the files you wish to access are stored in a directory on the same machine. # Mount the directory into the containers. + + Edit `docker-compose.yml` to add one or more new mount points in the section `immich-server:` under `volumes:`. If you want Immich to be able to delete the images in the external library or add metadata ([XMP sidecars](/features/xmp-sidecars)), remove `:ro` from the end of the mount point. diff --git a/docs/docs/guides/remote-machine-learning.md b/docs/docs/guides/remote-machine-learning.md index 1f3ea0912..0f8639f3d 100644 --- a/docs/docs/guides/remote-machine-learning.md +++ b/docs/docs/guides/remote-machine-learning.md @@ -1,5 +1,7 @@ # Remote Machine Learning +import ComposeBuilder from '/docs/partials/_compose-builder.mdx'; + To alleviate [performance issues on low-memory systems](/FAQ.mdx#why-is-immich-slow-on-low-memory-systems-like-the-raspberry-pi) like the Raspberry Pi, you may also host Immich's machine learning container on a more powerful system, such as your laptop or desktop computer. The server container will send requests containing the image preview to the remote machine learning container for processing. The machine learning container does not persist this data or associate it with a particular user. :::info @@ -53,6 +55,8 @@ Version mismatches between both hosts may cause bugs and instability, so remembe Adding a new URL to the settings is recommended over replacing the existing URL (http://immich-machine-learning:3003). This is because it will allow machine learning tasks to be processed successfully when the remote server is down by falling back to the local machine learning container. If you do not want machine learning tasks to be processed locally when the remote server is not available, you can instead replace the existing URL and only provide the remote container's URL. If doing this, you can remove the `immich-machine-learning` section of the local `docker-compose.yml` file to save resources, as this service will never be used. + + Do note that this will mean that Smart Search and Face Detection jobs will fail to be processed when the remote instance is not available. This in turn means that tasks dependent on these features—Duplicate Detection and Facial Recognition—will not run for affected assets. If this occurs, you must manually click the _Missing_ button next to Smart Search and Face Detection in the [Job Status](http://my.immich.app/admin/queues) page for the jobs to be retried. ## Load balancing diff --git a/docs/docs/install/docker-compose.mdx b/docs/docs/install/docker-compose.mdx index 46b144eb4..703a2f213 100644 --- a/docs/docs/install/docker-compose.mdx +++ b/docs/docs/install/docker-compose.mdx @@ -6,8 +6,11 @@ sidebar_position: 30 Docker Compose is the recommended method to run Immich in production. Below are the steps to deploy Immich with Docker Compose. +import ComposeBuilder from '/docs/partials/_compose-builder.mdx'; import DockerComposeSteps from '/docs/partials/_docker-compose-install-steps.mdx'; + + :::info Docker version diff --git a/docs/docs/partials/_compose-builder.mdx b/docs/docs/partials/_compose-builder.mdx new file mode 100644 index 000000000..5a1927a29 --- /dev/null +++ b/docs/docs/partials/_compose-builder.mdx @@ -0,0 +1,3 @@ +:::tip Docker Compose Builder +You can also use the Docker Compose Builder instead. +:::