[PR #22209] [CLOSED] docs: add beginner-safe Unraid setup and troubleshooting guide #26551

Closed
opened 2026-04-20 06:34:07 -05:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/22209
Author: @idanzairi302
Created: 3/4/2026
Status: Closed

Base: devHead: codex/unraid-docs-beginner-safe


📝 Commits (10+)

📊 Changes

4 files changed (+168 additions, -0 deletions)

View changed files

📝 README.md (+4 -0)
📝 TROUBLESHOOTING.md (+21 -0)
📝 docs/README.md (+7 -0)
docs/unraid-beginner-safe.md (+136 -0)

📄 Description

Pull Request Checklist

  • Target branch: This pull request targets the dev branch.
  • Description: A concise description of the changes is included below.
  • Changelog: A changelog entry (Keep a Changelog format) is included below.
  • Documentation: Follow-up docs sync to the external docs repository can be done if maintainers want this mirrored there.
  • Dependencies: No new or upgraded dependencies.
  • Testing: Manual validation and command output are included below.
  • Agentic AI Code: This PR was AI-assisted and manually reviewed before submission.
  • Code review: Self-review completed for changed files.
  • Design & Architecture: No architecture or runtime behavior changes (docs-only update).
  • Git Hygiene: PR is atomic and scoped to one logical docs change.
  • Title Prefix: Uses docs: prefix.

Changelog Entry

Description

  • Add a beginner-safe Unraid deployment guide and link it from existing install/troubleshooting docs surfaces.

Added

  • New documentation page: docs/unraid-beginner-safe.md
  • Unraid-specific troubleshooting coverage for Ollama connectivity, host.docker.internal, reverse-proxy subpath behavior, and persistent-volume pitfalls.

Changed

  • Updated README.md with direct links to the new Unraid guide.
  • Updated docs/README.md with a documentation index entry for the new page.
  • Expanded TROUBLESHOOTING.md with reverse proxy and persistent volume checks.

Deprecated

  • None.

Removed

  • None.

Fixed

  • Documentation gap for beginner-safe Unraid setup and common reverse-proxy/persistence troubleshooting.

Security

  • No security behavior changes; documentation-only.

Breaking Changes

  • BREAKING CHANGE: None.

Additional Information

  • This is a docs-only PR with no runtime code changes.
  • Changed files:
    • README.md
    • TROUBLESHOOTING.md
    • docs/README.md
    • docs/unraid-beginner-safe.md

Testing

I personally tested this PR's changes.

How tested:

  • npx prettier --check README.md TROUBLESHOOTING.md docs/README.md docs/unraid-beginner-safe.md passed.
  • npm run test:frontend passed (no test files found, exit 0).
  • npm run build passed.
  • npm run check currently fails in this branch due pre-existing upstream type-check errors unrelated to this docs-only change.

Screenshots or Videos

  • Not applicable (docs-only; no UI behavior changes).

Contributor License Agreement

By submitting this pull request, I confirm that I have read and fully agree to the Contributor License Agreement (CLA), and I am providing my contributions under its terms.


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/open-webui/open-webui/pull/22209 **Author:** [@idanzairi302](https://github.com/idanzairi302) **Created:** 3/4/2026 **Status:** ❌ Closed **Base:** `dev` ← **Head:** `codex/unraid-docs-beginner-safe` --- ### 📝 Commits (10+) - [`fe6783c`](https://github.com/open-webui/open-webui/commit/fe6783c16699911c7be17392596d579333fb110c) Merge pull request #19030 from open-webui/dev - [`fc05e0a`](https://github.com/open-webui/open-webui/commit/fc05e0a6c5d39da60b603b4d520f800d6e36f748) Merge pull request #19405 from open-webui/dev - [`e3faec6`](https://github.com/open-webui/open-webui/commit/e3faec62c58e3a83d89aa3df539feacefa125e0c) Merge pull request #19416 from open-webui/dev - [`9899293`](https://github.com/open-webui/open-webui/commit/9899293f050ad50ae12024cbebee7e018acd851e) Merge pull request #19448 from open-webui/dev - [`140605e`](https://github.com/open-webui/open-webui/commit/140605e660b8186a7d5c79fb3be6ffb147a2f498) Merge pull request #19462 from open-webui/dev - [`6f1486f`](https://github.com/open-webui/open-webui/commit/6f1486ffd0cb288d0e21f41845361924e0d742b3) Merge pull request #19466 from open-webui/dev - [`d95f533`](https://github.com/open-webui/open-webui/commit/d95f533214e3fe5beb5e41ec1f349940bc4c7043) Merge pull request #19729 from open-webui/dev - [`a727153`](https://github.com/open-webui/open-webui/commit/a7271532f8a38da46785afcaa7e65f9a45e7d753) 0.6.43 (#20093) - [`6adde20`](https://github.com/open-webui/open-webui/commit/6adde203cd292a9e3af9c64a2ae36b603fed096a) Merge pull request #20394 from open-webui/dev - [`f9b0534`](https://github.com/open-webui/open-webui/commit/f9b0534e0c442631d1cb7205169588b9b6204179) Merge pull request #20522 from open-webui/dev ### 📊 Changes **4 files changed** (+168 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+4 -0) 📝 `TROUBLESHOOTING.md` (+21 -0) 📝 `docs/README.md` (+7 -0) ➕ `docs/unraid-beginner-safe.md` (+136 -0) </details> ### 📄 Description # Pull Request Checklist - [x] **Target branch:** This pull request targets the `dev` branch. - [x] **Description:** A concise description of the changes is included below. - [x] **Changelog:** A changelog entry (Keep a Changelog format) is included below. - [ ] **Documentation:** Follow-up docs sync to the external docs repository can be done if maintainers want this mirrored there. - [x] **Dependencies:** No new or upgraded dependencies. - [x] **Testing:** Manual validation and command output are included below. - [x] **Agentic AI Code:** This PR was AI-assisted and manually reviewed before submission. - [x] **Code review:** Self-review completed for changed files. - [x] **Design & Architecture:** No architecture or runtime behavior changes (docs-only update). - [x] **Git Hygiene:** PR is atomic and scoped to one logical docs change. - [x] **Title Prefix:** Uses `docs:` prefix. # Changelog Entry ### Description - Add a beginner-safe Unraid deployment guide and link it from existing install/troubleshooting docs surfaces. ### Added - New documentation page: `docs/unraid-beginner-safe.md` - Unraid-specific troubleshooting coverage for Ollama connectivity, `host.docker.internal`, reverse-proxy subpath behavior, and persistent-volume pitfalls. ### Changed - Updated `README.md` with direct links to the new Unraid guide. - Updated `docs/README.md` with a documentation index entry for the new page. - Expanded `TROUBLESHOOTING.md` with reverse proxy and persistent volume checks. ### Deprecated - None. ### Removed - None. ### Fixed - Documentation gap for beginner-safe Unraid setup and common reverse-proxy/persistence troubleshooting. ### Security - No security behavior changes; documentation-only. ### Breaking Changes - **BREAKING CHANGE**: None. --- ### Additional Information - This is a docs-only PR with no runtime code changes. - Changed files: - `README.md` - `TROUBLESHOOTING.md` - `docs/README.md` - `docs/unraid-beginner-safe.md` ### Testing ✅ I personally tested this PR's changes. How tested: - `npx prettier --check README.md TROUBLESHOOTING.md docs/README.md docs/unraid-beginner-safe.md` passed. - `npm run test:frontend` passed (no test files found, exit 0). - `npm run build` passed. - `npm run check` currently fails in this branch due pre-existing upstream type-check errors unrelated to this docs-only change. ### Screenshots or Videos - Not applicable (docs-only; no UI behavior changes). ### Contributor License Agreement By submitting this pull request, I confirm that I have read and fully agree to the [Contributor License Agreement (CLA)](https://github.com/open-webui/open-webui/blob/main/CONTRIBUTOR_LICENSE_AGREEMENT), and I am providing my contributions under its terms. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-04-20 06:34:07 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/open-webui#26551