mirror of
https://github.com/outbackdingo/firezone.git
synced 2026-01-28 02:18:50 +00:00
b54684a154
* add links to common configurations * add Google auth doc restructure auth section and add start to google sso draft * Add Okta doc first draft * update authentication index * fix wording * grammar * suggested changes - resolved comments - images wider for visibility - newline * complete Google OAuth doc * lint error + grammar * complete Okta doc * ordering + wording * re-auth instructions * fixes * consistent references * add reference to sso in add users doc * fix small markdown error
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="600"}
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
.