Просмотр исходного кода

unraid guide no longer external (#1074)

Co-authored-by: Matt Farrell <mfarrell@squareup.com>
Matt 2 лет назад
Родитель
Сommit
b8e26a2112

BIN
docs/docs/installation/img/unraid01.webp


BIN
docs/docs/installation/img/unraid02.png


BIN
docs/docs/installation/img/unraid03.png


BIN
docs/docs/installation/img/unraid04.png


BIN
docs/docs/installation/img/unraid05.webp


BIN
docs/docs/installation/img/unraid06.webp


BIN
docs/docs/installation/img/unraid07.webp


BIN
docs/docs/installation/img/unraid08.webp


+ 97 - 5
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**"
+
+<img
+src={require('./img/unraid01.webp').default}
+width="70%"
+alt="Select Plugins > Compose.Manager > Add New Stack > Label it 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
+    <details >
+        <summary>Using an existing Postgres container? Click me! Otherwise proceed to step 5.</summary>
+        <ul>
+            <li>Comment out the database service</li>
+            <img
+                src={require('./img/unraid02.png').default}
+                width="50%"
+                alt="Comment out database service in the compose file"
+            />
+            <li>Comment out the database dependency for <b>each service</b> <i>(example in screenshot below only shows 2 of the services - ensure you do this for all services)</i></li>
+            <img
+                src={require('./img/unraid03.png').default}
+                width="50%"
+                alt="Comment out every reference to the database service in the compose file"
+            />
+            <li>Comment out the volumes</li>
+            <img
+                src={require('./img/unraid04.png').default}
+                width="20%"
+                alt="Comment out database volume"
+            />
+        </ul>
+    </details>
+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`
+
+      <img
+      src={require('./img/unraid05.webp').default}
+      width="70%"
+      alt="Absolute location of where you want immich images stored"
+      />
+
+    <details >
+        <summary>Using an existing Postgres container? Click me! Otherwise proceed to step 8.</summary>
+        <p>Update the following database variables as relevant to your Postgres container:</p>
+        <ul>
+            <li><code>DB_HOSTNAME</code></li>
+            <li><code>DB_USERNAME</code></li>
+            <li><code>DB_PASSWORD</code></li>
+            <li><code>DB_DATABASE_NAME</code></li>
+            <li><code>DB_PORT</code></li>
+        </ul>
+    </details>
+
+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.
+
+<img
+src={require('./img/unraid06.webp').default}
+width="80%"
+alt="Go to Docker Tab and visit the address listed next to immich-proxy"
+/>
+
+<details >
+    <summary>Using the Unraid Docker Folders plugin? Click me! Otherwise you're complete!</summary>
+    <p>If you are using the Docker Folders plugin go the Docker tab and select "<b>New Folder</b>".<br />Label it <i>"Immich"</i> and use the logo from the <a href="https://immich.app/">Immich homepage</a> <i>(right click the logo, "Save As", and reupload to Unraid)</i><br />Then simply select all the Immich related containers before clicking "<b>Submit</b>"</p>
+    <img
+        src={require('./img/unraid07.webp').default}
+        width="80%"
+        alt="Go to Docker Tab and visit the address listed next to immich-proxy"
+    />
+    <img
+        src={require('./img/unraid08.webp').default}
+        width="90%"
+        alt="Go to Docker Tab and visit the address listed next to immich-proxy"
+    />
+    
+</details>
+
 :::tip
-For more information on how to use the application, please refer to the [Post Installation](/docs/usage/post-installation) guide.
-:::
+For more information on how to use the application once installed, please refer to the [Post Installation](/docs/usage/post-installation) guide.
+:::