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

Files

Reactor Scram 74a81b2a56 test(gui-client): unit test for Linux IPC (#4277 )

(After GA)

This adds a unit test for the Unix domain sockets that I intend to use
for process splitting on Linux.

The length-prefixed encoding and decoding are copied from `subzone`, but
most of that code will not be re-used since it's Windows-specific and
also specific to a Chromium-like process model, which won't work for
Firezone.

2024-04-02 19:34:24 +00:00

build

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

2024-04-02 16:59:29 +00:00

nix

feat(snownet): timeout connections if we don't receive a candidate within 10s (#3790 )

2024-03-09 08:03:57 +00:00

tests

test(gui-client): unit test for Linux IPC (#4277 )

2024-04-02 19:34:24 +00:00

gateway-docker-upgrade.sh

chore(ci): enforce shellscript formatting and style (#3679 )

2024-02-21 01:01:32 +00:00

gateway-systemd-install.sh

fix(gateway): Fix systemd gateway install script (#4407 )

2024-03-31 15:56:24 +00:00

Makefile

chore(connlib): Remove atomicwrites and tokio::fs from apple compile path (#4395 )

2024-03-29 21:01:53 +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.