Hub.ai logo

Hub.ai

Introduction

Welcome to Hub.ai! Our platform is designed to provide developers with a powerful yet straightforward way to create, manage, and interact with Virtual Machines (VMs) and Linux Containers (LXC). Whether you're looking to quickly spin up an environment for development, testing, hosting personal projects, or exploring new technologies, Hub.ai offers the flexibility and control you need.

You can create standalone resources, choosing your preferred operating system and resource allocation, and access them directly via our integrated web terminal. Hub.ai also allows you to easily manage web hosting for your applications through our "Sites" feature, enabling you to configure reverse proxies and custom domains.

Core Concepts

Understanding these fundamental concepts will help you make the most of Hub.ai.

Resources (Containers & VMs)

Hub.ai allows you to run your applications and workloads in two types of isolated environments: Virtual Machines (VMs) and Containers (LXC).

A Virtual Machine (VM) emulates a physical computer, running its own complete operating system (e.g., Linux variants like Ubuntu, Debian, including desktop versions) and having dedicated virtualized hardware resources (CPU, RAM, Disk). VMs offer strong isolation.

A Container (LXC - Linux Container) is a lighter-weight virtualization method sharing the host system's Linux kernel. Containers provide isolated user-space environments, making them faster to start and more resource-efficient for many use cases.

You create resources directly, choosing their type, OS, and resources. Each resource provides an isolated environment for your work, which can then be exposed to the web via the "Sites" feature.

Resource Pools

A Resource Pool is an organizational unit that groups related VMs, containers, and sites together. Resource pools help you:

  • Organize resources by project, environment, or purpose
  • Manage permissions and access control (future feature)
  • Track resource usage and costs by pool
  • Simplify resource management for complex infrastructure

Each user starts with a default resource pool, and you can create additional pools as needed. Resources must belong to a pool, and pools can be deleted only when empty.

Sites (Web Hosting & Reverse Proxies)

A Site on Hub.ai represents a web hosting configuration that makes your application, running on a Resource (VM or Container), accessible via the internet. This typically involves setting up a reverse proxy that directs traffic from a public domain (or a Hub.ai subdomain) to a specific port on your resource.

Through the "Sites" feature, you can manage domain names, configure SSL certificates (often automated), and define how incoming web traffic is routed to your running applications.

Background Jobs

Background Jobs handle long-running operations asynchronously, providing real-time progress updates. Common job types include:

  • VM and container creation
  • Resource updates and modifications
  • Site creation and management
  • System maintenance tasks

When you initiate these operations, Hub.ai creates a background job that you can monitor through the job status indicator in the header or via the API. Jobs provide step-by-step progress updates and handle errors gracefully.

Getting Started

Sign In / Sign Up

To begin using Hub.ai, you need an account. Navigate to the Sign In / Sign Up page where you have multiple options for authentication.

Authentication Methods

Hub.ai supports multiple authentication methods for your convenience:

  • OAuth Providers:
    • Google Account - Sign in with your Google account for quick access
    • GitHub Account - Perfect for developers, integrates seamlessly with infrastructure management
  • Email/Password:
    • Create a traditional account with email and password
    • Access the registration form at Sign Up
    • Password reset functionality available if needed

After initial registration, you can link additional authentication methods in your Account settings under "Connected Accounts".

Platform Navigation

Once logged in, the main navigation header provides access to key sections:

  • Home: The main landing page with an overview of Hub.ai services.
  • Resources: Create, view, and manage your Containers and VMs.
  • Sites: Manage your web hosting configurations and reverse proxies.
  • Docs: (You are here) Access this documentation.
  • Account: Manage your profile, preferences, billing, and API keys.
  • Background Jobs: Monitor active operations via the job indicator in the header (appears when jobs are running).

Creating Your First Resource

Here's a quick guide to creating your first resource on Hub.ai:

  1. Add Credits: Before creating resources, ensure you have credits in your account. Visit Account to check your balance and top up if needed. New users often receive promotional credits.
  2. Navigate to Resources: Go to Resources page.
  3. Choose Resource Type:
    • Click "Create Container" for a lightweight, fast-starting environment
    • Click "Create Virtual Machine" for full OS isolation and more control
  4. Configure Your Resource:
    • Enter a descriptive nickname
    • Select an operating system template
    • Choose resource allocation (CPU, RAM, Disk) using the sliders
    • Review the estimated hourly cost
  5. Monitor Creation: After clicking "Create", a background job starts. You can monitor progress through:
    • The job indicator in the header
    • The progress modal that appears
    • Real-time status updates showing each creation step
  6. Access Your Resource: Once created, you can:
    • Launch the Web Terminal to access the command line
    • View connection details and resource information
    • Start configuring your applications

Managing Resources (Containers & VMs)

Resources (Containers and VMs) are the core compute environments. The Resources page is your central place to view and manage them.

Resource Types & Specifications

Hub.ai offers various resource sizes for Containers and VMs. The table below provides an illustrative overview. Actual costs are dynamically calculated on the creation pages and are subject to change. Containers generally offer better resource efficiency.

Resource Size vCPUs RAM Disk VM Credits / Hour (Illustrative) Container Credits / Hour (Illustrative) Description
Micro11 GB10 GB~0.0125~0.0063 Very small static sites, simple APIs, minimal tasks.
Small24 GB25 GB~0.05~0.025 Small web apps, blogs, dev/staging.
Medium48 GB50 GB~0.1125~0.0563 Moderate-traffic web apps, APIs.
Large816 GB100 GB~0.25~0.125 High-traffic apps, complex computations.
X-Large1632 GB200 GB~0.56~0.28 Demanding apps, databases. GPU option for VMs (feature coming soon, requires ≥24GB RAM).
XX-Large1664 GB400 GB~1.27~0.635 High-performance needs. GPU option for VMs (feature coming soon, requires ≥24GB RAM).
  • vCPU (Virtual Central Processing Unit): Processing power.
  • RAM (Random Access Memory): Working memory.
  • Disk: Persistent storage.
  • Credits / Hour: Estimated cost, billed per minute of active runtime. Container costs are typically lower than VMs for similar raw specs. See Billing & Credits.
  • GPU Note: The option to add a GPU (e.g., RTX 4090) to VMs is a feature planned for future availability and is currently disabled in the creation forms. When available, it will require sufficient RAM (e.g., 24GB+) and will incur additional costs.

Choosing the Right Resource Type

  • VM vs. Container: Containers for efficiency and speed if full OS isolation isn't critical. VMs for maximum isolation or specific kernel needs.
  • Start Small: Begin with smaller resources and scale as needed.
  • Resource Needs: Consider memory for data/users, CPU for computation, and disk for storage.
  • Cost: Balance performance with your budget.

Resource Pools

Resource pools are organizational containers that group your VMs, containers, and sites together. Key features:

  • Default Pool: Every user starts with a default resource pool
  • Creating Pools: Create additional pools via the Resources page or API
  • Pool Management:
    • Name and organize pools by project or environment
    • View all VMs, containers, and sites within a pool
    • Track usage and costs per pool
    • Delete empty pools when no longer needed
  • Resource Assignment: When creating a VM, container, or site, select which pool it belongs to
  • Sites Within Pools: Sites are created within pools and can only route traffic to VMs/containers in the same pool

Resource pools help maintain organization, especially when managing multiple projects or environments. Sites created within a pool can route traffic to any VM or container within the same pool.

Resource Management Actions (Start/Stop/Delete/Terminal)

From the Resources list or individual resource detail pages, you can:

  • Start: Powers on a stopped resource, resuming credit consumption and making it accessible.
  • Stop: Powers off a running resource, stopping credit consumption for runtime. Disk storage persists.
  • Restart: Power-cycles a running resource.
  • Delete: Permanently removes the resource and all associated data. This action is irreversible and requires confirmation.
  • Launch Terminal: Access the resource's command line directly through our secure Web Terminal.
  • Launch AI Assistant: Open the Hub Chat for AI-powered assistance related to your resource.

Viewing Resource Details

Clicking "Manage" for a resource shows its details page:

  • ID, Name, Status, Type (Container/VM), OS, Region (for VMs).
  • IP Address(es), MAC Address (for VMs).
  • Resource Allocation (CPU, Memory, Storage).
  • Creation Date.
  • SSH Credentials (for VMs, displayed on the detail page for use with the Web Terminal).
  • Estimated hourly pricing for the current configuration.
  • (Future) Detailed monitoring metrics, network settings.

Creating Standalone Resources

You can create standalone Containers or VMs directly from the Resources page by clicking "Create Container" or "Create Virtual Machine". This allows you to:

  1. Provide a name for your resource.
  2. Select an Operating System (e.g., Ubuntu, Debian, including desktop variants for VMs).
  3. Configure resources (vCPUs, RAM, Storage) using interactive sliders.
  4. View real-time cost estimations as you configure.
  5. Launch the resource. For VMs, a progress display will show creation steps.

Once created, you can access your resource via the Web Terminal for manual setup and configuration.

Resource Limits & Quotas

Hub.ai enforces resource limits to ensure fair usage and platform stability. Your limits depend on your account type and may include:

  • VM Limits:
    • Maximum number of VMs (typically 10-50)
    • Maximum cores per VM (up to 32)
    • Maximum RAM per VM (up to 64GB)
    • Maximum disk per VM (up to 1TB)
  • Container Limits:
    • Maximum number of containers (typically 20-100)
    • Maximum cores per container (up to 16)
    • Maximum RAM per container (up to 32GB)
    • Maximum disk per container (up to 500GB)
  • Other Limits:
    • Maximum resource pools (typically 5-10)
    • Maximum sites (typically 50-200)
    • Total resource usage across all instances

View your current limits and usage in your Account page or via the MCP API using the user_limits tool.

Monitoring Creation Progress

Resource creation is handled asynchronously through background jobs. When you create a VM or container:

  1. Job Creation: A background job is created upon submission
  2. Progress Tracking: Monitor progress through:
    • Job Indicator: Appears in the header when jobs are active
    • Progress Modal: Shows detailed step-by-step progress
    • Status Updates: Real-time updates for each creation phase
  3. Creation Steps (VMs):
    • Allocating resources
    • Creating VM instance
    • Installing operating system
    • Configuring network
    • Setting up SSH access
    • Running post-installation scripts
  4. Creation Steps (Containers):
    • Allocating resources
    • Creating container
    • Configuring network
    • Starting container
    • Running initialization scripts
  5. Completion: Resource becomes available with status "running"
  6. Error Handling: If creation fails, the job shows error details and cleanup is automatic

Background jobs ensure the UI remains responsive during long-running operations and provide transparency into the creation process.

Managing Sites

The "Sites" feature in Hub.ai allows you to make your applications running on Resources (VMs or Containers) accessible on the internet. Sites are created within Resource Pools and can route traffic to any VM or container within the same pool. This involves configuring a reverse proxy to route traffic from a domain name to your resource.

Overview

Navigate to the Sites tab on the Resources page to view and manage your site configurations. Sites are organized by Resource Pool. Each site configuration links a domain (either a Hub.ai subdomain or your custom domain) to a specific port on one of your resources within the same pool.

Creating a New Site

  1. Go to the Sites tab on the Resources page and click "Create New Site". Select the Resource Pool where you want to create the site.
  2. Domain Configuration:
    • Choose to use a Hub.ai provided subdomain (e.g., your-site.hub.ai-app.com).
    • Or, specify your own custom domain (e.g., www.yourdomain.com). You will need to configure DNS records (like A or CNAME records) with your domain registrar to point to Hub.ai's infrastructure. Instructions are typically provided.
  3. Target Resource & Port:
    • Select the Resource (VM or Container) from within the same pool that is running your application.
    • Specify the port on that resource where your application is listening (e.g., port 80, 3000, 8080).
  4. SSL/TLS: SSL certificates are often automatically provisioned and renewed by Hub.ai for your sites, providing HTTPS.
  5. Confirm and create the site. It may take a few moments for the configuration to propagate.

Configuring an Existing Site

From the Sites tab, you can manage existing sites within each pool:

  • View Details: See the current configuration (domain, target resource/port).
  • Edit Configuration: Modify the target resource, port, or potentially other proxy settings.
  • Manage Custom Domain: Update DNS instructions or verify domain ownership.
  • Enable/Disable: Temporarily activate or deactivate the site's routing.
  • Delete Site: Remove the site configuration. This does not delete your resource, only the web routing to it.

Custom Domains

Hub.ai supports both single and multiple custom domains per site:

  • Primary Domain: The main domain for your site
  • Additional Domains: Add multiple domains or subdomains pointing to the same site
  • DNS Configuration: Hub.ai provides DNS record values (A records or CNAME records) to configure with your registrar
  • Domain Verification: Domains are verified automatically once DNS propagation completes
  • Propagation Time: DNS changes typically take minutes to hours to propagate globally

Route Rules

Advanced routing configuration allows fine-grained control over how traffic is handled:

  • Path-based Routing: Route different URL paths to different ports or resources
  • Header-based Rules: Route based on HTTP headers
  • Redirect Rules: Set up permanent or temporary redirects
  • Rewrite Rules: Modify URLs before forwarding to your application
  • Load Balancing: Distribute traffic across multiple resources (future feature)

SSL Certificates

Hub.ai provides automatic SSL certificate management:

  • Automatic Provisioning: SSL certificates are automatically obtained via Let's Encrypt
  • Auto-Renewal: Certificates renew automatically before expiration
  • HTTPS Enforcement: Option to redirect all HTTP traffic to HTTPS
  • Custom Certificates: Support for uploading your own SSL certificates (enterprise feature)
  • Wildcard Support: Wildcard certificates for subdomain coverage (when applicable)

Sync Status

Sites have a sync status indicator showing the configuration state:

  • Synced: Configuration is active and working correctly
  • Pending: Configuration changes are being applied
  • Error: Configuration issues need attention (e.g., resource offline, port unreachable)
  • Skipped: Site is disabled or configuration was skipped

The sync status helps you quickly identify and troubleshoot site configuration issues.

The Sites feature simplifies exposing your backend services or web applications to the public internet securely and with professional-grade features.

Interactive Tools

Hub.ai provides powerful interactive tools to help you manage and get assistance with your resources directly through your web browser.

Web Terminal

The Web Terminal gives you direct command-line access to your running Resources (both VMs and Containers). This is invaluable for manual configuration, software installation, troubleshooting, and running specific commands within your resource's environment.

Accessing the Web Terminal

You can launch the Web Terminal for a specific resource:

  • From the Resources list page, by clicking the "Terminal" action button for the desired resource.
  • From an individual resource's detail page, by clicking the "Launch Terminal" button.
Features
  • Full Shell Access: Provides a fully functional terminal interface powered by xterm.js, connected via a secure WebSocket.
  • AI Command Generation: Describe what you want to do in natural language and get the exact command to execute.
  • AI Text Explanation: Select any terminal output text to get instant AI-powered explanations of what it means.
  • Resource Context: When launched, the terminal is automatically connected to the selected resource. The terminal interface often displays the name or ID of the connected resource.
  • VM Credentials: For Virtual Machines, if SSH password authentication is configured by Hub.ai, the necessary username and password may be displayed or automatically used by the terminal session for quick access.
  • Real-time Interaction: Execute commands and view output in real-time, just as you would with a local terminal or SSH client.
Use Cases
  • Installing or updating software packages.
  • Editing configuration files.
  • Viewing application logs directly on the resource.
  • Running diagnostic commands.
  • Performing ad-hoc administrative tasks.

AI Chat Assistant (Hubert)

Hubert, the Hub.ai Chat Assistant, is an advanced LLM-powered Linux administration tool designed to help you efficiently configure and manage your Virtual Machines (VMs) and Containers. Think of Hubert as an expert AI system administrator available directly within your resource's context.

Accessing the AI Chat Assistant
  • You can launch Hubert from an individual resource's detail page by clicking the "AI Assistant" or "Chat" button. This provides Hubert with the necessary context about the specific resource you are working with (like its OS and type), enabling it to perform targeted administrative tasks and provide relevant assistance. The chat is exclusively available within the context of a specific resource.
Key Capabilities
  • Goal-Oriented Configuration: Tell Hubert what you want to achieve (e.g., "set up a web server," "install a database," "check disk usage"), and it will work to accomplish that goal on your resource.
  • Direct Command & Script Execution: Hubert can run commands and execute scripts directly on your Linux resource to perform tasks.
  • Interactive Diagnostics: Ask Hubert to check system status, diagnose problems, or retrieve specific information from your resource (e.g., "Is Nginx running?", "What's my current CPU usage?", "Show me the last 10 lines of the system log").
  • Command & Scripting Assistance: If you're unsure how to perform a task, Hubert can help you formulate the necessary Linux commands or even generate small scripts to automate operations.
  • Software Management: Instruct Hubert to install, update, or remove software packages.
  • Service Management: Ask Hubert to start, stop, restart, or check the status of services on your resource.
  • File System Operations: Request Hubert to create directories, list files, check permissions, etc. (Use with caution for write operations).
  • Multi-Step Operations: Hubert can handle sequences of tasks, like "Install a web server, then configure it to serve files from /var/www/html."
  • Context-Aware: Hubert utilizes information about your resource's OS and type to tailor its actions and commands.
  • Clear Communication: Hubert translates technical outcomes into human-readable status updates and can present tabular data (like process lists or resource usage) in a clear Markdown table format.
Example Interactions
  • "Install Nginx on this VM."
  • "What's the status of the `my-app.service`? If it's not running, please try to start it."
  • "Show me the current disk space usage, sorted by size."
  • "Help me write a bash script to find all `.log` files in `/var/log` modified in the last 24 hours."
  • "Configure the firewall to allow traffic on port 8080."
  • "What version of Python is installed? If it's not Python 3.9 or higher, please install the latest Python 3."

Hubert aims to simplify Linux administration by allowing you to manage your resources using natural language instructions, backed by intelligent command execution and analysis.

Management Console

The Management Console is Hub.ai's advanced administrative interface designed for power users who need comprehensive control over their cloud infrastructure. This IDE-like environment provides a unified workspace for managing all your resources, monitoring operations, and accessing advanced features.

Overview

The Management Console offers a professional-grade interface inspired by modern development environments like Visual Studio Code. Key features include:

  • Unified Resource Management: View and manage all VMs, containers, and sites from a single interface
  • Multi-Tab Interface: Work with multiple resources simultaneously in separate tabs
  • Tree-Based Navigation: Hierarchical organization of resources by pools
  • Real-Time Updates: Live status updates for resources and background jobs
  • Advanced Terminal Features: Multiple terminal sessions, session recording, and playback
  • VNC Remote Desktop: Graphical desktop access for VMs with desktop environments
  • Integrated Dashboards: Visual analytics and resource utilization monitoring
  • Keyboard Shortcuts: Efficient navigation and control through keyboard commands

Access the Management Console at /manage/ after signing in to your account.

Navigation & Interface

The Management Console uses a three-panel layout optimized for productivity:

Layout Components
  • Left Panel - Resource Tree:
    • Hierarchical view of all resource pools, VMs, containers, and sites
    • Search functionality to quickly find resources
    • Context menus for resource actions (right-click)
    • Collapsible/expandable tree nodes
    • Visual status indicators (running, stopped, error states)
    • Drag-to-resize or fully collapse with Ctrl+B
  • Center Panel - Tab Container:
    • Multiple tabs for concurrent resource management
    • Tab types: VM details, container details, terminals, VNC, dashboards, sites
    • Draggable tab reordering
    • Close individual tabs or use "Close All" options
    • Tab icons indicate resource type and status
    • Middle-click to close tabs quickly
  • Top Bar - Controls:
    • File menu with global actions and settings
    • View mode selector (Detailed vs Sessions view)
    • Quick access buttons for dashboards and terminal sessions
    • Refresh button for manual tree updates
    • Search field for filtering resources
File Menu Options

The File menu provides quick access to key features:

  • Settings: Configure console preferences and display options
  • Terminal Sessions: View and manage all active terminal connections
  • Console Archive: Access historical terminal session recordings
  • Resource Pools Dashboard: Open the unified dashboard view
  • Expand/Collapse All: Control tree visibility
  • Close Tab Options: Manage open tabs efficiently

Resource Tree

The Resource Tree is the primary navigation mechanism in the Management Console, providing a hierarchical view of your infrastructure:

Tree Structure
  • Resource Pools (Top Level):
    • Containers for organizing related resources
    • Shows pool name and resource counts
    • Expandable to reveal contained resources
  • Virtual Machines:
    • Icon indicates VM type and status
    • Shows VM name, OS, and specifications
    • Color coding: Green (running), Gray (stopped), Red (error)
    • Double-click to open details tab
  • Containers:
    • Lightweight resource indicators
    • Similar status visualization as VMs
    • Quick access to terminal and management
  • Sites:
    • Web hosting configurations within pools
    • Shows domain and target resource
    • Sync status indicators
Tree Interactions
  • Left Click: Select resource
  • Double Click: Open resource in new tab
  • Right Click: Context menu with actions:
    • Open Details
    • Launch Terminal
    • Launch VNC (for desktop VMs)
    • Start/Stop/Restart
    • Delete Resource
    • Copy Resource ID
  • Drag Tree Border: Resize tree panel width
  • Search: Filter resources by name or ID
View Modes
  • Detailed View: Full resource information with specifications
  • Sessions View: Simplified view focusing on active terminal sessions

Dashboard Views

The Dashboard provides comprehensive analytics and monitoring capabilities:

All Pools Dashboard

Accessible via the dashboard button or File menu, this view provides:

  • Statistics Grid:
    • Total resource counts (VMs, containers, sites)
    • Active vs stopped resources
    • Total allocated resources (CPU, RAM, storage)
    • Credit consumption rates
  • Resource Pools Table:
    • Excel-style sortable table
    • Columns: Pool name, VM count, container count, site count, status
    • Click headers to sort
    • Click rows to filter by pool
  • Resource Distribution Charts:
    • Visual representation of resource allocation
    • Pie charts for resource type distribution
    • Bar charts for usage trends
  • Quick Actions:
    • Create new resources directly from dashboard
    • Bulk operations on multiple resources
    • Export data to CSV
Single Pool Dashboard

When viewing a specific pool, additional details include:

  • Detailed resource listings within the pool
  • Pool-specific usage statistics
  • Site routing configurations
  • Network zone assignments
  • Pool management actions (rename, delete when empty)

Terminal Access

The Management Console provides enhanced terminal capabilities beyond the basic web terminal:

Terminal Features
  • Multiple Sessions:
    • Open multiple terminal tabs simultaneously
    • Each tab maintains independent session
    • Session persistence across tab switches
    • Automatic reconnection on network interruptions
  • Enhanced Terminal UI:
    • Full xterm.js integration with color support
    • Customizable font size and theme
    • Copy/paste support with clipboard integration
    • Search within terminal output (Ctrl+F)
    • Scrollback buffer with configurable size
  • Session Recording:
    • Automatic recording of all terminal sessions
    • Recordings saved for later playback
    • Useful for audit trails and debugging
  • Quick Commands:
    • Right-click context menu with common commands
    • Snippet library for frequently used commands
    • Command history across sessions
Terminal Session Management

Access the Terminal Sessions view to:

  • See all active terminal connections
  • Monitor session duration and activity
  • Terminate stuck or idle sessions
  • View session metadata (user, resource, start time)
  • Batch close multiple sessions

VNC Remote Desktop

For VMs with desktop environments installed, the Management Console provides VNC (Virtual Network Computing) access:

VNC Features
  • Browser-Based Remote Desktop:
    • No client software required
    • NoVNC technology for HTML5 canvas rendering
    • Supports Ubuntu Desktop, Debian Desktop, and other GUI distributions
  • Display Controls:
    • Adjustable resolution and color depth
    • Fullscreen mode (F11)
    • Zoom controls for scaling (Ctrl +/-)
    • Clipboard synchronization
  • Input Support:
    • Full keyboard mapping including special keys
    • Mouse tracking and click events
    • Touch device support for tablets
    • Drag and drop within remote desktop
  • Performance Options:
    • Compression settings for bandwidth optimization
    • Quality adjustments for slow connections
    • Local cursor rendering for responsiveness
VNC Requirements
  • VM must have a desktop environment installed
  • VNC server must be running on the VM (usually automatic for desktop templates)
  • Sufficient resources allocated (minimum 2GB RAM recommended for desktop)
  • VM must be in running state

Site Management

The Management Console provides advanced site management capabilities:

Site Manager Features
  • Visual Site Editor:
    • Drag-and-drop domain configuration
    • Visual routing rule builder
    • Real-time validation of configurations
    • SSL certificate status monitoring
  • Advanced Routing:
    • Path-based routing rules
    • Header-based routing conditions
    • Regular expression matching
    • Load balancing configuration (when available)
    • Fallback and error page settings
  • Domain Management:
    • Multiple domain aliases per site
    • Subdomain wildcard support
    • DNS record verification tools
    • WHOIS lookup integration
    • Domain transfer guidance
  • SSL/TLS Configuration:
    • Automatic Let's Encrypt certificate provisioning
    • Certificate renewal monitoring
    • Custom certificate upload
    • TLS version and cipher suite configuration
    • HSTS and security header management
  • Site Analytics:
    • Traffic statistics and graphs
    • Response time monitoring
    • Error rate tracking
    • Bandwidth usage reports

Console Archive

The Console Archive provides comprehensive session history and playback capabilities:

Archive Features
  • Session Recording Formats:
    • Plain Text: Clean output with ANSI codes removed
    • Raw ANSI: Complete terminal output with color codes
    • Asciicast: Timestamped recording for playback
  • Playback Controls:
    • Play/pause/seek through recordings
    • Adjustable playback speed (0.5x to 4x)
    • Jump to specific timestamps
    • Frame-by-frame stepping
  • Search and Filter:
    • Search within session content
    • Filter by date range
    • Filter by resource or user
    • Filter by session duration
  • Export Options:
    • Download sessions in multiple formats
    • Export as PDF for documentation
    • Share session links (with permissions)
    • Bulk export for compliance
  • Retention Policies:
    • Automatic cleanup of old sessions
    • Configurable retention periods
    • Important session flagging
    • Storage quota management
Use Cases
  • Debugging: Review exactly what commands were run during an incident
  • Audit Trail: Maintain compliance records of administrative actions
  • Training: Record and share terminal sessions for education
  • Documentation: Create tutorials from actual terminal sessions

Terminal Session Manager

The Terminal Session Manager provides centralized control over all active terminal connections:

Session Overview
  • Active Sessions Table:
    • Session ID and connection status
    • Connected resource (VM/container name and ID)
    • User and IP address
    • Session start time and duration
    • Data transfer statistics
    • Current activity indicator
  • Session Actions:
    • View live session (read-only monitoring)
    • Terminate individual sessions
    • Send messages to active sessions
    • Force disconnect idle sessions
  • Session Policies:
    • Maximum session duration limits
    • Idle timeout configuration
    • Concurrent session limits per user
    • Resource-based access controls

Settings & Preferences

The Management Console settings allow customization of the interface and behavior:

Display Settings
  • Theme: Dark or light mode (syncs with account preference)
  • Font Size: Adjustable for tree and terminal text
  • Tree Width: Default width for resource tree panel
  • Tab Behavior: Single vs double-click to open
  • Animation: Enable/disable UI animations
Terminal Settings
  • Font Family: Choose from monospace fonts
  • Cursor Style: Block, underline, or bar
  • Scrollback Buffer: Lines to keep in history
  • Bell Sound: Audio alert preferences
  • Copy on Select: Automatic clipboard copy
Performance Settings
  • Auto-refresh Interval: Tree update frequency
  • Max Open Tabs: Limit for resource usage
  • Cache Settings: Local storage preferences
  • WebSocket Keep-alive: Connection stability options

Keyboard Shortcuts

The Management Console supports extensive keyboard shortcuts for efficient navigation:

Global Shortcuts
  • Ctrl/Cmd + B: Toggle tree panel visibility
  • Ctrl/Cmd + K: Open command palette
  • Ctrl/Cmd + Shift + F: Focus search field
  • F5: Refresh current view
  • Ctrl/Cmd + R: Refresh resource tree
  • Escape: Close dialogs or cancel operations
Tab Navigation
  • Ctrl/Cmd + Tab: Cycle through tabs forward
  • Ctrl/Cmd + Shift + Tab: Cycle through tabs backward
  • Ctrl/Cmd + [1-9]: Jump to specific tab number
  • Ctrl/Cmd + W: Close current tab
  • Ctrl/Cmd + Shift + W: Close all tabs
  • Middle Click on Tab: Close tab
Tree Navigation
  • Up/Down Arrow: Navigate tree items
  • Left Arrow: Collapse node
  • Right Arrow: Expand node
  • Enter: Open selected resource
  • Space: Toggle node expansion
  • Ctrl/Cmd + A: Expand all nodes
  • Ctrl/Cmd + Shift + A: Collapse all nodes
Terminal Shortcuts
  • Ctrl/Cmd + C: Copy selected text (or interrupt command)
  • Ctrl/Cmd + V: Paste from clipboard
  • Ctrl/Cmd + F: Search in terminal output
  • Ctrl/Cmd + Plus: Increase font size
  • Ctrl/Cmd + Minus: Decrease font size
  • Ctrl/Cmd + 0: Reset font size
  • Alt + Enter: Toggle fullscreen
VNC Shortcuts
  • F11: Toggle fullscreen mode
  • Ctrl/Cmd + Alt + Shift: Release mouse capture
  • Ctrl/Cmd + Plus/Minus: Zoom in/out
  • Ctrl/Cmd + 0: Reset zoom

The Management Console represents Hub.ai's commitment to providing professional-grade tools for infrastructure management. Whether you're managing a single VM or orchestrating complex multi-resource deployments, the console provides the features and efficiency needed for effective cloud operations.

Account Management

The Account page provides several tabs for managing your profile and settings.

Profile Information

Update your display name. Your email address is linked to your sign-in provider (Google/GitHub) and is displayed for informational purposes.

Sign-In Method

This section displays the Google or GitHub account currently linked for signing into Hub.ai.

Preferences

  • Theme: Choose between Dark (default) and Light UI themes for the entire platform
  • Notifications: Enable or disable email notifications for important account and billing events
  • Default Settings: Configure default resource creation preferences

API Keys

Manage API keys for programmatic access to Hub.ai services:

  • Creating API Keys:
    • Click "Create New API Key" in the API Keys tab
    • Provide a descriptive name for the key
    • Select permissions (e.g., mcp.access for MCP API)
    • Copy the generated key immediately - it won't be shown again
  • Key Format:
    • MCP API keys use the prefix hub_api_
    • Standard API keys use the prefix hb_api_
    • Keys are unique identifiers tied to your account
  • Managing Keys:
    • View active API keys with creation dates
    • Revoke keys that are no longer needed
    • Monitor last used timestamps
    • Set expiration dates for temporary access
  • Security Best Practices:
    • Never share API keys or commit them to version control
    • Use environment variables to store keys in applications
    • Rotate keys regularly
    • Create separate keys for different applications

Security (Sign Out, Delete Account)

  • Sign Out: Securely sign out of your Hub.ai session on the current device.
  • Delete Account: Permanently delete your Hub.ai account and all associated data. This action is irreversible and requires confirmation by typing 'DELETE'.

Billing & Credits

Hub.ai operates on a flexible, pay-as-you-go credit system, managed via the Billing tab on your Account page.

The Credit System

  • 1 Credit is equivalent to $1.00 USD (this rate is subject to change).
  • Purchase credits upfront to fund your usage.
  • Running Container and VM resources consume credits based on their type, size (CPU, RAM, Disk), and active runtime duration. Billing is calculated per minute.
  • Stopping a resource halts credit consumption for its runtime. Disk storage costs are currently included with active runtime.
  • Your current credit balance is clearly displayed on the Account page.

Topping Up Credits

  • Add credits by selecting a predefined package (e.g., 10, 25, 50, 100 credits) or entering a custom amount (minimum 10 credits).
  • Complete your purchase securely via Stripe.
  • Credits are added to your balance upon successful payment.

Promo Codes & Offers

Hub.ai offers promotional codes and special offers to help you get started:

  • First-Time User Promotions:
    • New users may receive special discount codes (e.g., "FIRST50" for 50% off first purchase)
    • Promotional credits automatically applied to new accounts
    • Limited-time offers for early adopters
  • How to Use Promo Codes:
    • Enter the promo code during credit top-up
    • Discount is applied before payment
    • Some codes may have minimum purchase requirements
    • Codes are typically single-use per account
  • Types of Promotions:
    • Percentage discounts on credit purchases
    • Bonus credits (e.g., buy 50, get 10 free)
    • Seasonal and holiday specials
    • Referral bonuses through the affiliate program

Monitoring Usage

  • The Billing tab on your Account page provides "Top-up History" and "Usage History" tables.
  • These tables detail credit purchases, adjustments, and deductions for resource runtime, helping you track your spending.

Billing History

The "Top-up History" and "Usage History" tables provide a chronological log of all transactions affecting your credit balance, including timestamps, descriptions, amounts (for purchases), credit changes, and the resulting balance after each transaction.

Developer API & MCP

Hub.ai provides programmatic access to platform features through the Model Context Protocol (MCP), a standardized JSON-RPC 2.0 interface that enables LLMs and developers to manage cloud infrastructure.

MCP Overview

The Model Context Protocol (MCP) implementation at Hub.ai provides structured access to:

  • VM & Container Management: Create, start, stop, delete, and monitor virtual machines and containers
  • Remote File Operations: Read, write, edit files and execute commands via SSH
  • Site Management: Create and manage web hosting configurations with automatic SSL
  • Resource Pool Management: Organize and manage groups of resources
  • Background Job Tracking: Monitor asynchronous operations like resource creation

Hub.ai's MCP implementation includes:

  • 42 total tools for comprehensive infrastructure control
  • Full SSH access to execute commands and manage files on remote instances
  • Asynchronous operations with detailed job tracking
  • Resource limits management to monitor quotas and usage (including site limits)
  • Automatic SSL certificates for sites with custom domains

MCP is ideal for:

  • Building automation workflows
  • Integrating Hub.ai with AI assistants and LLMs
  • Creating custom management tools
  • Programmatic infrastructure management
  • CI/CD pipeline integration

For complete MCP documentation, see MCP Technical Documentation.

Quick Start

To get started with Hub.ai's MCP implementation:

  1. Get an API Key: Generate an MCP API key from your Account page. Keys must have the hub_api_ prefix.
  2. Connect to MCP: Use the endpoint POST https://hub.ai/mcp with JSON-RPC 2.0 protocol
  3. Initialize Session: Send an initialization request with your client information
  4. Call Tools: Use the tools/call method to execute operations

Example initialization:

POST https://hub.ai/mcp
Authorization: Bearer hub_api_your_key_here
Content-Type: application/json

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "initialize",
  "params": {
    "protocolVersion": "1.0",
    "clientInfo": {
      "name": "my-client",
      "version": "1.0.0"
    }
  }
}

Authentication

Hub.ai MCP supports two authentication methods:

API Key Authentication (Recommended)
  • Generate API keys from your account settings
  • Keys must have the hub_api_ prefix
  • Include the mcp.access permission
  • Use in the Authorization header: Authorization: Bearer hub_api_your_key
JWT Token Authentication
  • Use existing Hub.ai JWT tokens from web authentication
  • Provides full access based on user permissions
  • Same format: Authorization: Bearer eyJhbGci...

Available Tools

Hub.ai MCP provides 42 tools across these categories:

VM Management (8 tools)
  • vm_create: Create a new VM with custom specifications
  • vm_update: Update VM resources (CPU, RAM, disk)
  • vm_action: Start, stop, restart, or delete VMs
  • vm_list: List all VMs, optionally filtered by pool
  • vm_get: Get detailed VM information
  • vm_exec: Execute bash commands on VM via SSH
  • vm_create_job_details: Get VM creation job details
  • vm_update_job_details: Get VM update job details
  • vm_action_job_details: Get VM action job details
Container Management (8 tools)
  • container_create: Create a new container
  • container_update: Update container resources
  • container_action: Start, stop, restart, or delete containers
  • container_list: List all containers
  • container_get: Get detailed container information
  • container_exec: Execute bash commands on container via SSH
  • container_create_job_details: Get container creation job details
  • container_update_job_details: Get container update job details
  • container_action_job_details: Get container action job details
File Operations (8 tools)
  • file_read: Read file from VM/container via SSH
  • file_write: Write file to VM/container with sudo support
  • file_edit: Edit file with string replacement
  • file_multi_edit: Multiple edits in one atomic operation
  • file_ls: List directory contents
  • file_glob: Find files by pattern
  • file_grep: Search file contents with ripgrep
  • file_grep_raw: Raw ripgrep output for custom parsing
Site Management (12 tools)
  • site_create: Create a new site within a pool
  • site_domains_update: Update site custom domains
  • site_delete: Delete a site
  • site_sync: Force sync site configuration
  • site_rule_add: Add routing rule to direct traffic
  • site_rule_update: Update existing routing rule
  • site_rule_delete: Delete routing rule
  • site_list: List all sites
  • site_get: Get site details
  • site_create_job_details: Get site creation job details
  • site_update_job_details: Get site update job details
  • site_delete_job_details: Get site deletion job details
Job Management (5 tools)
  • job_status: Get job status for polling
  • job_wait: Wait for job completion with polling
  • job_result: Get completed job results
  • job_list_active: List all active jobs
  • job_list_by_resource: List jobs for a specific resource
Resource Management (4 tools)
  • pool_list: List resource pools
  • pool_get: Get pool details
  • template_list: List available OS templates
  • user_limits: Get user limits and usage

Examples

Creating a VM
{
  "jsonrpc": "2.0",
  "id": 2,
  "method": "tools/call",
  "params": {
    "name": "vm_create",
    "arguments": {
      "name": "web-server",
      "vcpu": 2,
      "ramGb": 4,
      "storageGb": 50,
      "osTemplateId": "ubuntu-22-04"
    }
  }
}
Executing Remote Commands
{
  "jsonrpc": "2.0",
  "id": 3,
  "method": "tools/call",
  "params": {
    "name": "vm_exec",
    "arguments": {
      "vmId": "vm_xyz789",
      "command": "apt update && apt install -y nginx",
      "timeout": 60000
    }
  }
}
Reading Remote Files
{
  "jsonrpc": "2.0",
  "id": 4,
  "method": "tools/call",
  "params": {
    "name": "file_read",
    "arguments": {
      "id": "container_def456",
      "path": "/etc/nginx/nginx.conf"
    }
  }
}
Monitoring Job Progress
{
  "jsonrpc": "2.0",
  "id": 5,
  "method": "tools/call",
  "params": {
    "name": "job_status",
    "arguments": {
      "jobId": "job_xyz789"
    }
  }
}

For more examples and detailed API reference, consult the full MCP documentation.

Troubleshooting & FAQ

  • My standalone resource isn't working as expected after creation.

    Access your resource via the Web Terminal from the Resources page. Check system logs (e.g., dmesg, journalctl, application-specific logs) for errors. Ensure your manual configuration and software installations were successful.

  • My Site isn't loading or shows an error.

    First, ensure your target Resource (VM/Container) is running and your application is listening on the correct port specified in your Site configuration. Check the resource's logs via the Web Terminal. Verify your domain's DNS settings are correctly pointing to Hub.ai if using a custom domain. Check the Sites page for any status messages related to your site configuration.

  • Why did my resource stop?

    It might have been stopped manually. Also, check your credit balance on the Account page; resources may be stopped if credits run out (this behavior will be clearly communicated if implemented).

  • How do I connect to my resource?

    Shell access to your resources (both VMs and Containers) is provided exclusively through our secure Web Terminal, accessible from the Resources page. For VMs, SSH credentials (username/password) generated by Hub.ai are displayed on the VM's detail page and can be used with the Web Terminal. Traditional direct SSH key-based access from your local machine is not the primary method of interaction.

  • MCP API returns authentication error (-32001)

    Ensure your API key has the correct hub_api_ prefix and includes the mcp.access permission. Check that the Authorization header is properly formatted: Authorization: Bearer hub_api_your_key.

  • MCP tool calls are failing with "Invalid params" error

    Verify that all required parameters are provided and match the expected types. For file operations, use id parameter for the VM/container ID and path for the file path. Check the MCP documentation for correct parameter names and types.

  • VM/Container creation via MCP is taking too long

    Resource creation is asynchronous. After calling vm_create or container_create, use the returned jobId with job_status to track progress. The resource is ready when status shows "completed".

  • Remote file operations via MCP are not working

    Ensure the resource is running (status: "running") before attempting remote operations. The id parameter must be a valid VM or container ID that you own. For vm_exec/container_exec commands, consider increasing the timeout parameter for long-running operations (up to 120000ms/2min by default).

Additional Resources

Find more information and support through these resources:

  • Frequently Asked Questions (FAQ): Comprehensive answers to common questions about Hub.ai services, pricing, and features
  • Contact Us: Get in touch with our support team for assistance or inquiries
  • Privacy Policy: Learn how we protect and handle your data
  • Terms of Service: Review our service terms and conditions
  • MCP Technical Documentation: Detailed API reference for developers
  • Community Resources:
    • GitHub discussions and issues
    • Developer forums
    • Video tutorials and guides
  • Status & Updates:
    • Platform status page
    • Feature announcements
    • Maintenance schedules