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

Files

Jamil a43f39ae8b perf: increase UDP send rate for performance test (#4793 )

Now that we've worked out the flakiness from the iperf tests, we should
increase the UDP send rate so we have some benchmark of how many packets
we can actually handle before dropping.

2024-04-26 21:11:44 +00:00

build

ci: use consistent binary dest path naming (#4772 )

2024-04-24 20:11:00 +00:00

nix

refactor(linux-client): replace client-tunnel with headless-client which is the same thing (#4516 )

2024-04-10 22:01:55 +00:00

tests

perf: increase UDP send rate for performance test (#4793 )

2024-04-26 21:11:44 +00:00

gateway-docker-upgrade.sh

chore: remove test lib bash sourcing from customer-run scripts (#4753 )

2024-04-23 19:04:02 +00:00

gateway-systemd-install.sh

fix(gateway): Fix conditional used to check for upgrades (#4796 )

2024-04-26 07:55:26 -07:00

Makefile

ci: Bump versions and fix release overwrites (#4769 )

2024-04-24 11:43:19 -07:00

README.md

chore: move markdown files into docs/ directory (#3773 )

2024-02-27 01:12:57 +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 -euo pipefail in general for dev and test scripts.
In Docker images and other minimal envs, stick to #!/bin/sh and simply set -eu.