Pangolin

Key Features

Reverse Proxy Through WireGuard Tunnel

• Expose private resources on your network without opening ports (firewall punching).
• Secure and easy to configure site-to-site connectivity via a custom user space WireGuard client, Newt.
• Built-in support for any WireGuard client.
• Automated SSL certificates (https) via LetsEncrypt.
• Support for HTTP/HTTPS and raw TCP/UDP services.
• Load balancing.

Identity & Access Management

• Centralized authentication system using platform SSO. Users will only have to manage one login.
• Define access control rules for IPs, IP ranges, and URL paths per resource.
• TOTP with backup codes for two-factor authentication.
• Create organizations, each with multiple sites, users, and roles.
• Role-based access control to manage resource access permissions.
• Additional authentication options include:
  • Email whitelisting with one-time passcodes.
  • Temporary, self-destructing share links.
  • Resource specific pin codes.
  • Resource specific passwords.

Simple Dashboard UI

• Manage sites, users, and roles with a clean and intuitive UI.
• Monitor site usage and connectivity.
• Light and dark mode options.
• Mobile friendly.

Easy Deployment

• Run on any cloud provider or on-premises.
• Docker Compose based setup for simplified deployment.
• Future-proof installation script for streamlined setup and feature additions.
• Use any WireGuard client to connect, or use Newt, our custom user space client for the best experience.

Modular Design

• Extend functionality with existing Traefik plugins, such as CrowdSec and Geoblock.
  • Automatically install and configure Crowdsec via Pangolin’s installer script.
• Attach as many sites to the central server as you wish.

Software Included

Creating an App using the Control Panel

Click the Deploy to DigitalOcean button to create a Droplet based on this 1-Click App. If you aren’t logged in, this link will prompt you to log in with your DigitalOcean account.

Creating an App using the API

In addition to creating a Droplet from the Pangolin 1-Click App using the control panel, you can also use the DigitalOcean API. As an example, to create a 4GB Pangolin Droplet in the SFO2 region, you can use the following curl command. You need to either save your API access token) to an environment variable or substitute it in the command below.

curl -X POST -H 'Content-Type: application/json' \
         -H 'Authorization: Bearer '$TOKEN'' -d \
        '{"name":"choose_a_name","region":"sfo2","size":"s-2vcpu-4gb","image": "sharklabs-pangolin"}' \
        "https://api.digitalocean.com/v2/droplets"

Getting Started After Deploying Pangolin

Deployment Steps

1. Create a Droplet from the Marketplace

1. Log in to your DigitalOcean account.
2. Navigate to the Marketplace and search for “Pangolin”.
3. Click on the Pangolin 1-Click App.
4. Configure your Droplet:
   • Choose a plan (recommended: at least 1GB RAM, but it can also be deployed on DigitalOcean’s smallest droplet size: $4 s-1vcpu-512mb-10gb)
   • Select a datacenter region
   • Add SSH keys for authentication
   • Choose a hostname (e.g., pangolin-server)
5. Click “Create Droplet”.

2. DNS Configuration

Before proceeding with setup, you need to configure your domain to point to your new Droplet:

1. Obtain your Droplet’s IP address from the DigitalOcean control panel.
2. Go to your domain registrar or DNS provider.
3. Create an A record that points your domain or subdomain to your Droplet’s IP address.

   Type: A
   Name: pangolin (or @ for root domain)
   Value: your_droplet_ip
   TTL: 3600 (or as low as possible for faster propagation)

4. Wait for DNS propagation (can take 5 minutes to several hours).

3. Initial Setup

1. Once your Droplet is created, connect to it via SSH:

   ssh root@your_droplet_ip

2. The first-login setup script will run automatically, guiding you through the initial configuration:

   • Enter your domain name
   • Provide your email for SSL certificates
   • The script will run the Pangolin installer

3. After the installer completes, you’ll be able to access the Pangolin dashboard.

4. Dashboard Setup

1. Open a web browser and navigate to https://your-domain.com.
2. Follow the on-screen instructions to:
   • Create an admin account
   • Set up your organization
   • Configure your first site