diff --git a/docs/docs/installation/img/unraid01.webp b/docs/docs/installation/img/unraid01.webp new file mode 100644 index 0000000000000..52013bef4c817 Binary files /dev/null and b/docs/docs/installation/img/unraid01.webp differ diff --git a/docs/docs/installation/img/unraid02.png b/docs/docs/installation/img/unraid02.png new file mode 100644 index 0000000000000..32e76fd25168d Binary files /dev/null and b/docs/docs/installation/img/unraid02.png differ diff --git a/docs/docs/installation/img/unraid03.png b/docs/docs/installation/img/unraid03.png new file mode 100644 index 0000000000000..795a503db1975 Binary files /dev/null and b/docs/docs/installation/img/unraid03.png differ diff --git a/docs/docs/installation/img/unraid04.png b/docs/docs/installation/img/unraid04.png new file mode 100644 index 0000000000000..a32c5b26f2b1e Binary files /dev/null and b/docs/docs/installation/img/unraid04.png differ diff --git a/docs/docs/installation/img/unraid05.webp b/docs/docs/installation/img/unraid05.webp new file mode 100644 index 0000000000000..2df2f7852f8e7 Binary files /dev/null and b/docs/docs/installation/img/unraid05.webp differ diff --git a/docs/docs/installation/img/unraid06.webp b/docs/docs/installation/img/unraid06.webp new file mode 100644 index 0000000000000..97f42defecfcf Binary files /dev/null and b/docs/docs/installation/img/unraid06.webp differ diff --git a/docs/docs/installation/img/unraid07.webp b/docs/docs/installation/img/unraid07.webp new file mode 100644 index 0000000000000..1aaf755d13594 Binary files /dev/null and b/docs/docs/installation/img/unraid07.webp differ diff --git a/docs/docs/installation/img/unraid08.webp b/docs/docs/installation/img/unraid08.webp new file mode 100644 index 0000000000000..5a22e0b1d5866 Binary files /dev/null and b/docs/docs/installation/img/unraid08.webp differ diff --git a/docs/docs/installation/unraid-installation.md b/docs/docs/installation/unraid-installation.md index 0087b1437ef3f..685632198c87f 100644 --- a/docs/docs/installation/unraid-installation.md +++ b/docs/docs/installation/unraid-installation.md @@ -4,12 +4,104 @@ sidebar_position: 5 # Unraid -Install Immich on Unraid. +Install Immich on Unraid using the [Docker Compose Manager](https://forums.unraid.net/topic/114415-plugin-docker-compose-manager/) plugin from the Unraid Community Apps. + +:::info + +- Guide was written using Unraid v6.11.1 +- Requires you to have installed the plugin: [Docker Compose Manager](https://forums.unraid.net/topic/114415-plugin-docker-compose-manager/) +- An Unraid share created for your images +- There has been a [report](https://forums.unraid.net/topic/130006-errortraps-traps-node27707-trap-invalid-opcode-ip14fcfc8d03c0-sp7fff32889dd8-more/#comment-1189395) of this not working if your Unraid server doesn't support AVX _(e.g. using a T610)_ -:::info Community contribution -Please follow [this community contributed article](https://mfaz.dev/posts/immich-unraid/) to install Immich on Unraid. ::: +1. Go to "**Plugins**" and click on "**Compose.Manager**" +2. Click "**Add New Stack**" and when prompted for a label enter "**Immich**" + + + +3. Select the cog ⚙️ next to Immich then click "**Edit Stack**" +4. Click "**Compose File**" and then paste the entire contents of the [Immich Docker Compose](https://raw.githubusercontent.com/immich-app/immich/main/docker/docker-compose.yml) file into the Unraid editor +
+ Using an existing Postgres container? Click me! Otherwise proceed to step 5. + +
+5. Click "**Save Changes**", you will be promoted to edit stack UI labels, just leave this blank and click "**Ok**" +6. Select the cog ⚙️ next to Immich, click "**Edit Stack**", then click "**Env File**" +7. Past the entire contents of the [Immich .env.example](https://raw.githubusercontent.com/immich-app/immich/main/docker/.env.example) file into the Unraid editor, then **before saving** edit the following: + + - `JWT_SECRET`: Generate a unique secret and paste the value here > Can be generated by either typing `openssl rand -base64 128` in your terminal or copying from [uuidgenerator](https://www.uuidgenerator.net/version1) + - `UPLOAD_LOCATION`: Create a folder in your Images Unraid share and place the **absolute** location here > For example my _"images"_ share has a folder within it called _"immich"_. If I browse to this directory in the terminal and type `pwd` the output is `/mnt/user/images/immich`. This is the exact value I need to enter as my `UPLOAD_LOCATION` + + Absolute location of where you want immich images stored + +
+ Using an existing Postgres container? Click me! Otherwise proceed to step 8. +

Update the following database variables as relevant to your Postgres container:

+ +
+ +8. Click "**Save Changes**" followed by "**Compose Up**" and Unraid will begin to create the Immich containers in a popup window. Once complete you will see a message on the popup window stating _"Connection Closed"_. Click "**Done**" and go to the Unraid "**Docker**" page + + > Note: This can take several minutes depending on your Internet speed and Unraid hardware + +9. Once on the Docker page you will see several Immich containers, one of them will be labelled `immich_proxy` and will have a port mapping. Visit the `IP:PORT` displayed in your web browser and you should see the Immich admin setup page. + + + +
+ Using the Unraid Docker Folders plugin? Click me! Otherwise you're complete! +

If you are using the Docker Folders plugin go the Docker tab and select "New Folder".
Label it "Immich" and use the logo from the Immich homepage (right click the logo, "Save As", and reupload to Unraid)
Then simply select all the Immich related containers before clicking "Submit"

+ Go to Docker Tab and visit the address listed next to immich-proxy + Go to Docker Tab and visit the address listed next to immich-proxy + +
+ :::tip -For more information on how to use the application, please refer to the [Post Installation](/docs/usage/post-installation) guide. -::: \ No newline at end of file +For more information on how to use the application once installed, please refer to the [Post Installation](/docs/usage/post-installation) guide. +:::