mirror of
https://github.com/outbackdingo/firezone.git
synced 2026-01-27 10:18:54 +00:00
- [x] Move all docs to be served under `/docs` prefix - [x] Merge blog articles and serve under `/blog` prefix - [x] Remove docs side bar for blog content - [x] Remake marketing site pages in markdown/react - [x] Serve marketing site under root path - [x] Update all old links and paths to use new prefixes
50 lines
1.9 KiB
Plaintext
50 lines
1.9 KiB
Plaintext
---
|
|
title: Overview
|
|
sidebar_position: 1
|
|
---
|
|
|
|
[Firezone](/) is an open-source secure remote access
|
|
platform that can be deployed on your own infrastructure in minutes.
|
|
Use it to **quickly and easily** secure access to
|
|
your private network and internal applications from an intuitive web UI.
|
|
|
|

|
|
|
|
These docs explain how to deploy, configure, and use Firezone.
|
|
|
|
## Quick start
|
|
|
|
1. [Deploy](deploy): A step-by-step walk-through setting up Firezone.
|
|
Start here if you are new.
|
|
1. [Authenticate](authenticate): Set up authentication using local
|
|
email/password, OpenID Connect, or SAML 2.0 and optionally enable
|
|
TOTP-based MFA.
|
|
1. [Administer](administer): Day to day administration of the Firezone
|
|
server.
|
|
1. [User Guides](user-guides): 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](./user-guides/use-cases/split-tunnel):
|
|
Only route traffic to certain IP ranges through the VPN.
|
|
1. [Setting up a NAT Gateway with a Static IP](./user-guides/use-cases/nat-gateway):
|
|
Configure Firezone with a static IP address to provide
|
|
a single egress IP for your team's traffic.
|
|
1. [Reverse Tunnels](./user-guides/use-cases/reverse-tunnel):
|
|
Establish tunnels between multiple peers.
|
|
|
|
import SupportOptions from "@site/src/partials/_support_options.mdx";
|
|
<SupportOptions />;
|
|
|
|
## 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
|
|
](https://github.com/firezone/firezone/blob/master/CONTRIBUTING.md).
|
|
|
|
<!-- Leaving these disabled until they're ready -->
|
|
<!-- <feedback /> -->
|
|
<!-- <newsletter /> -->
|