diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 12c9d1397..773b94cfb 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -13,15 +13,15 @@ defaults: jobs: lint-docs: runs-on: macos-11 - steps: - - uses: actions/checkout@v2 + steps: + - uses: actions/checkout@v2 - uses: actions/setup-node@v2 with: node-version: '14.18.2' - - name: Lint Docs - run: | - npm install -g markdownlint-cli - markdownlint docs/ + - name: Lint Docs + run: | + npm install -g markdownlint-cli + markdownlint docs/ static-analysis: runs-on: ubuntu-18.04 @@ -121,7 +121,10 @@ jobs: mix coveralls.github --umbrella || mix test build-package-test: - needs: unit-test + needs: + - static-analysis + - unit-test + - lint-docs runs-on: ${{ matrix.os }} strategy: # Failing fast breaks the Omnibus build cache because the job is diff --git a/docs/docs/deploy/server.md b/docs/docs/deploy/server.md index 900c919cc..5b3439e63 100644 --- a/docs/docs/deploy/server.md +++ b/docs/docs/deploy/server.md @@ -10,7 +10,6 @@ parent: Deploy [prerequisites]({% link docs/deploy/prerequisites.md %}) before following this guide. - ## Installation Instructions **NOTE**: Firezone modifies the kernel netfilter and routing tables. Other diff --git a/docs/docs/reference/configuration-file.md b/docs/docs/reference/configuration-file.md index 7f21d26a1..026f1738f 100644 --- a/docs/docs/reference/configuration-file.md +++ b/docs/docs/reference/configuration-file.md @@ -9,12 +9,12 @@ parent: Reference Shown below is a complete listing of the configuration options available in `/etc/firezone/firezone.rb`. - + | option | description | default value | | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------- | | `default['firezone']['nginx']['enabled']` | Whether to enable the bundled nginx server. | `true` | -| `default['firezone']['fqdn']` | FQDN of this Firezone instance. | `(node['fqdn'] \|\| node['hostname']).downcase` | +| `default['firezone']['fqdn']` | FQDN of this Firezone instance. | `(node['fqdn'] || node['hostname']).downcase` | | `default['firezone']['config_directory']` | Top-level directory for Firezone configuration. | `'/etc/firezone'` | | `default['firezone']['install_directory']` | Top-level directory to install Firezone to. | `'/opt/firezone'` | | `default['firezone']['app_directory']` | Top-level directory to install the Firezone web application. | `"#{node['firezone']['install_directory']}/embedded/service/firezone"` | @@ -146,4 +146,4 @@ Shown below is a complete listing of the configuration options available in | `default['firezone']['connectivity_checks']['enabled']` | Enable or disable the Firezone connectivity checks service. | `true` | | `default['firezone']['connectivity_checks']['interval']` | Interval between connectivity checks in seconds. | `3_600` | - +