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

Files

Reactor Scram 7bc1d51b0f test(linux-client): separate the token from the systemd unit file (#4626 )

This is needed so that we can auto-update the systemd unit file, either
manually, or with a package manager like `apt`. We don't want users
cut-and-pasting these together on every update, and we don't want
machines doing it. Making the file updatable means we can make security
fixes to it easily.

2024-04-15 20:38:49 +00:00

build

refactor(linux-client): extract all code to firezone-client-tunnel (#4448 )

2024-04-02 16:59:29 +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

test(linux-client): separate the token from the systemd unit file (#4626 )

2024-04-15 20:38:49 +00:00

gateway-docker-upgrade.sh

ci: reduce duplication in integration tests (#4583 )

2024-04-11 23:01:12 +00:00

gateway-systemd-install.sh

ci: reduce duplication in integration tests (#4583 )

2024-04-11 23:01:12 +00:00

Makefile

chore(clients): Bump Apple to 1.0.2; Android 1.0.1 (#4590 )

2024-04-11 22:34:17 +00: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.