From 8c46377dfd61370099cbfb14c046ec027f158de7 Mon Sep 17 00:00:00 2001 From: Jamil Bou Kheir Date: Thu, 4 Nov 2021 16:07:02 -0700 Subject: [PATCH] Document upgrading --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c50948cb9..31f39a48f 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,7 @@ * [Configuration File](#configuration-file) * [Using Firezone](#using-firezone) * [Troubleshooting](#troubleshooting) + * [Upgrading](#upgrading) * [Uninstalling](#uninstalling) * [Getting Support](#getting-support) * [Developing and Contributing](#developing-and-contributing) @@ -192,7 +193,7 @@ the changes and apply them to the running system. Your Firezone installation can be managed via the `firezone-ctl` command, as shown below. Most subcommands require prefixing with `sudo`. -```shell +```console root@demo:~# firezone-ctl I don't know that command. omnibus-ctl: command (subcommand) @@ -252,6 +253,20 @@ For any problems that arise, a good first bet is to check the Firezone logs. To view Firezone logs, run `sudo firezone-ctl tail`. +## Upgrading + +Upgrading Firezone will disconnect all VPN connections and require shutting +down the Web UI. We recommend a maintenance window of about an hour in case +anything goes wrong during the upgrade. + +To upgrade Firezone, simply download the new OS package, install it just as you +would for a regular install (`sudo dpkg -i firezone_X.X.X.deb` or +`sudo rpm -i firezone_X.X.X.rpm`), and then restart Firezone services with +`sudo firezone-ctl restart`. + +Occasionally problems arise. If you hit any, please let us know by [filing an +issue](https://github.com/firezone/firezone/issues/new/choose). + ## Uninstalling To completely remove Firezone and its configuration files, run the [uninstall.sh