[PR #257] [MERGED] Feature: HTTPS Integration with Nginx #347

Closed
opened 2026-02-15 17:16:30 -05:00 by yindo · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/open-webui/docs/pull/257
Author: @matthewhand
Created: 10/30/2024
Status: Merged
Merged: 10/30/2024
Merged by: @tjbck

Base: mainHead: feature-nginx-clean


📝 Commits (1)

📊 Changes

5 files changed (+223 additions, -55 deletions)

View changed files

.github/workflows/gh-pages.yml (+0 -55)
docs/tutorials/integrations/https-nginx.md (+40 -0)
docs/tutorials/integrations/tab-nginx/LetsEncrypt.md (+108 -0)
docs/tutorials/integrations/tab-nginx/SelfSigned.md (+74 -0)
📝 docusaurus.config.ts (+1 -0)

📄 Description

This PR introduces new documentation and configuration updates for setting up HTTPS with Nginx in Open WebUI. The goal is to improve security by guiding users through both self-signed and Let's Encrypt certificate setups, as well as updating the project configuration with a refined exclude rule.

Changes:

  1. New Documentation Files:

    • docs/tutorials/integrations/https-nginx.md:

      • Overview of using Nginx as a reverse proxy for HTTPS.
      • Includes tabs for self-signed certificates and Let's Encrypt configurations.
    • docs/tutorials/integrations/tab-nginx/SelfSigned.md:

      • Steps for generating and configuring self-signed certificates.
      • Focused on development and internal use.
    • docs/tutorials/integrations/tab-nginx/LetsEncrypt.md:

      • Instructions for setting up Let's Encrypt for production environments.
      • Includes configuration tips for automated certificate renewal.
  2. Configuration Update:

    • docusaurus.config.ts:
      • Added exclude: ['**/tab-**/**'] to improve documentation filtering.
      • Ensured correct indentation for consistency with the project style.

Why This Contribution Matters:

  • Security: Provides users with clear guidance to enable HTTPS, enhancing security and trust.
  • Flexibility: Offers both self-signed and trusted certificate options.

Testing & Review:

  • Verified Nginx configurations for both self-signed and Let's Encrypt setups.
  • Ensured proper documentation rendering in the development environment.

Next Steps:

  • Review and confirm the documentation accuracy.
  • Ensure the configuration update aligns with project requirements.

This PR follows the contribution guidelines by:

  1. Adhering to existing code and documentation structure.
  2. Avoiding external dependencies.
  3. Providing a clear and concise description of the changes.

🔄 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/257 **Author:** [@matthewhand](https://github.com/matthewhand) **Created:** 10/30/2024 **Status:** ✅ Merged **Merged:** 10/30/2024 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `main` ← **Head:** `feature-nginx-clean` --- ### 📝 Commits (1) - [`2b5fe0d`](https://github.com/open-webui/docs/commit/2b5fe0d0fe6da269c29f44d3273419c6e33e4831) Clean ### 📊 Changes **5 files changed** (+223 additions, -55 deletions) <details> <summary>View changed files</summary> ➖ `.github/workflows/gh-pages.yml` (+0 -55) ➕ `docs/tutorials/integrations/https-nginx.md` (+40 -0) ➕ `docs/tutorials/integrations/tab-nginx/LetsEncrypt.md` (+108 -0) ➕ `docs/tutorials/integrations/tab-nginx/SelfSigned.md` (+74 -0) 📝 `docusaurus.config.ts` (+1 -0) </details> ### 📄 Description This PR introduces new documentation and configuration updates for setting up **HTTPS with Nginx** in Open WebUI. The goal is to improve security by guiding users through both self-signed and Let's Encrypt certificate setups, as well as updating the project configuration with a refined `exclude` rule. ### **Changes:** 1. **New Documentation Files**: - **`docs/tutorials/integrations/https-nginx.md`**: - Overview of using Nginx as a reverse proxy for HTTPS. - Includes tabs for self-signed certificates and Let's Encrypt configurations. - **`docs/tutorials/integrations/tab-nginx/SelfSigned.md`**: - Steps for generating and configuring self-signed certificates. - Focused on development and internal use. - **`docs/tutorials/integrations/tab-nginx/LetsEncrypt.md`**: - Instructions for setting up Let's Encrypt for production environments. - Includes configuration tips for automated certificate renewal. 2. **Configuration Update**: - **`docusaurus.config.ts`**: - Added `exclude: ['**/tab-**/**']` to improve documentation filtering. - Ensured correct indentation for consistency with the project style. ### **Why This Contribution Matters**: - **Security**: Provides users with clear guidance to enable HTTPS, enhancing security and trust. - **Flexibility**: Offers both self-signed and trusted certificate options. ### **Testing & Review**: - Verified Nginx configurations for both self-signed and Let's Encrypt setups. - Ensured proper documentation rendering in the development environment. ### **Next Steps**: - [ ] Review and confirm the documentation accuracy. - [ ] Ensure the configuration update aligns with project requirements. --- This PR follows the **contribution guidelines** by: 1. Adhering to existing code and documentation structure. 2. Avoiding external dependencies. 3. Providing a clear and concise description of the changes. --- <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:30 -05:00
yindo closed this issue 2026-02-15 17:16:30 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: open-webui/docs#347