open-webui/docs
1
0
Fork 0
mirror of https://github.com/open-webui/docs.git synced 2026-07-21 10:05:26 -04:00
Code Issues 37 Packages Projects Releases Wiki Activity

[PR #294] [CLOSED] Update HTTPS Nginx Documentation with tips - upload size and custom splash #384

New Issue
Closed
opened 2026-02-15 17:16:40 -05:00 by yindo · 0 comments
yindo commented 2026-02-15 17:16:40 -05:00
Owner
Copy Link
Copy Source

📋 Pull Request Information

Original PR: https://github.com/open-webui/docs/pull/294
Author: @matthewhand
Created: 11/20/2024
Status: ❌ Closed

Base: main ← Head: feature-custom-splash

📝 Commits (8)

  • 7beb9fa Refactor HTTPS Nginx documentation to streamline usage instructions
  • e87011e Merge branch 'open-webui:main' into main
  • 3345d6c fix: only import tabs once in nginx tutorial
  • 6608ace fix: corrected nginx tab filename
  • 5378bfe Update gh-pages.yml
  • e3a34a3 Update docusaurus.config.ts
  • 540ac3a docs: remove duplicate content in nginx tutorial
  • 6aa8348 Reset .github/workflows/gh-pages.yml and docusaurus.config.ts to match upstream

📊 Changes

5 files changed (+141 additions, -17 deletions)

View changed files

📝 docs/tutorials/integrations/https-nginx.md (+45 -5)
➕ docs/tutorials/integrations/tab-nginx/CustomizeSplashExternal.md (+50 -0)
➕ docs/tutorials/integrations/tab-nginx/CustomizeSplashLocal.md (+35 -0)
📝 docs/tutorials/integrations/tab-nginx/LetsEncrypt.md (+6 -6)
📝 docs/tutorials/integrations/tab-nginx/SelfSigned.md (+5 -6)

📄 Description

This PR refactors the https-nginx.md documentation to streamline usage instructions and improve usability, aligning with the project's contribution guidelines.

Changes:

  1. Integrated Usage Instructions:

    • Consolidated reload instructions under a new "Applying Changes" section in the main documentation.
    • Improved clarity by embedding reload commands where configuration changes are discussed.

  2. Streamlined Splash Screen Customization:

    • Added tabs for local and remote splash screen configurations in the "Customize Splash Screen and Favicon" section.
    • Provided clear steps for both hosting methods, ensuring ease of implementation.

  3. Additional Tips:

    • Added a standalone tip for increasing upload size using client_max_body_size, addressing common user needs.

Why This Change?

  • Aligns with Atomic PR best practices by focusing on a single objective: improving the clarity and usability of the HTTPS Nginx documentation.
  • Enhances user experience by consolidating related content into a single cohesive document.
  • Maintains logical flow and simplicity, reducing cognitive load for readers.

Related Discussions/Issues:

  • N/A (No prior discussion was opened for this minor refactor; please advise if one should be started retroactively.)

Checklist:

  • Updates adhere to the existing project style and conventions.
  • Documentation reflects changes and includes clear, actionable steps.
  • No external dependencies were added.

🔄 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/docs/pull/294 **Author:** [@matthewhand](https://github.com/matthewhand) **Created:** 11/20/2024 **Status:** ❌ Closed **Base:** `main` ← **Head:** `feature-custom-splash` --- ### 📝 Commits (8) - [`7beb9fa`](https://github.com/open-webui/docs/commit/7beb9fa071c54811f3bc6b8e9d07eb391117f46b) Refactor HTTPS Nginx documentation to streamline usage instructions - [`e87011e`](https://github.com/open-webui/docs/commit/e87011e2ab4dc0745f77bb60af4d334ef3dbf178) Merge branch 'open-webui:main' into main - [`3345d6c`](https://github.com/open-webui/docs/commit/3345d6ce5ae29528aa08ab0050689cb3f020bc24) fix: only import tabs once in nginx tutorial - [`6608ace`](https://github.com/open-webui/docs/commit/6608ace36bbeab4e0c42ced4b3e4f680ab7e6d76) fix: corrected nginx tab filename - [`5378bfe`](https://github.com/open-webui/docs/commit/5378bfe7ab10094416d14068e9f70674991e6d6f) Update gh-pages.yml - [`e3a34a3`](https://github.com/open-webui/docs/commit/e3a34a35016018a3eeb9c0c84a5389975ef825ce) Update docusaurus.config.ts - [`540ac3a`](https://github.com/open-webui/docs/commit/540ac3a0fa79e77a01a37018b0caf2371076898b) docs: remove duplicate content in nginx tutorial - [`6aa8348`](https://github.com/open-webui/docs/commit/6aa8348afc288a8069d560aec80019286e491c41) Reset .github/workflows/gh-pages.yml and docusaurus.config.ts to match upstream ### 📊 Changes **5 files changed** (+141 additions, -17 deletions) <details> <summary>View changed files</summary> 📝 `docs/tutorials/integrations/https-nginx.md` (+45 -5) ➕ `docs/tutorials/integrations/tab-nginx/CustomizeSplashExternal.md` (+50 -0) ➕ `docs/tutorials/integrations/tab-nginx/CustomizeSplashLocal.md` (+35 -0) 📝 `docs/tutorials/integrations/tab-nginx/LetsEncrypt.md` (+6 -6) 📝 `docs/tutorials/integrations/tab-nginx/SelfSigned.md` (+5 -6) </details> ### 📄 Description This PR refactors the `https-nginx.md` documentation to streamline usage instructions and improve usability, aligning with the project's contribution guidelines. #### Changes: 1. **Integrated Usage Instructions:** - Consolidated reload instructions under a new "Applying Changes" section in the main documentation. - Improved clarity by embedding reload commands where configuration changes are discussed. 2. **Streamlined Splash Screen Customization:** - Added tabs for local and remote splash screen configurations in the "Customize Splash Screen and Favicon" section. - Provided clear steps for both hosting methods, ensuring ease of implementation. 3. **Additional Tips:** - Added a standalone tip for increasing upload size using `client_max_body_size`, addressing common user needs. #### Why This Change? - Aligns with **Atomic PR** best practices by focusing on a single objective: improving the clarity and usability of the HTTPS Nginx documentation. - Enhances user experience by consolidating related content into a single cohesive document. - Maintains logical flow and simplicity, reducing cognitive load for readers. #### Related Discussions/Issues: - N/A (No prior discussion was opened for this minor refactor; please advise if one should be started retroactively.) #### Checklist: - [x] Updates adhere to the existing project style and conventions. - [x] Documentation reflects changes and includes clear, actionable steps. - [x] No external dependencies were added. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
yindo added the pull-request label 2026-02-15 17:16:40 -05:00
yindo closed this issue 2026-02-15 17:16:40 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
documentation
documentation
duplicate
enhancement
enhancement
good first issue
good first issue
good first issue
help wanted
pull-request
Mirrored from GitHub Pull Request
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
yindo
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: open-webui/docs#384
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?