Documentation

Getting Started

1. Registration

First, create an account on our cloud platform. You will be assigned a unique Organization ID.

Register here

During login, you can optionally enable Two-Factor Authentication (2FA) for enhanced account security. We also offer granular Role-Based Access Control (RBAC), allowing you to define precise permissions for every system function and user.

2. Installing the Agent

Once registered, you can install the agent on any Linux server (Ubuntu, Debian, CentOS, RHEL). The installation script handles dependencies automatically.

curl -sSL https://app.unixai.org/download/agent.sh | sudo bash -s -- --organization-id YOUR_ORG_ID

Replace YOUR_ORG_ID with the ID found in your dashboard settings.

Dashboard Overview

The main dashboard provides a birds-eye view of your infrastructure. You can see real-time metrics for CPU, Memory, Disk I/O, and network activity.

The Explorer panel on the left allows you to organize your fleet. You can create Datacenters and Machine Groups to structure your servers logically. To interact with or view details for any specific server or group, simply click on it in the Explorer tree.

AI Command Execution

Interact with your servers using natural language. The "Execute" tab provides a chat interface where you can ask the agent to perform tasks.

Example prompts:

• "Find the process consuming the most memory and kill it."
• "Check if the Nginx service is running and restart it if not."
• "List all large files in /var/log."

Open Terminal

For direct, low-level access, use the Open Terminal feature. This opens a fully interactive session to your server directly in the browser, functioning equivalently to a standard SSH connection.

Advanced AI Planning

For complex tasks, the AI doesn't just execute commands blindly. It enters a Planning Mode to create a structured execution strategy.

Key Features

• Sequential vs. Parallel: The AI intelligently determines if tasks must be run in order (e.g., install -> config -> restart) or can run simultaneously to save time.
• Stop on Failure: You can configure the plan to halt immediately if a critical step fails (stop_on_failure: true), preventing cascading errors.
• Clarification: In "Deep Planning Mode", the AI will ask you questions to validate assumptions before generating any commands.

Monitoring Checks

Create custom monitoring scripts without writing code. Describe what you want to check, and the AI will generate the Bash or Python script for you.

AI Analyze for Alarms

When a monitoring check triggers an alarm (Warning or Critical), you can use the AI Analyze feature. The AI will examine the check's output and system context to diagnose the root cause and suggest immediate remediation steps.

Predictive Analytics

The system includes built-in Predictive Monitoring capabilities enabled by default. Using advanced algorithms, the agent analyzes historical telemetry data to forecast future resource usage and prevent outages.

Algorithms Used

• Linear Regression (Disk Usage): Analyzes disk fill rates over the last 30 days to predict exhaustion.
  • CRITICAL: Predicted to fill within 7 days.
  • WARNING: Predicted to fill within 14 days.
• Holt's Linear Trend (CPU & Memory): Uses exponential smoothing to detect saturation trends over the last 7 days.
  • CRITICAL: Forecast > 95% saturation.
  • WARNING: Forecast > 85% (CPU) or > 90% (Memory).

No additional configuration is required; these checks run automatically in the background.

AI Documentation

Keep your infrastructure documentation in sync with reality. The AI Documentation feature automatically discovers installed packages, network configurations, running services, and more.

It then synthesizes this raw data into a structured, easy-to-read Markdown document, covering everything from OS details to Nginx vhost configurations. You can view, export, or regenerate this documentation directly from the dashboard to ensure you always have an up-to-date reference.

SSL Discovery

The agent automatically scans for and inventories SSL certificates on your servers, helping you prevent expirations and maintain security.

How it Works

A specialized discovery script scans common certificate locations (e.g., /etc/ssl/certs, /etc/nginx, /etc/apache2) and parses .pem, .crt, and .cer files.

It extracts key details:

• Common Name (CN)
• Issuer
• Expiration Date
• Associated Service (inferred from path, e.g., Nginx, Apache)

Security Scanning

Ensure compliance with OpenSCAP. The agent can run scans against profiles like PCI-DSS or HIPAA and report vulnerabilities.

Ansible Automation

Generate Ansible playbooks for complex deployments. The AI ensures idempotency and follows best practices.

AI Map

Visualize your entire infrastructure topology in real-time. The AI Map provides an interactive graph view of all connected nodes, their relationships, and current status, allowing for quick identification of network bottlenecks and structural dependencies.

Agent Auto-Update

The agent is designed to be self-maintaining. It automatically checks for updates every 5 minutes.

Update Process

1. Check: The agent polls the central server for a new version.
2. Download: If an update is found, it securely downloads the package over HTTPS.
3. Verify & Install: Dependencies are checked, and the package is installed.
4. Restart: The agent restarts itself to apply the changes seamlessly.

Note: The agent uses a jitter mechanism (random delay) on startup and reconnection to prevent "thundering herd" issues on the server.

Bug Reporting

Encountered an issue? You can report bugs directly from the dashboard or API.

Requirements

• Format: Only image files (screenshots) are accepted.
• Limit: Maximum 5 files per report.
• Size: Total combined size must not exceed 20MB.

Reports are automatically sent to our support team with diagnostic context.

Bring Your Own Key (BYOK)

For maximum privacy and control, you can use your own AI provider API key (e.g., OpenRouter, OpenAI).

This ensures that:

• Usage is billed directly to your account.
• You can use custom models not provided in the default tier.
• Your data is processed under your own API agreement.

The key is encrypted at rest using Fernet encryption before being stored in the database.

Troubleshooting

Agent not connecting?

• Check if the service is running: systemctl status ai-linux-agent
• View logs: journalctl -u ai-linux-agent -f
• Ensure outbound traffic to port 443 is allowed.