Skip to content

Integration Examples

Practical examples for quickly setting up your service for Mole.

Example Subscription Server Response (Clash)

proxies:
  - name: "Mole Reality DE"
    type: vless
    server: de.example.com
    port: 443
    uuid: your-uuid
    network: tcp
    udp: true
    tls: true
    flow: xtls-rprx-vision
    servername: de.example.com
    reality-opts:
      public-key: your-public-key
      short-id: your-short-id
    client-fingerprint: chrome

import urllib.parse

def generate_mole_link(sub_url, name):
    encoded_url = urllib.parse.quote(sub_url)
    encoded_name = urllib.parse.quote(name)
    return f"mole://subscription/add?url={encoded_url}&name={encoded_name}"

print(generate_mole_link("https://provider.com/sub/123", "My VPN"))

Example Headers (Nginx)

location /sub {
    add_header subscription-userinfo "upload=0; download=0; total=107374182400; expire=1735689600";
    add_header profile-title "Premium VPN";
    add_header profile-announce "Welcome to Mole!";
    proxy_pass http://backend_sub_service;
}