Installation

Flux is distributed as a lightweight, single-binary application. It has no external dependencies (like Java, Python, or Node.js), making installation straightforward on any operating system.

You can install Flux by downloading a pre-compiled binary or by building it directly from the source code.

Download the latest version

The easiest way to get started is to download the latest release for your platform from our GitHub repository.

  1. Visit the Releases Page: Go to https://github.com/otaleghani/flux/releases/latest

  2. Select your Platform: Look for the asset that matches your operating system and CPU architecture:

    • macOS (Apple Silicon/M1/M2): flux_darwin_arm64
    • macOS (Intel): flux_darwin_amd64
    • Linux (Standard Servers): flux_linux_amd64
    • Windows: flux_windows_amd64.exe

  3. Make it Executable (Linux/macOS only): After downloading, you may need to grant the file execution permissions. Open your terminal and run:

# Example for Linux
chmod +x flux_linux_amd64
# Rename it to 'flux' for easier usage
mv flux_linux_amd64 flux

Build from source

If you prefer to compile the code yourself or need to run Flux on a specific architecture not listed in the releases, you can build it from source.

Prerequisites:

  • Go 1.25+ installed on your machine.
  • Git to clone the repository.

Build Steps:

  1. Clone the repository:
git clone [https://github.com/otaleghani/flux.git](https://github.com/otaleghani/flux.git)
cd flux
  1. Download dependencies:
go mod tidy
  1. Compile the binary:
# This creates a 'flux' binary in your current directory
go build -o flux cmd/flux/main.go

Verifying the Installation

To verify that Flux is installed correctly, run the binary from your terminal.

flux

If successful, you should see logs indicating that the Flux HTTP server and SSH interface have started. Use Ctrl+C to stop the server.

Next Step: Now that Flux is installed, proceed to 02 Configuration to set up your environment variables and first form.