Skip to content

Commit fafb49f

Browse files
committed
docs: move Unraid guide to tutorials/integrations
1 parent fcae985 commit fafb49f

File tree

4 files changed

+15
-16
lines changed

4 files changed

+15
-16
lines changed

docs/getting-started/index.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,6 @@ Get up and running quickly with our [Quick Start Guide](/getting-started/quick-s
1616

1717
---
1818

19-
## 🧰 Unraid Guide
20-
21-
Running on Unraid? Use our beginner-safe [Open WebUI on Unraid](/getting-started/unraid) guide for Docker template setup, persistent volumes, upgrades, and reverse-proxy troubleshooting.
22-
23-
---
24-
2519
## 🛠️ Advanced Topics
2620

2721
Take a deeper dive into configurations and development tips in our [Advanced Topics Guide](/getting-started/advanced-topics).

docs/getting-started/quick-start/index.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,6 @@ Choose your preferred installation method below:
4141
- **Python:** Suitable for low-resource environments or those wanting a manual setup
4242
- **Kubernetes:** Ideal for enterprise deployments that require scaling and orchestration
4343

44-
Using Unraid? See the dedicated [Open WebUI on Unraid (Beginner-Safe)](/getting-started/unraid) guide.
45-
4644
<Tabs>
4745
<TabItem value="docker" label="Docker">
4846
<Tabs>

docs/troubleshooting/connection-error.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,6 @@ The `CORS_ALLOW_ORIGIN` setting is crucial for WebSocket functionality. If you s
7070
### Reverse Proxy / SSL/TLS Configuration
7171

7272
For reverse proxy and TLS setups, check our [tutorials here](/reference/https).
73-
If you are running Unraid, use the [Open WebUI on Unraid (Beginner-Safe)](/getting-started/unraid) deployment and troubleshooting guide.
7473

7574
### WebSocket Troubleshooting
7675

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
---
2-
sidebar_position: 3
3-
title: "Unraid (Beginner-Safe)"
2+
sidebar_position: 34
3+
title: "Unraid Deployment (Beginner-Safe)"
44
---
55

6+
:::warning
7+
8+
This tutorial is a community contribution and is not supported by the Open WebUI team. It serves only as a demonstration on how to customize Open WebUI for your specific use case. Want to contribute? Check out the [contributing tutorial](/tutorials/tips/contributing-tutorial).
9+
10+
:::
11+
612
# Open WebUI on Unraid (Beginner-Safe)
713

814
This guide is for first-time Unraid users who want a stable Docker deployment with persistent data and safe upgrades.
@@ -73,23 +79,25 @@ Choose one setup.
7379
1. Start the container.
7480
2. Open `http://<unraid-ip>:3000`.
7581
3. Complete initial admin setup.
76-
4. Open **Admin Settings > Connections > Ollama** and verify the endpoint.
82+
4. Open **Settings > Admin Settings > Connections** and verify the Ollama endpoint.
7783
5. Confirm models appear in the model selector.
7884

7985
## 4. Persistent Volume Notes
8086

8187
- Open WebUI state is stored in `/app/backend/data`.
88+
- Set a fixed `WEBUI_SECRET_KEY` in your Unraid template and keep it the same across recreates to avoid unnecessary session invalidation.
8289
- Keep host mapping consistent across updates/recreates.
8390
- Use a directory mapping, not a file mapping.
8491
- If persistence fails, check folder permissions for `/mnt/user/appdata/open-webui`.
8592

8693
## 5. Upgrade Steps (Safe Workflow)
8794

8895
1. Back up `/mnt/user/appdata/open-webui`.
89-
2. Update/pull your Open WebUI image tag.
90-
3. Recreate using the same template and same `/app/backend/data` mapping.
91-
4. Verify chats/settings are intact.
92-
5. If needed, roll back to the previous image and restore backup.
96+
2. Ensure your template keeps the same `WEBUI_SECRET_KEY`.
97+
3. Update/pull your Open WebUI image tag.
98+
4. Recreate using the same template and the same `/app/backend/data` mapping.
99+
5. Verify chats/settings are intact.
100+
6. If needed, roll back to the previous image and restore backup.
93101

94102
For broader update options, see [Updating Open WebUI](/getting-started/updating).
95103

0 commit comments

Comments
 (0)