Arcturus ArcIn Connector Agent -- release cac61af-dirty
Built: 2026-05-08T06:03:38Z

================================================================
CONTENTS
================================================================
  bin/arcin-agent-windows-amd64.exe   Windows x86_64 binary
  bin/arcin-agent-linux-amd64         Linux x86_64 binary
  bin/arcin-agent-linux-arm64         Linux ARM64 binary
  bin/arcin-agent-darwin-amd64        macOS Intel binary
  bin/arcin-agent-darwin-arm64        macOS Apple Silicon binary
  scripts/install-agent-windows.ps1   Windows installer (run as Administrator)
  scripts/uninstall-agent-windows.ps1 Windows uninstaller (run as Administrator)
  scripts/configure-mysql.ps1         Windows: add a MySQL data source
  scripts/diagnose-agent-windows.ps1  Windows: troubleshooting / connectivity check
  scripts/install-agent-linux.sh      Linux installer (run as root)
  configs/agent.example.yaml          Full config reference (comments only)

================================================================
WINDOWS - QUICK START
================================================================

STEP 1 -- Extract the zip
  Extract to any folder, e.g. C:\arcin-connector\

STEP 2 -- Run the installer
  Open PowerShell as Administrator (right-click -> Run as Administrator):

    powershell -ExecutionPolicy Bypass -File C:\arcin-connector\scripts\install-agent-windows.ps1

  This installs:
    - Binary  : C:\Program Files\ArcInAgent\arcin-agent.exe
    - Config  : C:\ProgramData\ArcInAgent\agent.yaml
    - Logs    : C:\ProgramData\ArcInAgent\logs\agent.log
    - Service : ArcInAgent (Windows Service, auto-start)

STEP 3 -- Edit the config file
  Open in Administrator Notepad:

    notepad C:\ProgramData\ArcInAgent\agent.yaml

  Replace the three REPLACE_ME values:

    agent:
      customer_id: "YOUR_CUSTOMER_ID"              <- given by Arcturus

    control_plane:
      url: "wss://YOUR_GATEWAY_HOST:8443/connect"  <- given by Arcturus
      token: "YOUR_AGENT_TOKEN"                    <- given by Arcturus

  The sources block is pre-configured for MySQL (see Step 4 for the DSN).

STEP 4 -- Set the MySQL DSN environment variable
  Run in Administrator PowerShell (replace with your real DB credentials):

    [Environment]::SetEnvironmentVariable(
      "ARCIN_SOURCE_MYSQL_PROD_DSN",
      "db_user:db_password@tcp(your-mysql-host:3306)/your-database?parseTime=true",
      "Machine")

STEP 5 -- Start the service

    Start-Service ArcInAgent
    Get-Service ArcInAgent          # should show: Status = Running

STEP 6 -- Verify

    Get-Content C:\ProgramData\ArcInAgent\logs\agent.log -Tail 20

  Healthy output:
    [INFO] arcin-agent starting
    [INFO] registered source  (source_id=mysql-prod, type=mysql)
    [INFO] dialing control plane
    [INFO] session established      <- end-to-end connectivity confirmed

----------------------------------------------------------------
WINDOWS - ADD ANOTHER MYSQL SOURCE
----------------------------------------------------------------
  Run in Administrator PowerShell:

    powershell -ExecutionPolicy Bypass `
      -File C:\arcin-connector\scripts\configure-mysql.ps1 `
      -SourceId  "mysql-analytics" `
      -MySqlHost "your-host" `
      -MySqlPort 3306 `
      -MySqlUser "readonly_user" `
      -MySqlPass "password" `
      -MySqlDb   "database_name"

----------------------------------------------------------------
WINDOWS - UNINSTALL
----------------------------------------------------------------
  # Remove everything
    powershell -ExecutionPolicy Bypass -File C:\arcin-connector\scripts\uninstall-agent-windows.ps1

  # Remove everything but keep agent.yaml
    powershell -ExecutionPolicy Bypass -File C:\arcin-connector\scripts\uninstall-agent-windows.ps1 -KeepConfig

----------------------------------------------------------------
WINDOWS - TROUBLESHOOTING
----------------------------------------------------------------
  # Run full diagnostic (connectivity, config, logs)
    powershell -ExecutionPolicy Bypass -File C:\arcin-connector\scripts\diagnose-agent-windows.ps1

  # View logs
    Get-Content C:\ProgramData\ArcInAgent\logs\agent.log -Tail 50

  # Restart service
    Restart-Service ArcInAgent

================================================================
LINUX - QUICK START
================================================================

STEP 1 -- Extract the zip
  unzip arcin-connector-fixed.zip -d arcin-connector
  cd arcin-connector

STEP 2 -- Run the installer

    chmod +x scripts/install-agent-linux.sh
    sudo ./scripts/install-agent-linux.sh

  This installs:
    - Binary  : /usr/local/bin/arcin-agent
    - Config  : /etc/arcin-agent/agent.yaml
    - Logs    : /var/log/arcin-agent/agent.log
    - Service : arcin-agent (systemd, auto-start)
    - User    : arcin-agent (system user, no login)

STEP 3 -- Edit the config file

    sudo nano /etc/arcin-agent/agent.yaml

  Replace the three REPLACE_ME values:

    agent:
      customer_id: "YOUR_CUSTOMER_ID"              <- given by Arcturus

    control_plane:
      url: "wss://YOUR_GATEWAY_HOST:8443/connect"  <- given by Arcturus
      token: "YOUR_AGENT_TOKEN"                    <- given by Arcturus

  The sources block is pre-configured for MySQL (see Step 4 for the DSN).

STEP 4 -- Set the MySQL DSN environment variable
  Add to the systemd service (replaces env var for the service user):

    sudo systemctl edit arcin-agent

  Add these lines in the editor that opens:

    [Service]
    Environment="ARCIN_SOURCE_MYSQL_PROD_DSN=db_user:db_password@tcp(your-mysql-host:3306)/your-database?parseTime=true"

  Save and close (Ctrl+O, Enter, Ctrl+X in nano).

STEP 5 -- Start the service

    sudo systemctl daemon-reload
    sudo systemctl start arcin-agent
    sudo systemctl status arcin-agent     # should show: Active = running

STEP 6 -- Verify

    sudo tail -f /var/log/arcin-agent/agent.log

  Healthy output:
    {"level":"INFO","msg":"arcin-agent starting"}
    {"level":"INFO","msg":"registered source","source_id":"mysql-prod"}
    {"level":"INFO","msg":"dialing control plane"}
    {"level":"INFO","msg":"session established"}    <- end-to-end confirmed

----------------------------------------------------------------
LINUX - USEFUL COMMANDS
----------------------------------------------------------------
  # View logs live
    sudo journalctl -u arcin-agent -f
    sudo tail -f /var/log/arcin-agent/agent.log

  # Restart service
    sudo systemctl restart arcin-agent

  # Stop service
    sudo systemctl stop arcin-agent

  # Disable auto-start
    sudo systemctl disable arcin-agent

  # Uninstall (manual)
    sudo systemctl stop arcin-agent
    sudo systemctl disable arcin-agent
    sudo rm /etc/systemd/system/arcin-agent.service
    sudo rm /usr/local/bin/arcin-agent
    sudo rm -rf /etc/arcin-agent
    sudo rm -rf /var/log/arcin-agent
    sudo userdel arcin-agent
    sudo systemctl daemon-reload

================================================================
VERIFICATION (any platform)
================================================================
  Binary version check:
    Windows : & "C:\Program Files\ArcInAgent\arcin-agent.exe" --version
    Linux   : /usr/local/bin/arcin-agent --version

  Expected output:
    arcin-agent cac61af-dirty

================================================================
SUPPORT
================================================================
  Contact your Arcturus representative.
  For gateway URL, customer_id, and agent token -- contact Deepak.
