firezone

(★ 9,040)

Enterprise-ready zero-trust access platform built on WireGuard®.

Showing a partial file list — download the zip above to see everything.

  • .dockerignore
  • .gitattributes
  • .gitignore
  • .prettierignore
  • .prettierrc.json
  • .tool-versions
  • CLAUDE.md
  • docker-compose.yml
  • flake.lock
  • flake.nix
  • LICENSE
  • mise.lock
  • mise.toml

# Installation Guide

1. Get the code
git clone https://github.com/firezone/firezone

Downloads the entire project code from GitHub to your computer.

cd firezone

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose up -d --build

Builds and starts all defined containers (server, database, etc.) at once, in the background.

Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Gradle (Java/Kotlin)

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java/Kotlin projects.
  • Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd kotlin/android/app

This project's files live in a subfolder, so move into it first.

./gradlew build

Builds the project using Gradle.

A BUILD SUCCESSFUL message means it worked. The output is created under build/.

4. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd elixir/assets

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

5. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
cd rust

This project's files live in a subfolder, so move into it first.

cargo build --release

Compiles the Rust project.

cargo run

Builds and then immediately runs the program.

If cargo build finishes without errors, it worked. The executable is created under target/.
// repository documentation