Skip to main content

Installation and Setup Guide

Database Agent Installation Screen

Pre-requisites​

Account and Permissions Requirements​

  1. Authnull Account: An active Authnull account with administrative privileges
  2. Operating System Administrator: root or sudo privileges on the Linux host
  3. Database Administrator: Privileges to create a dedicated native database user

Host System Requirements​

  1. Operating System: Debian-based Linux distribution (Ubuntu, Debian)
  2. Resources:
    • CPU: Minimum 1-2 vCPUs
    • RAM: Minimum 2-4 GB RAM
    • Disk Space: Minimum 10-20 GB free space
  3. System Utilities: curl, sudo, chmod, and package manager (e.g., apt)

Network Requirements​

  1. Agent to Authnull Cloud Platform: Outbound HTTPS (TCP port 443)
  2. Client Applications to ProxySQL: Access to ProxySQL listener port (default: 6033)
  3. ProxySQL to Target Database(s): Network connectivity to database ports
  4. Firewall Rules: Configured to allow required traffic

Installation Steps​

1. Navigate to Database Agent Installation​

  1. Log in to Authnull Platform dashboard
  2. Click on "Databases" in the sidebar
  3. Click "+ Install Database Agent"

2. Download and Prepare Installation Files​

  1. Download Installation Script:

    sudo curl -L -o run_agent.sh https://raw.githubusercontent.com/authnull/windows-endpoint/mysql-db-agent/agent_installer.sh

  2. Set Execute Permissions:

    sudo chmod +x run_agent.sh

  3. Download Configuration File:

    • Click "Download db.env" in the UI
    • Save to the same directory as run_agent.sh

3. Execute Installation​

sudo ./run_agent.sh

4. Verify Installation​

  1. Check Agent Logs:

    tail -f /var/log/authnull-db-agent.log

  2. Expected Log Output:

    • Agent startup messages
    • Configuration loading
    • Connection to Authnull Cloud
    • Successful registration message

  3. Finalize in UI:

    • Return to Authnull UI
    • Click "Finish" to complete installation

Post-Installation Verification​

Database Dashboard Overview​

The dashboard provides:

  • Total Databases count
  • Active Connections
  • Virtual Machines (VM Agents)
  • Total Tables

Viewing Database Instances​

  1. Click "View all databases"
  2. Database details show:
    • Database Name
    • Type
    • Host
    • Port
    • Status
    • Created At

Quick Actions Available​

  • View Users
  • Grant Access
  • View Tables