Getting Started
The setup can be performed by following the steps on hercules-ci.com instead.
You may either follow this guide step by step, or use parts of it as reference for the setup process.
Step 1. GitHub
-
Click Sign in on the top right of hercules-ci.com and follow the steps.
-
Click Add GitHub repositories, organizations near the top of the dashboard.
-
GitHub will give you a choice to install the application on all repositories, which includes repositories to be created in the future, or to select specific repositories. We recommend that you make a selection of repositories, assuming not all your repositories have suitable Nix expressions. Follow the steps.
| Hercules CI will automatically pick up permissions from GitHub. Collaborators will find the repositories they have access to when they sign in. |
Step 2. Deploy Agent
To start building you need to deploy an agent first.
The agent adds itself to a cluster by means of a cluster join token. This token corresponds to a GitHub user or organization. The same token may be used to add multiple agents.
|
When updating the cluster join token on a previously deployed agent, remove the |
Choose one of the deployment options:
-
Deploy with Terraform, for a wide range of cloud support
-
Deploy with NixOps, for provisioning NixOS machines
-
Deploy with NixOS, for existing machines or custom deployment tools
-
Deploy with nix-darwin, the recommended configuration management tool for macOS
-
Install manually, when the other methods are not suitable
Step 3. Repository Setup
The goal of this step is to make sure everything is set up correctly.
-
If you are familiar with Nix, set up your own git repository
-
Otherwise verify your agent setup with a minimal git repository