diff --git a/README.md b/README.md index 457c54c1d..cf4d8b255 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,7 @@ versions: * [Configuration File](#configuration-file) * [Using Firezone](#using-firezone) * [Troubleshooting](#troubleshooting) + * [Upgrading](#upgrading) * [Uninstalling](#uninstalling) * [Getting Support](#getting-support) * [Developing and Contributing](#developing-and-contributing) @@ -200,7 +201,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) @@ -260,6 +261,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