scottk/firezone
1
0
Fork 0
mirror of https://github.com/outbackdingo/firezone.git synced 2026-04-05 12:06:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add supported OSes table

Browse Source
This commit is contained in:
Jamil Bou Kheir
2021-09-23 16:11:57 -07:00
parent 6a15021620
commit d16546fe32
1 changed files with 24 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@@ -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 | <span style="color:green">Fully-supported</span> |
| CentOS 8 | <span style="color:green">Fully-supported</span> |
| Ubuntu 18.04 | <span style="color:green">Fully-supported</span> |
| Ubuntu 20.04 | <span style="color:green">Fully-supported</span> |
| Debian 10 | <span style="color:green">Fully-supported</span> |
| Debian 11 | <span style="color:green">Fully-supported</span> |
| Fedora 33 | <span style="color:green">Fully-supported</span> |
| Fedora 34 | <span style="color:green">Fully-supported</span> |
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-<version>.rpm` or `sudo dpkg -i firezone-<version>.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