diff --git a/docs/VERSIONS.md b/docs/VERSIONS.md new file mode 100755 index 00000000..3811a325 --- /dev/null +++ b/docs/VERSIONS.md @@ -0,0 +1,25 @@ +## Am I running the latest released version? + +Since version 23.01.14 PiAlert uses a simple timestamp-based version check to verify if a new version is available. You can check the [current and past releases here](https://github.com/jokob-sk/Pi.Alert/releases), or have a look at what I'm [currently working on](https://github.com/jokob-sk/Pi.Alert/issues/138). + +If you are not on the latest version, the app will notify you, that a new released version is avialable the following way: + +### 📧 Via email on a notification event + +If any notification occurs and an email is sent, the email will contain a note that a new version is available. See the sample email below: + + + +### 🆕 In the UI + +In the UI via a notification Icon and via a custom message in the Maintenance section. + + + +For a comparison, this is how the UI looks like if you are on the latest stable image: + + + +## Implementation details + +During build a [/home/pi/pialert/front/buildtimestamp.txt](https://github.com/jokob-sk/Pi.Alert/blob/092797e75ccfa8359444ad149e727358ac4da05f/Dockerfile#L44) file is created. The app then periodically checks if a new release is available with a newer timestamp in GitHub's rest-based JSON endpoint (check the `def isNewVersion():` method in `pialert.py` for details). \ No newline at end of file diff --git a/docs/img/VERSIONS/latest-version-maintenance.png b/docs/img/VERSIONS/latest-version-maintenance.png new file mode 100755 index 00000000..a5bcb131 Binary files /dev/null and b/docs/img/VERSIONS/latest-version-maintenance.png differ diff --git a/docs/img/VERSIONS/new-version-available-email.png b/docs/img/VERSIONS/new-version-available-email.png new file mode 100755 index 00000000..e4b2efa9 Binary files /dev/null and b/docs/img/VERSIONS/new-version-available-email.png differ diff --git a/docs/img/VERSIONS/new-version-available-maintenance.png b/docs/img/VERSIONS/new-version-available-maintenance.png new file mode 100755 index 00000000..f965587a Binary files /dev/null and b/docs/img/VERSIONS/new-version-available-maintenance.png differ diff --git a/front/maintenance.php b/front/maintenance.php index fe6f9a9f..7babe5d8 100755 --- a/front/maintenance.php +++ b/front/maintenance.php @@ -131,8 +131,11 @@ if (isset($_POST['submit']) && submit && isset($_POST['skinselector_set'])) {