Skip to content

Commit

Permalink
Updated update checks docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesread committed Jun 4, 2024
1 parent 8d35da5 commit 68ed633
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion updateChecks.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,27 @@
[#update-checks]

=== Update Checks

NOTE: This page is for OliveTin versions **2024.06.02** and afterwards. Previous versions of OliveTin used to have a form of tracking. To learn about how that worked, see <<update-tracking,update-tracking>>.

OliveTin has the ability to check for updates, which is now turned OFF if nothing is specified in your configuration file. To enable this feature, set the following in your `config.yaml` file;

[source,yaml]
.`config.yaml`
----
checkForUpdates: true
----

By enabling this feature, OliveTin will;

* Do a HTTP GET in plaintext (not HTTPS) to http://update-check.olivetin.app/versions.json and download the contents of that file. While the server will see your IP address in it's webserver logs, this information isn't actively used, and the OliveTin project has no intention of actively parsing the logs to use that.
* Once OliveTin has that json file, it will compare the "latestVersion" attribute against the version it is running.
* If there is a later version, it is displayed in the page OliveTin footer.

[#update-tracking]
=== Update Checks (and tracking)
=== Update Checks & Tracking (legacy)

NOTE: This page is for OliveTin versions **2022-01-06** to **2024.06.02**. To see the current behavior of update checking, go to <<update-checks,update-checks>>

The OliveTin server will now check for updates on startup, and every 7 days after that. It will report those updates as a log message in the console. It does not apply any updates, because this is the choice and responsibility of whoever is running OliveTin to decide if, when, and how to apply any updates.

Expand Down

0 comments on commit 68ed633

Please sign in to comment.