Prerequesites

The Fire CI agent can be installed on Windows, Mac or Linux.

The agent needs git and docker to be installed. Here are the relevant links

The agent will clone your repositories using the SSH protocol so you need to have a SSH key registered in GitHub for the computer you are installing the agent on.

To download the agent just sign up to Fire CI and you'll get a download link right afterwards.


Linux Specific

The agent is distributed using AppImage format under Linux. See How to use AppImage for a guide.

Regarding docker, here is a great installation guide for Ubuntu (steps 1, 2 and 3) and here are some post installation required steps.

Docker installation is fairly well documented for all Linux distributions. If you need help just contact us at support@fire.ci


Installation step by step

The agent installation uses a simple .exe file for Windows and .pkg file for Mac.

The agent automatically starts to run after the installer is finished on Mac and Windows. For Linux you need to make the AppImage file executable and then run it.

Once the agent starts the first step is to pair the agent with your account:

The code to pair the agent with your account is available in your dashboard in the section "Your agent":

Just copy the code into the agent and click "Link Agent". The agent will try to detect git and docker.

Detection is rather simple: the tools need to be in the PATH for your current user. If git or docker is not installed you need to install them. Here are the links to install git and docker for windows or docker for mac.

If git and docker are installed and the agent does not find them it will ask for the path to the binary. For example if you have git installed in a funny location like /Users/me/funny/git then enter this full path when the agent asks for it. On Windows enter the path with the *.exe extension, for example "C:\Program Files\git\bin\git.exe".

Once pairing and tools detection is out of the way you will be presented with a quick tutorial to get hands with the agent. The tutorials consists on forking our hello world repository, install the Fire CI app on it, and push an empty commit to see the build in action:

That's it. From there you just need to attach the "Fire CI" GitHub App to your other repositories and define your build pipelines.


What next?

The next step is to define your build pipelines. Checkout the resources below:


We are striving for an intuitive and turn key setup so you can already signup and follow the agent installation process. Documentation might not be that needed after all.

If you have questions or ideas do not hesitate to contact us at support@fire.ci.