mirror of
https://github.com/outbackdingo/firezone.git
synced 2026-03-21 06:41:41 +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>
62 lines
2.1 KiB
Plaintext
62 lines
2.1 KiB
Plaintext
---
|
|
title: Configure
|
|
sidebar_position: 5
|
|
---
|
|
|
|
# Configure Firezone
|
|
|
|
There are two types of configuration in Firezone:
|
|
|
|
* [Runtime configuration](#runtime-configuration): Application configuration
|
|
related to day-to-day operation of Firezone.
|
|
* [Deployment configuration](#deployment-configuration): Deployment or
|
|
infrastructure-related configuration relevant to running Firezone on-prem.
|
|
|
|
## Runtime Configuration
|
|
|
|
Most day-to-day configuration of Firezone can be done via the Web UI.
|
|
This type of configuration can be expected to be changed **with no downtime**
|
|
in a production deployment.
|
|
|
|
We're actively working to move more configuration variables to
|
|
this type of configuration, so expect more ENV vars to transition to runtime
|
|
configuration in the future.
|
|
|
|
## Deployment Configuration
|
|
|
|
Deployment-related and infrastructure configuration require restarting Firezone
|
|
services after change.
|
|
|
|
<Tabs>
|
|
<TabItem value="docker" label="Docker" default>
|
|
|
|
Docker-based deployments are configured through environment
|
|
variables passed to the `firezone` container. These can be
|
|
specified either in a `.env` file in the current directory,
|
|
the `docker-compose.yml` file, or passed to the `docker run`
|
|
call directly. See the [env var reference](../../reference/env-vars)
|
|
for a complete listing.
|
|
|
|
See [Docker's documentation
|
|
](https://docs.docker.com/compose/envvars-precedence/) for more information.
|
|
|
|
</TabItem>
|
|
<TabItem value="omnibus" label="Omnibus">
|
|
|
|
For Omnibus-based deployments, Firezone leverages [Chef Omnibus
|
|
](https://github.com/chef/omnibus) to handle release packaging, process
|
|
supervision, log management, and more.
|
|
|
|
The main configuration file is written in [Ruby](https://ruby-lang.org) and can
|
|
be found at `/etc/firezone/firezone.rb` on a default installation.
|
|
Changing this file **requires re-running** `sudo firezone-ctl reconfigure`
|
|
which triggers Chef to pick up the changes and apply them to the running
|
|
system.
|
|
|
|
For an exhaustive list of Omnibus configuration variables and their
|
|
descriptions, see the [configuration file reference
|
|
](../../reference/configuration-file).
|
|
|
|
</TabItem>
|
|
</Tabs>
|