diff --git a/README.md b/README.md index c63628b99..d9814b413 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@

- firezone logo + firezone logo

- + firezone @@ -11,19 +11,17 @@ firezone Slack - - firezone - - - firezone + firezone + firezone + + follow on Twitter

FireZone is a simple [WireGuard](https://www.wireguard.com/) based VPN server and firewall for Linux designed to be secure, easy to manage, and quick to set up. -![Architecture](./apps/fz_http/assets/static/images/firezone-architecture-diagram-1.png) - +![Architecture](https://user-images.githubusercontent.com/167144/134593363-870c982d-921b-4f0c-b210-e77c8860d9ca.png) # What is Firezone? @@ -31,17 +29,42 @@ Firezone can be set up in minutes to manage your WireGuard VPN through a simple ## Features -- **Simple to setup and use:** -- **Based on WireGuard:** -- **Firewall built in:** Block egress traffic from your devices to specific IPs and CIDR ranges -- **Sandboxed (no dependencies):** Firezone leverages [Chef Omnibus](https://github.com/chef/omnibus) -- **Secure:** The Firezone Web UI runs as an unpriveleged user. +- **Fast:** [3-4 times](https://wireguard.com/performance/) faster than OpenVPN. +- **Firewall built in:** Uses [nftables](https://netfilter.org) to block + unwanted egress traffic. +- **No dependencies:** All dependencies are bundled thanks to + [Chef Omnibus](https://github.com/chef/omnibus). +- **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** | +| macOS | Unsupported at this time | +| Windows | Unsupported at this time | + +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. @@ -50,7 +73,7 @@ Firezone can be set up in minutes to manage your WireGuard VPN through a simple 6. Finally, create an admin user with `sudo firezone-ctl create_admin`. Check the console for the login credentials. 7. Now you should be able to log into the web UI at `https://` -# Using Firezone VPN +# Using Firezone Your FireZone installation can be managed via the `firezone-ctl` command, as shown below. Most subcommands require prefixing with `sudo`. @@ -104,19 +127,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 diff --git a/apps/fz_http/assets/static/images/firezone-architecture-diagram-1.png b/apps/fz_http/assets/static/images/firezone-architecture-diagram-1.png deleted file mode 100644 index 27464847b..000000000 Binary files a/apps/fz_http/assets/static/images/firezone-architecture-diagram-1.png and /dev/null differ diff --git a/apps/fz_http/assets/static/images/logo-text.png b/apps/fz_http/assets/static/images/logo-text.png deleted file mode 100644 index 08a99f769..000000000 Binary files a/apps/fz_http/assets/static/images/logo-text.png and /dev/null differ