2021-09-23 06:24:21 +00:00
2021-09-22 17:46:35 -07:00
2021-09-16 20:39:04 +00:00
2021-09-09 20:13:14 +00:00
2020-04-21 20:49:55 -07:00
2021-07-22 17:50:54 -07:00
2020-11-04 10:14:20 -06:00
2021-08-04 18:11:28 -07:00
2021-09-07 13:20:50 -07:00
2020-04-21 20:49:55 -07:00
2021-09-09 16:07:19 -07:00
2021-07-10 06:29:16 -07:00

firezone logo

firezone firezone Slack firezone Slack firezone firezone

FireZone is a simple WireGuard based VPN server and firewall for Linux designed to be secure, easy to manage, and quick to set up.

Architecture

What is Firezone?

Firezone can be set up in minutes to manage your WireGuard VPN through a simple web interface.

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
  • Secure: The Firezone Web UI runs as an unpriveleged user.

Firezone

Deploying and Configuring

  1. Download the relevant package for your distribution from the releases page
  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.
  4. Edit the default configuration at /etc/firezone/firezone.rb. You'll want to make sure default['firezone']['fqdn'], default['firezone']['url_host'], default['firezone']['ssl']['certificate'], and default['firezone']['ssl']['certificate'] are set properly.
  5. Reconfigure the application to pick up the new changes: sudo firezone-ctl reconfigure.
  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>

Using Firezone VPN

Your FireZone installation can be managed via the firezone-ctl command, as shown below. Most subcommands require prefixing with sudo.

root@demo:~# firezone-ctl
I don't know that command.
omnibus-ctl: command (subcommand)
create_admin
  Create an Admin user
General Commands:
  cleanse
    Delete *all* firezone data, and start from scratch.
  help
    Print this help message.
  reconfigure
    Reconfigure the application.
  show-config
    Show the configuration that would be generated by reconfigure.
  uninstall
    Kill all processes and uninstall the process supervisor (data will be preserved).
  version
    Display current version of Firezone
Service Management Commands:
  graceful-kill
    Attempt a graceful stop, then SIGKILL the entire process group.
  hup
    Send the services a HUP.
  int
    Send the services an INT.
  kill
    Send the services a KILL.
  once
    Start the services if they are down. Do not restart them if they stop.
  restart
    Stop the services if they are running, then start them again.
  service-list
    List all the services (enabled services appear with a *.)
  start
    Start services if they are down, and restart them if they stop.
  status
    Show the status of all the services.
  stop
    Stop the services, and do not restart them.
  tail
    Watch the service logs of all enabled services.
  term
    Send the services a TERM.
  usr1
    Send the services a USR1.
  usr2
    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 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 project consisting of three independent applications:

For now, FireZone assumes these apps are all running on the same host.

Chef Omnibus is used to bundle all FireZone dependencies into a single distributable Linux package.

Getting Support

For help, feedback or contributions please join our Slack group. We're actively working to improve Firezone, and the Slack group is the best way to coordinate our efforts.

Developing and Contributing

License

WireGuard™ is a registered trademark of Jason A. Donenfeld.

Description
No description provided
Readme Apache-2.0 169 MiB
Languages
Elixir 57.1%
Rust 29.2%
TypeScript 5.9%
Swift 3.3%
Kotlin 1.8%
Other 2.5%