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

Files

Thomas Eizinger e2dce710f1 refactor: tidy up docker-compose.yml (#10334 )

Our `docker-compose.yml` file has grown to a degree where it is almost
unmanageable. Docker compose offers several tools to deal with complex
compose setups, like include files and yaml anchors.

We refactor our setup using these tools to organise these services and
their configuration a bit better.

2025-09-15 03:37:39 +00:00

build

chore(ci): downgrade runners to free tier (#10248 )

2025-08-26 10:48:45 -07:00

compose

refactor: tidy up docker-compose.yml (#10334 )

2025-09-15 03:37:39 +00:00

nix

refactor(connlib): simplify IpPacket struct (#9795 )

2025-07-29 04:42:57 +00:00

router

ci: prevent packet reordering by router containers (#10328 )

2025-09-11 06:54:05 +00:00

tests

fix(relay): handle relay-relay candidate pairs in eBPF (#10286 )

2025-09-11 07:19:23 +00:00

upload

ci: Add fixes for upload script (#7588 )

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

bump-versions.sh

chore: publish apple-client 1.5.8 (#10323 )

2025-09-10 17:06:40 +00:00

create-publish-pr.sh

ci: automatically create PR after publishing release (#9556 )

2025-06-18 06:17:18 +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(docs): use sha256sum over sha256 (#9690 )

2025-06-27 20:08:41 +00:00

gateway-systemd-install.sh

fix(gateway): bump timeoutstart to 15s (#9685 )

2025-06-26 14:19:44 +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.