Prerequisites

Before you begin, ensure you have:
  • Linux server with root access and public IP address
  • Open ports on firewall for 80 (TCP), 443 (TCP), 51820 (UDP), and 21820 (UDP for clients)
Recommended: Ubuntu 20.04+ or Debian 11+ for best compatibility and performance.

Choose Your Server

Need help choosing? See our complete VPS guide for suggestions.

DNS & Networking

Before installing Pangolin, ensure you’ve opened the required port on your firewall. See our guide on DNS & networking for more information.

Installation Process

1

Download the installer

Connect to your server via SSH and download the installer:
curl -fsSL https://digpangolin.com/get-installer.sh | bash
The installer supports both AMD64 (x86_64) and ARM64 architectures.
2

Run the installer

Execute the installer with root privileges:
sudo ./installer
The installer places all files in the current directory. Move the installer to your desired installation directory before running it.
3

Do you already have credentials from the dashboard?

If you are on your game and have already generated credentials for this node in the dashboard enter them here.
If you don’t have them yet you can just select no when asked and we will create it in a later step.
4

The public addressable IP address for this node

Enter either the public IP address of your server or a domain name that resolves to it.If you choose to use a domain keep in mind this just resolves your node on the internet while the actual subdomains for resources will be managed in the cloud.
5

Generate credentials

If you did not enter credentials earlier then you should see something like the following:
Your managed credentials have been obtained successfully.
        ID:     he4g78wevj25msf
        Secret: n7sd18twfko0q0vrb7wyclqzbvvnx1fqt7ezv8xewhdb9s7d
Go to the Pangolin dashboard and log in. Navigate to the “Self-hosted” section and add a new node. Use this ID and secret to register your node.
More than one account can use the same node credentials. This is useful for teams.

Post-Installation Setup

Once installation completes successfully, you’ll see:
Installation complete!
Navigate to the Pangolin dashboard and create sites, resources, and targets for your managed node.