search
SupportDeveloper Docs

Running the agent

hashtag
Running the Agent

Before starting the service, ensure configuration is complete:

  1. Configure using TUI (recommended):

    & "C:\Program Files\BalkanID\ad-agent\BalkanID AD Agent.exe" --configure

    Complete all configuration steps, then exit the TUI.

  2. Or manually edit C:\ProgramData\BalkanID\ad-agent\config.yaml

The agent can be run in two different ways:

hashtag
I. Using the TUI (Terminal User Interface)

The TUI provides an interactive interface for monitoring and configuration:

  1. Launch TUI Mode: Run the following command in the terminal.

    & "C:\Program Files\BalkanID\ad-agent\BalkanID AD Agent.exe" --tui

  2. TUI Features:

    • Dashboard: View service status, connection status, and logs

    • Configuration Menu: Edit settings, test connections, regenerate API keys

    • Real-time Logs: Monitor agent activity

    • Keyboard Shortcuts:

      • C - Open Configuration Menu

      • R - Restart Server

      • Q - Quit

      • U - Check for Updates

  3. Exiting TUI:

    • Press Q to quit

    • The server will stop when you exit the TUI

hashtag
II. Running as Windows Service (Headless)

For production deployments, run the agent as a Windows service that operates in the background without a UI.

Service Behavior

When running as a service:

  • The agent runs in headless mode (no UI)

  • It automatically starts on system boot

  • Logs are written to C:\ProgramData\BalkanID\ad-agent\logs\

  • If Heartbeat Mode is enabled, it will:

    • Extract AD data every 2 hours

    • Process requests every 10 minutes

    • Upload data to BalkanID automatically

Step 1: Start the Service

The service should already be installed by install.ps1. Start it:

Step 2: Verify Service Status

Check that the service is running:

The status should show Running.

Step 3: Monitor Logs

View the service logs:

PreviousConfigurationNextService management and troubleshooting

Last updated

Was this helpful?