mirror of
https://github.com/outbackdingo/firezone.git
synced 2026-04-05 07:06:08 +00:00
221739edeb
* Bump npm * Bump deps for dependabot issues * MFA (#660) * 2fa wip add encrypted map gen schema add nimble_totp add module doc add qrusty bump base to enable use of qrusty requires a newer version of glibc Revert "add qrusty" This reverts commit 27eaf7864ea98578186c53ed4c5f650e244e8ede. cannot be used on bionic add eqrcode scaffold extract renderQR Revert "add eqrcode" This reverts commit fe6f74f18f13dfcc92dbdace657d194e5536e164. use frontend qr code generation display MFA methods add description * wip * finish mfa totp addition workflow * use real user * allow deleting authenticator * use valid? and :since * make credo happy * use mfa * make credo happy * add account page for unprivileged users * eof * add unit tests * add integration tests * Workaround for SSH dropping by not using random port (#697) * Bump npm * Bump deps for dependabot issues * Workaround for SSH dropping by not using random port Fixes #478 Co-authored-by: Jamil Bou Kheir <jamilbk@users.noreply.github.com> * Update repo README (#700) * update main readme * add link * update badges * remove redundant copy * Fix show-config to display current config (#703) Fixes #553 * Minor MFA fixes (#704) * Fix conflicting cache-control header (#706) * Add manual refresh (#705) * Add manual refresh * Align button right Co-authored-by: Jamil Bou Kheir <jamilbk@users.noreply.github.com> Co-authored-by: Po Chen <chenpaul914@gmail.com> Co-authored-by: Gabi <gabriel@firezone.dev> Co-authored-by: Jason G <52545545+gongjason@users.noreply.github.com>
2.2 KiB
2.2 KiB
layout, title, nav_order, description
| layout | title | nav_order | description |
|---|---|---|---|
| default | Overview | 1 | Firezone is a self-managed WireGuard-based VPN server and Linux firewall designed for simplicity and security. |
{:width="500"}
These docs explain how to deploy, configure, and use Firezone.
## Quick Start
1. [Deploy]({% link docs/deploy/index.md %}): A step-by-step walkthrough of
setting up Firezone. Start here if you are new.
1. [Administer]({% link docs/administer/index.md %}): This section relates
directly to configuring the server instance.
1. [User Guides]({% link docs/user-guides/index.md %}): Useful guides to help you
learn how to use Firezone and troubleshoot common issues. Consult this section
after you successfully deploy the Firezone server.
## Common Configuration Guides
1. [Split Tunneling]({% link docs/user-guides/split-tunnel.md %}):
Only route traffic to certain IP ranges through the VPN.
1. [Whitelisting with VPN]({% link docs/user-guides/whitelist-vpn.md %}):
Configure a VPN server with a static IP address.
1. [Reverse Tunnels]({% link docs/user-guides/reverse-tunnel.md %}):
Establish tunnels between multiple peers.
## Get Help
If you're looking for help installing, configuring, or using Firezone, we're
happy to help.
1. Discussion Forums: Ask questions, report bugs,
and suggest features.
1. Public Slack Group:
Join live discussions, meet other users, and get to know the contributors.
1. Email Us: We read every email and respond as soon
as we can.
## Contribute to Firezone
We deeply appreciate any and all contributions to the project and do our best to
ensure your contribution is included. To get started, see
CONTRIBUTING.md
.