Skip to content

Commit 7e6a268

Browse files
docs: add PWA installation instructions to README and create dedicated PWA documentation
1 parent a53396e commit 7e6a268

4 files changed

Lines changed: 24 additions & 1 deletion

File tree

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
- docs: update security policy to emphasize network-level protection ([27172cba](https://github.com/teslamate-org/teslamate/commit/27172cba54782f9a8eb7fdd9ea3a481dfd9d8f2b) - @JakobLichterfeld)
3535
- docs: fix typo in DATABASE_SSL_SNI description (#5346 - @dashitongzhi)
3636
- docs: update upgrading instructions to emphasize backup before updating more clearly (#5453 - @JakobLichterfeld)
37+
- docs: add PWA installation instructions to README and create dedicated PWA documentation (#5455 - @JakobLichterfeld)
3738

3839
## [4.0.1] - 2026-06-14
3940

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,10 @@ The documentation is available at [https://docs.teslamate.org](https://docs.tesl
4747
- Import from TeslaFi and tesla-apiscraper
4848
- Customizable theme mode (light, dark, or system default)
4949

50+
### Use as App — Progressive Web App (PWA)
51+
52+
TeslaMate can be installed as a Progressive Web App (PWA) from your self‑hosted instance. Add your instance to your device's home screen and use it like a native app. See the PWA documentation: [Use as App — Progressive Web App (PWA)](website/docs/pwa.md).
53+
5054
### Dashboards
5155

5256
Sample screenshots of bundled dashboards can be seen by clicking the links below.

website/docs/pwa.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: Use as App — Progressive Web App (PWA)
3+
---
4+
5+
## Use as App — Progressive Web App (PWA)
6+
7+
TeslaMate can be installed as a Progressive Web App (PWA) from your own self‑hosted instance. Installing your instance adds it to the home screen and provides an app‑like experience (offline cache, standalone window).
8+
9+
### Requirements
10+
11+
- The TeslaMate URL must be served over HTTPS.
12+
13+
### Install
14+
15+
- Android (Chrome / others): open your TeslaMate URL → browser menu (⋮) → "Add to Home screen" → follow prompts.
16+
- iOS (only use Safari): open your TeslaMate URL → Share → "Add to Home Screen" → confirm.
17+
- Desktop (Chrome / others): open your TeslaMate URL → click the install icon in the address bar or Menu → "Install App".
18+
- For browser‑specific details consult your browser's documentation.

website/sidebars.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ module.exports = {
2121
},
2222
],
2323
},
24-
24+
"pwa",
2525
"faq",
2626
"screenshots",
2727
],

0 commit comments

Comments
 (0)