Aetheris documentation

Aetheris is an enterprise billing and virtualization management platform that converges WHMCS, FOSSBilling, Pterodactyl Panel, Proxmox VE and VirtFusion into a single control panel: one billing engine, one client portal and one set of hypervisor drivers, with total admin control and dynamic whitelabeling.

Need this in another language? Use the language selector in the top navigation bar to auto-translate the documentation. Available in English, Italian, Spanish, French, German, Portuguese and more.

Download

The Windows Installer is distributed from the GitHub Releases feed of the aetheris-windows-installer repository:

curl -L -o aetheris-windows-installer.exe ^
  https://github.com/aetheris-project/aetheris-windows-installer/releases/latest/download/aetheris-windows-installer.exe

PowerShell:

Invoke-WebRequest -Uri https://github.com/aetheris-project/aetheris-windows-installer/releases/latest/download/aetheris-windows-installer.exe -OutFile aetheris-windows-installer.exe

You can also install it directly with winget:

winget install AetherisProject.AetherisWindowsInstaller

The source code of every component lives under the aetheris-project (opens in a new tab) organization; clone any repository with git clone https://github.com/aetheris-project/<repo>.git.

Getting started

• Installation guide - per-OS deployment on Linux, Windows and macOS, automated and manual paths.
• System requirements - minimum and recommended hardware for development and production.
• Automated installer - archinstall-style TUI wizard and non-interactive --yes mode with native service generation.
• Windows Installer - the native Windows installer (winget): dependencies, Docker stack, uninstall and packaging.
• Environment variables - every .env variable the platform reads.
• Upgrades - the supported upgrade path, verification checklist and rollback procedure.

Platform setup

• Linux setup - production deployment on Ubuntu/Debian.
• Windows setup - Docker Desktop, winget or native.
• macOS setup - Homebrew, launchd and dev setup.
• Docker deployment - fastest path on any OS.
• Reverse proxy - Nginx and Caddy with TLS.
• SSL / TLS - certificate provisioning and renewal.
• Database - PostgreSQL setup, SQLite for demos.
• Redis - queue and cache configuration.
• Prisma - migrations, schema and studio.
• Ports and networking - all TCP ports used by the stack.

Architecture and platform

• Architecture - components, data flow, scaling topologies and failure domains.
• Python backend - the REST API, its data model and how to run it standalone.
• Admin panel - overview of the admin control panel.
• Client portal - the customer-facing dashboard.
• User management - users, roles and permissions.
• API authentication - login, tokens and roles.
• Server provisioning - how servers are created.
• Node management - hypervisor nodes and telemetry.
• Cron jobs - scheduled background tasks.
• SFTP users - file access management.
• VNC console - real-time terminal access.
• Webhooks - outbound event notifications.
• Logging - where to find logs for each service.

Billing

• Billing engine - invoicing, VAT, coupons, provider webhooks, dunning and refunds.
• Billing plans - create and manage hosting plans.

Hypervisors

• Pterodactyl bridge - Application and Client API configuration, node synchronization and daemon requirements.
• Proxmox VE setup - API v2 credentials, storage and template configuration.
• VirtFusion setup - REST API credentials and VM provisioning.

Customization

• Theming and whitelabeling - dark / light / system themes and runtime accents.
• Dynamic whitelabeling - runtime branding without rebuilds.
• Game hosting - the game catalog, the Pterodactyl eggs and how servers are ordered and provisioned.
• Modules and integrations - extend the platform with modules and integrations beyond themes.
• Integration store - free ready-made integrations, i.e. the accepted pull requests in the addons repository.
• Custom adapter SDK - implement a new hypervisor backend against the driver contract.

Operations

• Security - credential encryption, authentication, RBAC and the hardening checklist.
• Backup and restore - what to back up, how to schedule it and the recovery runbooks.
• Monitoring and operations - health endpoints, logs, metrics and alerting.
• Updates - how to update Aetheris.
• Troubleshooting - the most common problems and their fixes.

Reference

• Development - repository layout, local setup, code conventions and the release workflow.
• REST API reference - the complete OpenAPI-based API documentation.
• OpenAPI specification (opens in a new tab) - machine-readable API contract.
• Glossary - the terms used across the platform.

Contributing

Aetheris is an open-source project and we welcome contributions. All improvements go through Pull Requests with automated CI checks (lint, typecheck, build, tests) before manual review by @Leo-Galli.

• Contributing guide - how to submit PRs and what to expect
• CONTRIBUTING.md (opens in a new tab) - detailed guidelines

Support

For commercial support, licensing questions, custom integrations or partnerships, write to hello@another-horizon.eu. Bug reports and feature requests belong on the issue trackers of the individual repositories under the aetheris-project (opens in a new tab) organization.