mirror of
https://github.com/outbackdingo/firezone.git
synced 2026-01-27 18:18:55 +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>
--- title: Overview sidebar_position: 1 --- [Firezone](https://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.  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. ## Get Help If you're looking for help installing, configuring, or using Firezone, check our community support options: 1. [Discussion Forums](https://discourse.firez.one/): Ask questions, report bugs, and suggest features. 1. [Public Slack Group](https://join.slack.com/t/firezone-users/shared_invite/zt-111043zus-j1lP_jP5ohv52FhAayzT6w): Join live discussions, meet other users, and get to know the contributors. 1. [Open a PR](https://github.com/firezone/firezone/issues): Contribute a bugfix or make a contribution to Firezone. If you need help deploying or maintaining Firezone for your team or organization, consider [contacting us about our paid support plan](https://firezone.dev/contact/sales). ## 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 /> -->