Merge pull request #250 from firezone/launch-readme-changes

Launch readme changes

README.md

@@ -1,45 +1,69 @@
-![](./apps/fz_http/assets/static/images/logo.svg)
+<p align="center">
+  <img src="https://user-images.githubusercontent.com/167144/134594125-fadeac64-990e-4d6f-9e69-8a04487e00e0.png" alt="firezone logo" width="500"/>
+</p>
+<p align="center">
+  <a href="https://github.com/firezone">
+    <img src="https://img.shields.io/badge/firezone-beta v0.0.5-red" alt="firezone" />
+  </a>
+  <a href="https://e04kusl9oz5.typeform.com/to/zahKLf3d">
+    <img src="https://img.shields.io/static/v1?logo=openbugbounty&logoColor=959DA5&label=feedback&labelColor=333a41&message=submit&color=3AC358" alt="firezone Slack" />
+  </a>
+  <a href="https://e04kusl9oz5.typeform.com/to/rpMtkZw4">
+    <img src="https://img.shields.io/static/v1?logo=slack&logoColor=959DA5&label=community&labelColor=333a41&message=join&color=611f69" alt="firezone Slack" />
+  </a>
+  <img src="https://img.shields.io/static/v1?logo=github&logoColor=959DA5&label=Test&labelColor=333a41&message=passing&color=3AC358" alt="firezone" />
+  <img src="https://img.shields.io/static/v1?label=coverage&labelColor=333a41&message=66%&color=D7614A" alt="firezone" />
+  <a href="https://twitter.com/intent/follow?screen_name=firezonevpn">
+    <img src="https://img.shields.io/twitter/follow/firezonevpn?style=social&logo=twitter" alt="follow on Twitter">
+  </a>
+</p>
 
-![Test](https://github.com/firezone/firezone/workflows/Test/badge.svg)
-[![Coverage Status](https://coveralls.io/repos/github/firezone/firezone/badge.svg?branch=master)](https://coveralls.io/github/FireZone-LLC/firezone?branch=master)
 
-# FireZone
+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.
 
-1. [Intro](#intro)
-2. [Requirements](#requirements)
-3. [Install](#install)
-4. [Usage](#usage)
-5. [Architecture](#architecture)
-6. [Contributing](#contributing)
+![Architecture](https://user-images.githubusercontent.com/167144/134593363-870c982d-921b-4f0c-b210-e77c8860d9ca.png)
 
-![IMG_0023](https://user-images.githubusercontent.com/167144/132162016-c17635ae-a715-41ca-b6f9-7cbdf202f8d5.png)
+# What is Firezone?
 
-## Intro
+Firezone can be set up in minutes to manage your WireGuard VPN through a simple web interface.
 
-FireZone is an open-source WireGuard-based VPN server and firewall for Linux
-designed to be secure, easy to manage, and quick to set up.
+## Features
 
-Use FireZone to:
+- **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.
 
-- Connect remote teams to a shared private cloud network
-- Set up your own WireGuard VPN
-- Block egress traffic from your devices to specific IPs and CIDR ranges
-- Connect remote teams to a secure virtual LAN
+![Firezone](./apps/fz_http/assets/static/images/firezone-usage.gif)
+
+# Deploying and Configuring
 
 ## Requirements
 
-FireZone currently supports the following Linux distros:
+FireZone currently supports the following operating systems:
 
-- CentOS: `7`, `8`
-- Ubuntu: `18.04`, `20.04`
-- Debian: `10`, `11`
-- Fedora: `33`, `34`
+| 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.
+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.
 
-## Install
+## 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-<version>.rpm` or `sudo dpkg -i firezone-<version>.deb` depending on your distribution. This will unpack the application and set up necessary directory structure.
@@ -49,7 +73,7 @@ FireZone requires a valid SSL certificate and a matching DNS record to run in pr
 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://<your-server-fqdn>`
 
-## Usage
+# Using Firezone
 
 Your FireZone installation can be managed via the `firezone-ctl` command, as shown below. Most subcommands require prefixing with `sudo`.
 
@@ -103,7 +127,7 @@ Service Management Commands:
     Send the services a USR2.
 ```
 
-## Architecture
+# Architecture
 
 FireZone is written in the Elixir programming language and composed as an [Umbrella
 project](https://elixir-lang.org/getting-started/mix-otp/dependencies-and-umbrella-projects.html)
@@ -111,14 +135,21 @@ consisting of three independent applications:
 
 - [apps/fz_http](apps/fz_http): The Web Application
 - [apps/fz_wall](apps/fz_wall): Firewall Management Process
-- [apps/fz_vpn](apps/fz_vpn): WireGuard Management Process
+- [apps/fz_vpn](apps/fz_vpn): WireGuard™ Management Process
 
 For now, FireZone assumes these apps are all running on the same host.
 
 [Chef Omnibus](https://github.com/chef/omnibus) is used to bundle all FireZone dependencies into a single distributable Linux package.
 
-## Contributing
+# Getting Support
+For help, feedback or contributions please join our [Slack group](https://admin.typeform.com/form/rpMtkZw4/create?block=a9c11a46-1dcf-4155-b447-0d8ce5700d5f). We're actively working to improve Firezone, and the Slack group is the best way to coordinate our efforts.
 
-See [CONTRIBUTING.md](CONTRIBUTING.md).
 
-WireGuard is a registered trademark of Jason A. Donenfeld.
+## Developing and Contributing
+
+- See [CONTRIBUTING.md](CONTRIBUTING.md).
+- Report issues and bugs in [this Github project]().
+
+## License
+
+WireGuard™ is a registered trademark of Jason A. Donenfeld.

apps/fz_http/assets/static/images/logo-text.svg

@@ -0,0 +1,6 @@
+<svg width="400" height="110" viewBox="0 0 400 110" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path fill-rule="evenodd" clip-rule="evenodd" d="M78.2375 14C98.1001 30.5434 77.5376 67.2083 84.7938 82.0126C69.8826 60.6161 90.1985 42.2283 78.2375 14Z" fill="#CF5C00"/>
+<path fill-rule="evenodd" clip-rule="evenodd" d="M89.2523 45.8429C102.235 54.2787 86.6509 74.0444 94.9475 79.1039C103.35 84.2282 102.399 62.9323 114 68.3953C101.921 64.2857 106.932 89.64 91.9646 86.2658C74.8363 82.4045 96.1377 55.1601 89.2524 45.8429H89.2523Z" fill="#8D1E00"/>
+<path fill-rule="evenodd" clip-rule="evenodd" d="M14 74.7276C38.7271 55.0266 72.4083 86.6411 88.3024 88.6166C108.743 91.1568 103.298 67.5234 113.529 68.4039C104.101 69.5408 109.76 94.2573 88.6835 95.0211C65.7302 95.853 42.8299 60.8576 14 74.7276H14Z" fill="#2B1200"/>
+<path d="M124.96 84H140.38V77.88H136.78V59.46H148.24V77.88H144.64V84H160V77.88H154.48V53.34H136.78V50.88C136.78 48.24 139.12 47.28 141.88 47.28C144.22 47.28 146.41 47.46 148.24 47.67C148.99 48.54 150.07 49.08 151.3 49.08C153.64 49.08 155.44 47.22 155.44 44.94C155.44 42.66 153.64 40.86 151.3 40.86C149.92 40.86 148.72 41.52 147.97 42.54C145.45 41.82 143.35 41.28 140.38 41.28C135.7 41.28 130.54 42.72 130.54 49.56V53.34H124.96V59.46H130.54V77.88H124.96V84ZM158.033 84H179.993V77.94H171.413V68.04C171.413 62.46 174.353 58.98 181.913 58.98V65.58H188.633V54.24C187.073 53.4 184.673 52.62 181.613 52.62C176.513 52.62 172.463 54.99 170.933 58.26V53.34H158.033V59.4H164.513V77.94H158.033V84ZM205.085 84.72C209.825 84.72 213.485 82.8 216.065 79.98L211.925 75.6C210.005 77.7 207.845 78.6 205.145 78.6C200.885 78.6 198.125 75.81 197.345 71.34H218.165C218.405 69.78 218.405 68.22 218.405 67.14C218.405 57.18 212.465 52.62 205.085 52.62C196.145 52.62 190.445 58.68 190.445 68.64C190.445 78.36 195.965 84.72 205.085 84.72ZM205.085 58.68C208.265 58.68 211.205 60.72 211.625 65.46H197.345C198.065 61.2 200.465 58.68 205.085 58.68ZM222.798 84H247.938V77.82H231.618L247.998 58.44V53.34H223.938V59.52H239.178L222.798 78.78V84ZM266.371 84.72C275.491 84.72 281.071 78.54 281.071 68.7C281.071 58.86 275.491 52.62 266.371 52.62C257.311 52.62 251.671 58.92 251.671 68.7C251.671 78.6 257.311 84.72 266.371 84.72ZM266.371 78.12C261.391 78.12 258.631 74.4 258.631 68.7C258.631 62.94 261.391 59.16 266.371 59.16C271.471 59.16 274.111 63 274.111 68.7C274.111 74.4 271.411 78.12 266.371 78.12ZM283.903 84H290.803V66.6C290.803 60.9 293.923 59.16 297.583 59.16C301.063 59.16 303.943 61.08 303.943 66.72V84H310.843V65.28C310.843 55.86 305.623 52.62 299.503 52.62C295.633 52.62 292.333 54.33 290.803 56.28V53.34H283.903V84ZM328.976 84.72C333.716 84.72 337.376 82.8 339.956 79.98L335.816 75.6C333.896 77.7 331.736 78.6 329.036 78.6C324.776 78.6 322.016 75.81 321.236 71.34H342.056C342.296 69.78 342.296 68.22 342.296 67.14C342.296 57.18 336.356 52.62 328.976 52.62C320.036 52.62 314.336 58.68 314.336 68.64C314.336 78.36 319.856 84.72 328.976 84.72ZM328.976 58.68C332.156 58.68 335.096 60.72 335.516 65.46H321.236C321.956 61.2 324.356 58.68 328.976 58.68Z" fill="#ADADAD"/>
+</svg>