Skip to content

Conversation

@JakobLichterfeld
Copy link
Member

  • Added a dropdown for reproducibility confirmation.
  • Improved descriptions and labels for clarity.
  • Updated installation options with links and support notes.
  • Included reverse proxy details for better issue context.

…elds and guidance

- Added a dropdown for reproducibility confirmation.
- Improved descriptions and labels for clarity.
- Updated installation options with links and support notes.
- Included reverse proxy details for better issue context.
@JakobLichterfeld JakobLichterfeld self-assigned this Jul 16, 2025
@netlify
Copy link

netlify bot commented Jul 16, 2025

Deploy Preview for teslamate ready!

Name Link
🔨 Latest commit 35e869c
🔍 Latest deploy log https://app.netlify.com/projects/teslamate/deploys/68776a53a557be0008196c2f
😎 Deploy Preview https://deploy-preview-4827--teslamate.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 project configuration.

@JakobLichterfeld JakobLichterfeld added the enhancement New feature or request label Jul 16, 2025
@JakobLichterfeld JakobLichterfeld requested a review from swiffer July 16, 2025 08:16
@swiffer
Copy link
Collaborator

swiffer commented Jul 16, 2025

the docs currently don't clearly say manual is unsupported (only not recommended) - we might add this if it's the case?

while at it - may align the first paragraph of nixos and docker install in the docs?

@JakobLichterfeld
Copy link
Member Author

JakobLichterfeld commented Jul 16, 2025

we might add this if it's the case?

Yeah, currently only saying in the bug reports, it's on my list for the docs

while at it - may align the first paragraph of nixos and docker install in the docs?

Can you elaborate a bit more on this?

@swiffer
Copy link
Collaborator

swiffer commented Jul 16, 2025

Docker:

You run NixOS? We got you covered, see NixOS install. For a walkthrough that provides the necessary steps for manual installation see Manual installation.

If you intend to expose TeslaMate directly to the internet check out the advanced guides.

NixOS:

-> no mention of docker

If you intend to expose TeslaMate directly to the internet use a secure connection such as a VPN, Cloudflare Tunnel, Tailscale, Zero Tier and a reverse proxy like Caddy.


I would suggest removing info to manual install steps from the docker guide.


Using VPN, Cloudflare Tunnel, Tailscale, Zero Tier is an alternative to exposing TeslaMate directly to the internet.

So i would rephrase for both NixOS and Docker:

If you intend to access TeslaMate from the Internet, either use a reverse proxy (such as Traefik, Apache or Caddy) or use a secure connection (such as VPN, Tailscale, Zero Tier or Cloudflare Tunnel) for secured access.

whereas the docker Guide could link to the advanced guides for Traefik and Apache while the NixOS guide could like to the NixOS wiki.

Guides could then be renamed to Hardening/Securing your Setup and the Fleet Api Docs can be moved to Advanced Configuration instead.

Sorry for hijacking this PR - this could all be addressed seperately.

@JakobLichterfeld
Copy link
Member Author

JakobLichterfeld commented Jul 16, 2025

Sorry for hijacking this PR - this could all be addressed seperately.

:-) All good.

I would suggest removing info to manual install steps from the docker guide.

Agree, thing is, the docker install is the starting page of the docs, therefore the phrase about the different options.

either use a reverse proxy (such as Traefik, Apache or Caddy) or use a secure connection (such as VPN, Tailscale, Zero Tier or Cloudflare Tunnel) for secured access.

A reverse proxy does not provide any kind of security on its own.

I discussed how to phrase it with Brian in this PR: #4768

I will open a new PR for the Doc stuff --> #4829

@JakobLichterfeld JakobLichterfeld merged commit 290cccc into main Jul 16, 2025
24 checks passed
@JakobLichterfeld JakobLichterfeld deleted the issue-template branch July 16, 2025 14:35
@JakobLichterfeld
Copy link
Member Author

Damm, liniting was successful, but GitHub is a bit picky here:
image

@JakobLichterfeld
Copy link
Member Author

solved via e8288e9

@JakobLichterfeld JakobLichterfeld added this to the v2.1.0 milestone Jul 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants