diff --git a/README.md b/README.md index 4c263b0da..8248bcff1 100644 --- a/README.md +++ b/README.md @@ -34,12 +34,35 @@ Firezone can be set up in minutes to manage your WireGuard VPN through a simple unwanted egress traffic. - **No dependencies:** All dependencies are bundled thanks to [Chef Omnibus](https://github.com/chef/omnibus). -- **Secure:** Runs unprivileged. HTTPS required. Encrypted cookies. +- **Secure:** Runs unprivileged. HTTPS enforced. Encrypted cookies. ![Firezone](./apps/fz_http/assets/static/images/firezone-usage.gif) # Deploying and Configuring +## Requirements + +FireZone currently supports the following operating systems: + +| Name | Status | +| --- | --- | +| CentOS 7 | Fully-supported | +| CentOS 8 | Fully-supported | +| Ubuntu 18.04 | Fully-supported | +| Ubuntu 20.04 | Fully-supported | +| Debian 10 | Fully-supported | +| Debian 11 | Fully-supported | +| Fedora 33 | Fully-supported | +| Fedora 34 | Fully-supported | + +If your distro isn't listed here please [open an issue](https://github.com/firezone/firezone/issues/new/choose) and we'll look into adding it. + +FireZone requires a valid SSL certificate and a matching DNS record to run in +production. We recommend using [Let's Encrypt](https://letsencrypt.org) to +generate a free SSL cert for your domain. + +## Installation Instructions + 1. Download the relevant package for your distribution from the [releases page](https://github.com/firezone/firezone/releases) 2. Install with `sudo rpm -i firezone-.rpm` or `sudo dpkg -i firezone-.deb` depending on your distribution. This will unpack the application and set up necessary directory structure. 3. Bootstrap the application with `sudo firezone-ctl reconfigure`. This will initialize config files, set up needed services and generate the default configuration. @@ -102,19 +125,6 @@ Service Management Commands: Send the services a USR2. ``` -## Requirements - -FireZone currently supports the following Linux distros: - -- CentOS: `7`, `8` -- Ubuntu: `18.04`, `20.04` -- Debian: `10`, `11` -- Fedora: `33`, `34` - -If your distro isn't listed here please [open an issue](https://github.com/firezone/firezone/issues/new/choose) and we'll look into adding it. - -FireZone requires a valid SSL certificate and a matching DNS record to run in production. - # Architecture FireZone is written in the Elixir programming language and composed as an [Umbrella