mirror of
https://github.com/outbackdingo/firezone.git
synced 2026-01-27 10:18:54 +00:00
5f6685c5aa
* docs: add logs and update troubleshooting Updates the troubleshooting doc for Docker based deployments and adds a general logs doc with more info on what Firezone logs. Also added a mention of Audit logs in beta to source more convos. * docs: further Docker clarifications Clarifying some troubleshooting guides that refer to firezone-ctl. Not everyone arrives at the env-vars or config file through the deploy/configure guide. Some load these pages directly via search. Adding a more prominent note that it's for Omnibus based deploy. * docs: add troubleshooting docs on locked out state Adding a section on reseting admin passwords for both docker and omnibus deployments. I realize we removed the omnibus firezone-ctl reference. I won't add it back since I have no idea where to put it. * docs: update split tunnel doc Was originally going to write more about other ways you can achieve split tunneling with wireguard, but will leave that for now * fix whitespace * update split tunnel doc * docs: add DNS considerations to split tunnel doc https://github.com/firezone/product/issues/527 * update split tunnel doc * further clarify split tunnel doc * add note about on-demand feature * Docs - Improve titles and descriptions (#1187) * docs: update titles, descriptions Changes: - set more descriptive titles (better for readers and SEO) - add meta descriptions - convert titles to sentence case for consistency * docs: small fixes * fix trailing whitespaces * fix spelling * Apply suggestions from code review Co-authored-by: Jamil <jamilbk@users.noreply.github.com> Signed-off-by: Jason G <jason@firez.one> * add descriptions to client instructions Signed-off-by: Jason G <jason@firez.one> Co-authored-by: Jamil <jamilbk@users.noreply.github.com> * chore: update logs doc * chore: apply suggestions from code review Co-authored-by: Jamil <jamilbk@users.noreply.github.com> Signed-off-by: Jason G <jason@firez.one> * chore: line length and log description * chore: rename debug logs * chore: apply suggestions from code review Co-authored-by: Jamil <jamilbk@users.noreply.github.com> Signed-off-by: Jason G <jason@firez.one> * Docs - Add draft whitelist sso doc (#1185) * doc: adding whitelist sso doc redo of https://github.com/firezone/firezone/pull/995 * docs: add seo titles * docs: improve titles * grammar fixes * fix trailing whitespace apparently my vscode plugin does not find trailing whitespace in front matter * put doc in draftmode * add note on wireguard client apps * Revert "add note on wireguard client apps" This reverts commit 9013ce1c3b1bcb8b825f0fcbb1c5fe7e050cae82. * Apply suggestions from code review Co-authored-by: Jamil <jamilbk@users.noreply.github.com> Signed-off-by: Jason G <jason@firez.one> Signed-off-by: Jason G <jason@firez.one> Co-authored-by: Jamil <jamilbk@users.noreply.github.com> * chore: apply suggestions from code review Co-authored-by: Jamil <jamilbk@users.noreply.github.com> Signed-off-by: Jason G <jason@firez.one> * chore: Update docs/docs/user-guides/client-instructions.mdx Co-authored-by: Jamil <jamilbk@users.noreply.github.com> Signed-off-by: Jason G <jason@firez.one> * chore: update title capitalization and other small fixes * Apply suggestions from code review Signed-off-by: Jamil <jamilbk@users.noreply.github.com> Signed-off-by: Jason G <jason@firez.one> Signed-off-by: Jamil <jamilbk@users.noreply.github.com> Co-authored-by: Jamil <jamilbk@users.noreply.github.com>
Firezone 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 to keep control of your network traffic.
- Built on WireGuard® to be stable, performant, and lightweight.
Get Started
Follow our deploy guide to install your self-hosted instance of Firezone.
Or, if you're on a supported platform, try our one-line install script:
bash <(curl -fsSL https://github.com/firezone/firezone/raw/master/scripts/install.sh)
Using Firezone in production at your organization? Take a look at our Enterprise Plan.
Features
- Fast: Uses WireGuard® to be 3-4 times 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 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.
Get Help
If you're looking for help installing, configuring, or using Firezone, check our community support options:
- Discussion Forums: Ask questions, report bugs, and suggest features.
- Public Slack Group: Join live discussions, meet other users, and get to know the contributors.
- Open a PR: 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.
Star History
Package Repository
Package repository hosting is graciously provided by Cloudsmith. 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.
Security
See SECURITY.md.
License
See LICENSE.
WireGuard® is a registered trademark of Jason A. Donenfeld.