Installation and Requirements

Intended Deployment Model

n8n-nodes-sip-pbx is designed for self-hosted n8n.

It is not a simple stateless webhook node. The package runs a daemon-backed runtime that keeps live SIP dialogs, RTP/media workers, queue state, and WebSocket sessions alive outside a single node execution.

Installation

Install it from the n8n Community Nodes UI:

1. Open your self-hosted n8n instance.
2. Go to Settings -> Community Nodes.
3. Choose Install.
4. Enter n8n-nodes-sip-pbx.

Supported Runtime Targets

The published package ships native prebuilds for:

• linux-x64-glibc
• linux-x64-musl
• linux-arm64-glibc
• linux-arm64-musl

Practical implication:

• Linux is the supported target for production use.
• You should treat the package as a Linux-hosted telephony runtime unless you are intentionally doing development work around native builds.

Network and Environment Checklist

Before building workflows, make sure you understand which side owns which connection.

For trunk-based SIP

You need:

• a reachable SIP server or carrier
• correct server, port, and authentication in the SIP Connection credential
• network rules that allow SIP signaling and RTP/media traffic

For extension registration

You need:

• a stable Extensions Ref
• extension numbers and passwords or a workflow-based auth design
• a bind IP/port plan for the built-in registrar endpoint

For queue workflows

You need:

• at least one Queue Event trigger
• at least one Extension Event trigger in the same workflow if queue operators are internal extensions
• operator extension numbers configured on the queue trigger

For WebSocket and AI legs

You need:

• a workflow that creates a WebSocket dial leg
• provider credentials for OpenAI Realtime or Gemini Live, or a generic wss:// endpoint
• a clear plan for who starts the provider session: Immediate or Deferred

First Workflow Checklist

For a predictable first deployment, confirm all of the following:

• The workflow is active.
• Trigger ref values are deliberate and stable.
• You know whether your call is coming from a trunk, an extension, a queue callback, or a WebSocket leg.
• You know which identifier you will carry forward: legId, dialId, or mediaId.
• Recording paths or upload URLs are valid on the n8n host.
• If using HTTP media, required auth credentials are available in n8n.

Current Public UI Limits

As of the current node contract:

• SIP Connection transport selection in the UI exposes UDP.
• Extensions transport selection in the UI exposes UDP.
• WebSocket dialing is available through three transport profiles:
  • generic
  • openai_realtime
  • gemini_live

Do not document or depend on commented-out or internal-only transport options unless they are actually exposed in the node UI you are using.

What Gets Installed

The published package contents are intentionally minimal:

• dist/
• bin/
• prebuilds/
• README
• LICENSE
• the runtime install helper

The source repository contains the full source code, tests, and authoring material.