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

Reorganize and update reverse proxy documentation #2456

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

Conversation

bens95
Copy link

@bens95 bens95 commented Feb 9, 2025

This is the beginning of my attempts to improve/modernize reverse proxy documentation. The reverse proxy docs are very verbose, and did not include information for apache configs. I split them up in this manner for two reasons:

  1. The existing docs are very verbose and would be a lot to throw at someone at once
  2. Nobody who is reading docs for one proxy really needs to read another

I also question whether some of the content in these docs belongs on an OpenHAB wiki at all. While the documentation is good, it is overly detailed. Things like purchasing a domain, letsencrypt cert generation, webserver installation, etc are better documented on their own wikis/elsewhere. If I were starting from scratch, these pages would be one article with:

  • prerequisites (a domain, a cert, knowledge of your chosen webserver)
  • mention of common best practices (auth, https)
  • OpenHAB specific settings (with syntax from each webserver)
  • sample configs

However I would feel bad removing all of the work that has already been done. Thoughts?

Ben Stern added 2 commits February 9, 2025 12:14
Create succinct Apache2 reverse proxy settings
Placed everything "security" section.
Fixed headings so the toc looks better
Copy link

netlify bot commented Feb 9, 2025

Thanks for your pull request to the openHAB documentation! The result can be previewed at the URL below (this comment and the preview will be updated if you add more commits).

Built without sensitive environment variables

Name Link
🔨 Latest commit 5cf0e3e
🔍 Latest deploy log https://app.netlify.com/sites/openhab-docs-preview/deploys/67a911314b2a0f00081e653e
😎 Deploy Preview https://deploy-preview-2456--openhab-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

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.

1 participant