Live Infrastructure Across Europe • Portugal • Finland • Bulgaria
Digital Frontier
Docs
//gateway

Quick Start Guide

Get started with DigitalFrontier Gateway in minutes

Docs are being migrated. These are the getting-started guides. Product names have been updated to DigitalFrontier, but the SDK, CLI and config identifiers in code samples still reference their current names — we publish the surface that actually exists rather than a renamed one. The full API reference is being moved to its own documentation site.

Gateway is in preview. The @digitalfrontier/cli package is not published yet, so the commands below describe the intended flow rather than one you can run today. Talk to us if you want access while Gateway is in preview.

Do not run the install commands below yet. These package names are not reserved, so anything currently published under them is not ours. They document the intended flow; we will announce when they are real.

Get your first DigitalFrontier Gateway instance up and running in minutes.

Prerequisites

Before you begin, ensure you have:

  • A DigitalFrontier Core account with active subscription
  • DigitalFrontier CLI installed (npm install -g @digitalfrontier/cli)
  • Basic understanding of VoIP or edge networking concepts
  • A SIP trunk provider (optional, for PSTN connectivity)

Installation

Install DigitalFrontier CLI

npm install -g @digitalfrontier/cli

Authenticate

df login

Follow the prompts to authenticate with your DigitalFrontier Core account.

Your First Gateway

1. Initialize Gateway Configuration

Create a new gateway configuration file:

df gateway init

This creates a gateway.yaml file with default configuration:

version: 1

gateway:
  name: my-first-gateway

  sip:
    port: 5060
    tls_port: 5061
    domain: gateway.example.com

  media:
    rtp_port_range: 10000-20000
    codecs:
      - opus
      - g722
      - pcmu

  regions:
    - us-east-1
    - eu-west-1

  routing:
    strategy: least-cost
    failover: true

2. Deploy Gateway

Deploy your gateway to the edge:

df gateway deploy --config gateway.yaml

The CLI will:

  1. Validate your configuration
  2. Provision edge infrastructure
  3. Configure routing and networking
  4. Deploy your gateway instances

3. Verify Deployment

Check gateway status:

df gateway status my-first-gateway

You should see output like:

Gateway: my-first-gateway
Status: RUNNING
Regions: us-east-1, eu-west-1
Endpoints:
  - sip.us-east-1.gateway.example.com:5060
  - sip.eu-west-1.gateway.example.com:5060
Health: OK
Uptime: 2m 34s

Test Your Gateway

Make a Test Call

Use a SIP client to test connectivity:

# Using sipml5 or similar SIP client
sip:test@sip.us-east-1.gateway.example.com:5060

Monitor Call Metrics

View real-time metrics:

df gateway metrics my-first-gateway --live

Configure Routing

Add SIP Trunk

Connect a SIP trunk for PSTN calling:

# gateway.yaml
routing:
  - match:
      prefix: "+1"  # North America
    route:
      - provider: "twilio"
        trunk_uri: "sip:trunk.twilio.com"
        credentials:
          username: "ACxxxxxx"
          password: "your-auth-token"
        priority: 1

Apply the changes:

df gateway update my-first-gateway --config gateway.yaml

Next Steps

Now that you have a basic gateway running:

Troubleshooting

Gateway won't start

Check logs for errors:

df gateway logs my-first-gateway --tail 100

Can't connect via SIP

Verify firewall rules allow SIP traffic:

  • Port 5060 (UDP/TCP) for SIP
  • Port 5061 (TCP) for SIP over TLS
  • Ports 10000-20000 (UDP) for RTP media

Poor call quality

Check network metrics:

df gateway metrics my-first-gateway --filter network

Look for high jitter or packet loss.

Getting Help

Previous
DigitalFrontier Gateway