mirror of https://github.com/outbackdingo/firezone.git synced 2026-01-27 10:18:54 +00:00

Files

Thomas Eizinger 4cf36cd8bd docs(kb): update path to Gateway to new location (#8794 )

In #8480, we changed the location that `firezone-gateway` gets
downloaded to but forgot to update the knowledgebase with the new path.

---------

Signed-off-by: Thomas Eizinger <thomas@eizinger.io>

2025-04-16 13:20:28 +00:00

build

ci: fix apple artifact upload (#8753 )

2025-04-11 13:33:43 +00:00

nix

chore(nix): bump to 24.11 and remove flake-utils (#8767 )

2025-04-13 02:08:42 +00:00

tests

ci: Use search_domain for one resource in CI test (#8393 )

2025-03-15 13:27:22 +00:00

upload

ci: Add fixes for upload script (#7588 )

2024-12-29 19:08:08 +00:00

bump-versions.sh

ci: Release Apple clients 1.4.9 (#8793 )

2025-04-15 20:14:43 +00:00

firezone-client-gui-install.sh

docs: Update 'user guides' -> 'client apps' (#5940 )

2024-07-23 14:04:07 +00:00

gateway-docker-upgrade.sh

fix(gateway/docker): Handle missing gateway_id (#8534 )

2025-03-28 04:28:24 +00:00

gateway-systemd-install.sh

docs(kb): update path to Gateway to new location (#8794 )

2025-04-16 13:20:28 +00:00

README.md

chore(gui-client/linux): add install script and change group to firezone-client (#4879 )

2024-05-02 17:51:28 +00:00

README.md

Firezone shell scripts

This directory contains various shell scripts used for development, testing, and deployment of the Firezone product.

Developer Setup

We lint shell scripts in CI. To get your PR to pass, you'll want to ensure your local development environment is set up to lint shell scripts:

Install shfmt:
- brew install shfmt on macOS
- Install shfmt from https://github.com/mvdan/sh/releases for other platforms
Install shellcheck:
- brew install shellcheck on macOS
- sudo apt-get install shellcheck on Ubuntu

Then just lint and format your shell scripts before you commit:

shfmt -i 4 **/*.sh
shellcheck --severity=warning **/*.sh

You can achieve this more easily by using pre-commit. See CONTRIBUTING.

Editor setup

Vim (here's an example using ALE)
VSCode

Scripting tips

Use #!/usr/bin/env bash along with set -euox pipefail in general for dev and test scripts.
In Docker images and other minimal envs, stick to #!/bin/sh and simply set -eu.