dsmrreader / dsmr-reader

DSMR-telegram reader & data visualizer for hobbyists. Free for non-commercial use.
https://dsmr-reader.readthedocs.io
Other
461 stars 95 forks source link

Tailscale + HTTPS + DSMR-reader: How to contribute to documentation? #2025

Open eparon opened 2 days ago

eparon commented 2 days ago

Language / Voertaal

🇬🇧 English

Help yourself

Inquiry

Feature or idea

Description

This is not an issue, but more of a question:

At my homelab, I use Tailscale to define my private mesh-VPN. Tailscale can issue for you SSL certificates for your network (tailnet), for which you are provided with a name, e.g. tail-scale.ts.net.

These HTTPS certificates can be used (e.g. https://dsmr-reader.readthedocs.io/en/v5/how-to/installation/https.html) to enable a secure connection with DSMR-reader. However, renewing the Tailscale HTTPS certs is a manual action.

The web server Caddy supports native integration with Tailscale, which allows it to automatically obtain AND renew the HTTPS certs, whenever needed.

I recently experimented on integrating Caddy with DSMR-reader and have documented the required steps. As this was not (fully) trivial, it could be beneficial to add these steps in the projects documentation.

What would be the best way to do this? (If, of course, there is interest for something like that) Make a PR and update the docs by adding a new howto page? Add it in the repo's Discussions and tag it as a how-to guide?

DSMR-reader version

latest

DSMR-reader platform

Native (e.g. manual installation)

Optional: Debug info dump (of DSMR-reader)

No response

Optional: Smart meter telegram

No response

dennissiemensma commented 18 hours ago

Thanks for contributing!

At the moment DSMr-reader will transition into a more slim and Docker-only project, to reduce the support and extensive documentation a bit.

You could opt to host the docs yourself, like these do:

Then I would not mind to link to it in the docs eventually, similar to the ones above. It also allows you to update your own docs yourself.

However do know that if there are any support questions regarding such setup from other users, I will pass through the questions, as I cannot keep in sync with all the stuff used.

Also note that simply creating this issue here will also have Google index it eventually. It's up to you what you like most.