Skip to main content

Configure BuildNinja Agent

Set up the Agent to connect with the server, execute assigned build jobs, and report results. The agent acts as the execution node in the CI/CD process, running builds, tests, and deployment tasks as configured by the server.

Configure Agent using Installers

  1. Open the BuildNinjaAgent.exe file to run the installer.

  2. Navigate to Installation Settings.

    build-ninja-agent-installer-installation-settings-icon

  3. Check and update the following details as needed:

    • Agent Name: Name used to identify the agent. The default value is System-NameBuildNinjaAgent.
    • Agent Port: Port number used by the agent. The default value is 9500.
    • Server Url: Address of the BuildNinja Server. The default value is http://127.0.0.1:8800.
    • Self Url: Address used by the agent to communicate with the server. The default value is http://127.0.0.1:9500.

    build-ninja-agent-installer-installation-settings

  4. Click Save to save your installation settings.

    build-ninja-agent-installer-installation-settings-save-button

  5. Click Install to start the installation.

    build-ninja-agent-installer-install-button

    After successful installation, an Installation Completed message appears, and the agent automatically attempts to register itself with the server using the provided details. If the registration is successful, the server UI displays the agent in the Agents agents-icon section.

    build-ninja-agent-installer-installation-completed-message

    configured-agent

    info

    For instructions on authorizing the agent, see Authorize Agent.

Configure Agent using Binary Files

  1. Define the environment variables that control how the agent identifies itself, communicates with the server, and stores data locally. For details on supported variables and how to set them up, see Set Up on Windows.

    agent-env-variables

  2. Run the bn_agent_windows.exe file included in the package to register the agent with the server. The agent automatically attempts to register using the provided details. If registration is successful, the server UI displays the agent under the Agents agents-icon section.

    configured-agent

    info

    For instructions on authorizing the agent, see Authorize Agent.