firezone

mirror of https://github.com/outbackdingo/firezone.git synced 2026-03-21 01:41:40 +00:00

Files

Jamil 1de24ff77e REST API (#1155 )

### TODO

- [x] "/v0"
- [x] Double-check migration order; re-timestamp if necessary
- [x] Move `sites` fields to `configurations` so they can be updated
from API
- [x] #1240 -- it introduces possible race conditions for API requests
- [x] #1249 
- [ ] #1008 
- [ ] Final review

Signed-off-by: Jamil <jamilbk@users.noreply.github.com>
Co-authored-by: Andrew Dryga <andrew@dryga.com>

2022-12-31 12:58:11 -06:00

administer

REST API (#1155 )

2022-12-31 12:58:11 -06:00

authenticate

Update recommendations for local authentication (#1252 )

2022-12-29 17:13:18 -06:00

deploy

REST API (#1155 )

2022-12-31 12:58:11 -06:00

reference

REST API (#1155 )

2022-12-31 12:58:11 -06:00

user-guides

Fix whitespace (#1208 )

2022-12-18 21:15:46 -06:00

README.mdx

Add SupportOptions component and utm_source for links (#1219 )

2022-12-24 16:16:55 -06:00

README.mdx

---
title: Overview
sidebar_position: 1
---

[Firezone](https://www.firezone.dev/?utm_source=docs.firezone.dev) 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.

![Architecture](https://user-images.githubusercontent.com/52545545/183804397-ae81ca4e-6972-41f9-80d4-b431a077119d.png)

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 /> -->