From dedd3bbdc8952912468e210b047a742b7fe5191a Mon Sep 17 00:00:00 2001 From: Charlie Egan Date: Wed, 12 Jun 2024 13:56:13 +0100 Subject: [PATCH] Add docs Signed-off-by: Charlie Egan --- docs/remote-features.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 docs/remote-features.md diff --git a/docs/remote-features.md b/docs/remote-features.md new file mode 100644 index 00000000..6f293bde --- /dev/null +++ b/docs/remote-features.md @@ -0,0 +1,27 @@ +# Remote Features + +This page outlines the features of Regal that need internet access to function. + +## Checking for Updates + +Regal will check for updates on startup. If a new version is available, +Regal will notify you by writing a message in stderr. + +An example of such a message is: + +``` +A new version of Regal is available (v0.23.1). You are running v0.23.0. +See https://github.com/StyraInc/regal/releases/tag/v0.23.1 for the latest release. +``` + +This message is based on the local version set in the Regal binary, and **no +user data is sent** to GitHub where the releases are hosted. + +This same function will also write to the file at: `$HOME/.config/regal/latest_version.json`, +this is used as a cache of the latest version to avoid consuming excessive +GitHub API rate limits when using Regal. + +This functionality can be disabled in two ways: + +* Using `.regal/config.yaml`: set `features.remote.check-version` to `false`. +* Using an environment variable: set `REGAL_DISABLE_CHECK_VERSION` to `true`.