Installation

Installing CompassVPN

CompassVPN is designed to be easy to install and configure on your own VPS. Follow these guides to get started:

Requirements

Before installing CompassVPN, ensure your linux system meets the following requirements:

  • VPS Architecture: AMD64 or ARM64 (recommended: 2 vCPUs and 2GB RAM)

  • Supported Operating Systems:

    • Ubuntu (20.04 LTS or newer)
    • Debian (10 or newer)

    Note: CompassVPN is optimized for Ubuntu and Debian distributions to ensure stability and consistent user experience.

  • Required package: git & curl

  • Domain Name: A domain name is required for SSL certificate generation and secure access.

    • Must be a valid, registered domain on your Cloudflare account.
    • Recommended TLDs to purchase: .com, .org, .co, .net, .info, .ir, …
    • Low-level and free domains may be blocked by firewalls more quickly.

  • Update the system and install the required packages:

    sudo apt update -qq && sudo apt upgrade -yqq && sudo apt install -yqq curl git

    Note: A system reboot is recommended after this command.

You are now ready to begin the installation with the Quick Start Guide .

Quick Navigation

  1. Quick Start Guide
    • Get CompassVPN installed and running quickly.
  2. Configuration Guide
    • Learn how to tailor CompassVPN configuration to your requirements.
  3. Manager Setup
    • Set up the manager for performance metrics and monitoring dashboards.