Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update HTTPS Nginx Documentation with tips - upload size and custom splash #294

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

matthewhand
Copy link
Contributor

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.

- Removed unnecessary `UsageInstructions.md` file.
- Integrated usage instructions ("Applying Changes") directly into `https-nginx.md`.
- Improved clarity by embedding reload commands where configuration changes are discussed.
- Maintained logical flow for additional tips and customization tabs (local and remote splash).
- Simplified user experience by consolidating related content into the main file.
---
Add this directive inside your `server` block, above the `location /` block.

## Customize Splash Screen and Favicon
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's leave a note here for sponsorship here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

something like this?...

### Important Note on Sponsorship and Attribution

While Nginx can be used to rebrand the Open WebUI (e.g., replacing the splash screen or favicon), it’s important to acknowledge that this open-source project relies on the generous support of its sponsors. Rebranding without attribution can undermine the efforts of those funding the project’s ongoing development.

**Recommendation:**  
If rebranding is implemented using the methods described here, please provide some attribution back to the Open WebUI project (e.g., by mentioning the project in your modified version). This ensures fairness and continued support for the open-source community.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants