mirror of
https://github.com/outbackdingo/firezone.git
synced 2026-01-27 10:18:54 +00:00
135 lines
5.8 KiB
Markdown
135 lines
5.8 KiB
Markdown
**Note**: 🚧 The `main` branch is undergoing major restructuring in preparation
|
|
for the 1.0 release 🚧.
|
|
|
|
See the [`legacy` branch](https://github.com/firezone/firezone/tree/legacy) for
|
|
the branch tracking the latest 0.7 release.
|
|
|
|
[Read the 1.0 announcement](https://www.firezone.dev/blog/firezone-1-0).
|
|
|
|
<p align="center">
|
|
<img src="https://user-images.githubusercontent.com/52545545/144147936-39f3e416-8ba0-4f24-915e-f0515f85bb64.png" alt="firezone logo" width="305"/>
|
|
</p>
|
|
<p align="center">
|
|
<a href="https://github.com/firezone/firezone/releases">
|
|
<img src="https://img.shields.io/github/v/release/firezone/firezone?color=%23999">
|
|
</a>
|
|
<a href="https://discourse.firez.one/?utm_source=readme">
|
|
<img src="https://img.shields.io/static/v1?logo=discourse&logoColor=959DA5&label=support%20forum&labelColor=333a41&message=join&color=611f69" alt="firezone Discourse" />
|
|
</a>
|
|
<img src="https://img.shields.io/static/v1?logo=github&logoColor=959DA5&label=Test&labelColor=333a41&message=passing&color=3AC358" alt="firezone" />
|
|
<a href="https://coveralls.io/github/firezone/firezone?branch=legacy">
|
|
<img src="https://coveralls.io/repos/github/firezone/firezone/badge.svg?branch=legacy" alt="Coverage Status" />
|
|
</a>
|
|
<img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/firezone/firezone"/>
|
|
<img alt="GitHub closed issues" src="https://img.shields.io/github/issues-closed/firezone/firezone"/>
|
|
<a href="https://cloudsmith.com">
|
|
<img src="https://img.shields.io/badge/OSS%20hosting%20by-cloudsmith-blue?logo=cloudsmith" alt="Cloudsmith">
|
|
</a>
|
|
<a href="https://twitter.com/intent/follow?screen_name=firezonehq">
|
|
<img src="https://img.shields.io/twitter/follow/firezonehq?style=social&logo=twitter" alt="follow on Twitter">
|
|
</a>
|
|
</p>
|
|
|
|
## [Firezone](https://www.firezone.dev/?utm_source=readme) is a self-hosted VPN server and Linux firewall
|
|
|
|
- Manage remote access through an intuitive web interface and CLI utility.
|
|
- [Deploy on your own infrastructure](https://docs.firezone.dev/deploy?utm_source=readme)
|
|
to keep control of your network traffic.
|
|
- Built on [WireGuard®](https://www.wireguard.com/) to be stable, performant,
|
|
and lightweight.
|
|
|
|
|
|
|
|
## Get Started
|
|
|
|
Follow our [deploy guide](https://docs.firezone.dev/deploy) to install your
|
|
self-hosted instance of Firezone.
|
|
|
|
Or, if you're on a
|
|
[supported platform](https://docs.firezone.dev/deploy/docker/supported-platforms?utm_source=readme),
|
|
try our
|
|
[auto-install script](https://docs.firezone.dev/deploy/docker/#option-1-automatic-install).
|
|
|
|
Using Firezone in production at your organization? Contact us to learn about our
|
|
[Enterprise Plan](https://www.firezone.dev/contact/sales?utm_source=readme).
|
|
|
|
## Features
|
|
|
|
|
|
|
|
- **Fast:** Uses WireGuard® to be
|
|
[3-4 times](https://wireguard.com/performance/) faster than OpenVPN.
|
|
- **SSO Integration:** Authenticate using any identity provider with an OpenID
|
|
Connect (OIDC) connector.
|
|
- **Containerized:** All dependencies are bundled via Docker.
|
|
- **Simple:** Takes minutes to set up. Manage via a simple CLI.
|
|
- **Secure:** Runs unprivileged. HTTPS enforced. Encrypted cookies.
|
|
- **Firewall included:** Uses Linux [nftables](https://netfilter.org) to block
|
|
unwanted egress traffic.
|
|
|
|
### Anti-features
|
|
|
|
Firezone is **not:**
|
|
|
|
- An inbound firewall
|
|
- A tool for creating mesh networks
|
|
- A full-featured router
|
|
- An IPSec or OpenVPN server
|
|
|
|
## Documentation
|
|
|
|
Additional documentation on general usage, troubleshooting, and configuration
|
|
can be found at [https://docs.firezone.dev](https://docs.firezone.dev).
|
|
|
|
## Get Help
|
|
|
|
If you're looking for help installing, configuring, or using Firezone, check our
|
|
community support options:
|
|
|
|
1. [Discussion Forums](https://discourse.firez.one/?utm_source=readme): Ask
|
|
questions, report bugs, and suggest features.
|
|
1. [Public Slack Group](https://join.slack.com/t/firezone-users/shared_invite/zt-111043zus-j1lP_jP5ohv52FhAayzT6w):
|
|
Join live discussions, meet other users, and get to know the contributors.
|
|
1. [Open a PR](https://github.com/firezone/firezone/issues): Contribute a bugfix
|
|
or make a contribution to Firezone.
|
|
|
|
If you need help deploying or maintaining Firezone for your business, consider
|
|
[contacting us about our paid support plan](https://www.firezone.dev/contact/sales?utm_source=readme).
|
|
|
|
## Star History
|
|
|
|
[](https://star-history.com/#firezone/firezone&Date)
|
|
|
|
## Package Repository
|
|
|
|
[](https://cloudsmith.com)
|
|
|
|
Package repository hosting is graciously provided by
|
|
[Cloudsmith](https://cloudsmith.com). Cloudsmith is the only fully hosted,
|
|
cloud-native, universal package management solution, that enables your
|
|
organization to create, store and share packages in any format, to any place,
|
|
with total confidence.
|
|
|
|
## Developing and Contributing
|
|
|
|
See [CONTRIBUTING.md](CONTRIBUTING.md).
|
|
|
|
## Security
|
|
|
|
See [SECURITY.md](SECURITY.md).
|
|
|
|
## License
|
|
|
|
Portions of this software are licensed as follows:
|
|
|
|
- All content residing under the "elixir/" directory of this repository, if that
|
|
directory exists, is licensed under the "Elastic License 2.0" license defined
|
|
in "elixir/LICENSE".
|
|
- All third party components incorporated into the Firezone Software are
|
|
licensed under the original license provided by the owner of the applicable
|
|
component.
|
|
- Content outside of the above mentioned directories or restrictions above is
|
|
available under the "Apache 2.0 License" license as defined in "LICENSE".
|
|
|
|
WireGuard® is a registered trademark of Jason A. Donenfeld.
|