Amexcess

Installation Guide

Welcome to the Amexcess ISP Portal. Our enterprise installer automates the entire deployment process, ensuring your system is securely configured and ready for production in minutes.

Prerequisites

Before running the installer, ensure your environment meets the following requirements:

Hardware Recommendations

Minimum Specifications: 2 CPU Cores, 2 GB RAM, 20 GB SSD (Ideal for testing or very small deployments). Note: The installer will automatically provision a 2GB virtual memory swap if less than 2GB RAM is detected.

Recommended Specifications: 4 CPU Cores, 8 GB RAM, 50 GB NVMe/SSD (Ideal for standard production deployments with active RADIUS and telemetry databases).

High-Performance Specifications: 8+ CPU Cores, 16+ GB RAM, 100+ GB NVMe (Ideal for large ISPs with high-frequency OLT monitoring and thousands of concurrent PPPoE sessions).

Operating System: A fresh Ubuntu or Debian server.

Network: An active internet connection.

Privileges: You must run the installer as root or a user with sudo access.

Domain Name: A valid domain name pointed to your server's IP address (unless you plan to use an Amexcess-provided subdomain).

Firewall / Ports: You must ensure the following ports are open on your server's firewall (or cloud provider security group) for incoming traffic:

  1. 80 (TCP) - HTTP traffic and Let's Encrypt SSL provisioning
  2. 443 (TCP/UDP) - Secure HTTPS and HTTP/3 traffic
  3. 1812, 1813 (UDP) - RADIUS authentication and accounting
  4. 2785 (TCP) - (Optional) If you plan to use the local WhatsApp Gateway

Running the Installer

To begin the installation, execute the provided installation command on your server terminal:

curl -sSL https://amexcess.me/install -o install && chmod +x install && ./install

(Note: If you have the standalone executable, simply run ./install as a superuser.)

Step-by-Step Installation Process

The installer is interactive and will guide you through several configuration phases. Here is what to expect:

1. System Preparation & Resource Check

The installer will first verify that you have administrative privileges. It will then analyze your server's memory resources. If your server has less than 2GB of RAM, the installer will automatically provision a 2GB virtual memory swap space to guarantee platform stability.

2. Dependency Resolution

The installer will automatically download and configure all necessary system dependencies and runtime environments required by the ISP Portal. No manual package management is needed on your part.

3. Subscription Authentication

You will be prompted to authenticate your account:

  1. Amexcess Account Email: Enter the email address associated with your Amexcess subscription. The installer will contact the central server to verify an active plan.

4. License Validation

  1. Amexcess Software License Key: Provide your valid license key. The system will bind this license to your server's IP address and download the necessary cryptographic tokens required for the application to function. It will also securely download your Cloud Notifications (Firebase) credentials.

5. Domain and SSL Configuration

The system will check your license for an assigned domain type:

  1. Provided Subdomain: If your license includes an Amexcess subdomain, the system will automatically configure it and provision the necessary DNS records.
  2. Custom Domain: If you are using your own domain, you will be prompted to enter it (e.g., portal.myisp.com). The installer will verify that your domain's DNS records correctly point to your server's IP. Once verified, a Let's Encrypt SSL/TLS certificate will be automatically generated to secure your traffic.

6. Database and Gateway Configuration

You will be asked to configure optional integrations:

  1. Telemetry Database: You can choose to deploy a local telemetry database or connect to an external cloud database instance.
  2. WhatsApp Gateway: You will have the option to install the integrated local WhatsApp messaging gateway for customer communications.

7. Credential Generation and Orchestration

In the final step, the installer works silently in the background to:

  1. Generate highly secure, randomized passwords for all internal databases.
  2. Create secure application encryption keys.
  3. Write your localized environment configurations.
  4. Initialize all platform services, prepare the databases, and run necessary data migrations.

Completion

Once the process finishes, the installer will display a success message along with your initial Admin Login Credentials.

You can then open your web browser, navigate to your configured domain, and log in to begin managing your ISP network