Documentation

menu

Getting Startedshare

garnix offers multiple, integrated services for your GitHub repos:

  • CI: build software and run test-suites
  • Hosting, deploy NixOS configurations to the garnix cloud
  • Actions: run Nix apps (with access to the internet)

garnix is based on the package manager Nix to define what's being built, run and deployed. The following sections walk you through how to get started:

  1. Install nix
  2. Install the garnix GitHub app on your GitHub repo(s)
  3. Add a flake file to your repo
  4. Push commits to your GitHub repo

garnix is designed to require only minimal configuration and has sensible defaults. So for basic usecases, adding a flake.nix file is configuration enough. (For more control, you can add a garnix.yaml configuration file.)