From d01afc79f1c149f7585eaa18246603fd79787adc Mon Sep 17 00:00:00 2001 From: Jamil Date: Sun, 21 Jul 2024 16:43:54 -0700 Subject: [PATCH] docs: Prettier prosewrap for docs (#5932) When writing docs it's helpful to have Prettier format long lines automatically. This non-intuitively applies to not only prose, but tables, MDX components, and other items as well. Since many times this content is not prose but reference material, we can have prettier format these and leave the `blog/` section left at `preserve` to allow post authors to manage newlines as they see fit. --- .prettierrc.json | 13 ++++++++++- website/src/app/kb/deploy/dns/readme.mdx | 22 +++++++++++++++---- website/src/app/kb/reference/faq/readme.mdx | 8 +++---- .../user-guides/linux-gui-client/readme.mdx | 3 ++- 4 files changed, 36 insertions(+), 10 deletions(-) diff --git a/.prettierrc.json b/.prettierrc.json index 2e425c9f4..2153b9d90 100644 --- a/.prettierrc.json +++ b/.prettierrc.json @@ -3,5 +3,16 @@ "tabWidth": 2, "semi": true, "singleQuote": false, - "proseWrap": "preserve" + "proseWrap": "always", + "overrides": [ + { + "files": [ + "website/src/app/blog/**/*.md", + "website/src/app/blog/**/*.mdx" + ], + "options": { + "proseWrap": "preserve" + } + } + ] } diff --git a/website/src/app/kb/deploy/dns/readme.mdx b/website/src/app/kb/deploy/dns/readme.mdx index f8a474925..6fdbaf3a4 100644 --- a/website/src/app/kb/deploy/dns/readme.mdx +++ b/website/src/app/kb/deploy/dns/readme.mdx @@ -65,10 +65,23 @@ the [upstream resolvers](#configuring-client-dns-upstream-resolvers) if configured in your account. Otherwise, it forwards the query to the default system resolver on the Client host. + + +Queries forwarded to upstream resolvers are **never** routed through Firezone +unless (1) you've defined custom upstream resolver(s) below, and (2) those +resolvers are defined as Resources in your account. This ensures that queries +for Firezone infrastructure and services on the Client's local LAN continue to +be resolvable even if the Client's DHCP-provided DNS server collides with an IP +or CIDR Resource in your account. + + + - Firezone only intercepts queries for the `A`, `AAAA`, and `PTR` record types - for your DNS Resources. All other record types are forwarded to the upstream - resolver(s). + +Firezone only intercepts queries for the `A`, `AAAA`, and `PTR` record types for +your DNS Resources. All other record types are forwarded to the upstream +resolver(s). + ## Configuring Client DNS upstream resolvers @@ -100,7 +113,8 @@ network. ## Configuring Gateway resolvers Firezone makes no assumptions about the DNS environment in which the Gateway -runs. It uses the default system resolver you've configured on the Gateway host. +runs. It uses the default system resolver you've configured on the Gateway host, +typically defined in `/etc/resolv.conf`. This resolver is used for DNS Resources defined in your Firezone account so it's important that your Gateway host has DNS configured properly for Clients to diff --git a/website/src/app/kb/reference/faq/readme.mdx b/website/src/app/kb/reference/faq/readme.mdx index 3892ee20f..8d3262b6a 100644 --- a/website/src/app/kb/reference/faq/readme.mdx +++ b/website/src/app/kb/reference/faq/readme.mdx @@ -49,8 +49,8 @@ stack, it supports all application protocols without modification. #### How long does it take to set up Firezone? Firezone can be set up in less than 10 minutes, and Gateways can be added by -running a simple Docker command. Check out the [Quickstart Guide](/kb/quickstart) -for step-by-step instructions. +running a simple Docker command. Check out the +[Quickstart Guide](/kb/quickstart) for step-by-step instructions. #### Do I have to be technical to run Firezone? @@ -79,8 +79,8 @@ Firezone uses a split control plane and data plane architecture to allow for things like key distribution, user authentication, and policy enforcement to happen out-of-band with the hot data paths. The data plane components such as the Clients and Gateway are specifically designed to be self-hosted, but the -control plane, due to its reliability, security, and persistence requirements, is -not. +control plane, due to its reliability, security, and persistence requirements, +is not. That said, Firezone's product is 100% open source and can be found at our [main repository](https://github.com/firezone/firezone). Our license does not diff --git a/website/src/app/kb/user-guides/linux-gui-client/readme.mdx b/website/src/app/kb/user-guides/linux-gui-client/readme.mdx index 7acc63b88..08ea5b741 100644 --- a/website/src/app/kb/user-guides/linux-gui-client/readme.mdx +++ b/website/src/app/kb/user-guides/linux-gui-client/readme.mdx @@ -186,6 +186,7 @@ sudo systemctl restart firezone-client-ipc [#4764](https://github.com/firezone/firezone/issues/4764) - The GUI Client does not run on Ubuntu 24.04 yet [#4883](https://github.com/firezone/firezone/issues/4883) -- If you update Firezone while the GUI is running, you must manually restart the GUI [#5790](https://github.com/firezone/firezone/issues/5790) +- If you update Firezone while the GUI is running, you must manually restart the + GUI [#5790](https://github.com/firezone/firezone/issues/5790)