Docs

Quick start

Install OpenRings on a Linux server, load sample data and make your first call. It takes about ten minutes.

OpenRings is a developer preview (v0.10). Field-test it with your own phones and carriers before moving production traffic.

Requirements

ItemRequirement
Server64-bit Linux, x86-64 or ARM64
Memory and CPU1 CPU and 512 MB to start. 2 CPUs and 2 GB for 100+ concurrent calls. 4 CPUs and 4 GB with call transcription.
DatabasePostgreSQL for the web portal's configuration pages. XML-only mode runs without it.
NetworkA public or routable address, with the ports below open

Ports

PortProtocolUsed for
5060 (and extra profiles, e.g. 5080)UDP and TCPSIP signalling
16384–32768UDPRTP audio
8443TCPWeb portal (HTTPS) and browser audio over TCP
8443UDPBrowser dialer and meetings audio
8021TCP, local onlyEvent socket for the console and integrations

Install

Download the binary release for your platform, unpack it and run the installer.

install
$ tar xzf orswitch-0.10.1-linux-bin.tar.gz
$ cd orswitch-0.10.1-linux
$ sudo bash packaging/install.sh
$ sudo systemctl enable --now orswitch

The installer creates a service user, puts the programs in /usr/local/bin, copies the configuration to /etc/orswitch (kept on upgrades), keeps data in /var/lib/orswitch and installs a hardened systemd service. It validates the configuration before it finishes.

Load sample data

For a first look, create a test database with extensions 1000 to 1004, a ring group, an IVR, feature codes and AUX codes, with the web portal switched on.

sample data
$ sudo bash packaging/setup-test-db.sh

Your first call

  1. Register a SIP phone or softphone as extension 1001 on port 5060, or sign in to the portal at https://your-server:8443 and open the browser dialer.
  2. Dial 9196 for the echo test. You should hear yourself back.
  3. Check the registration from the console:
console
$ sudo or_cli -x "show registrations"

Build from source

The build is pure Go 1.25 with every dependency vendored, so it needs no network and no C compiler.

build
$ git clone https://github.com/ringq-devs/orswitch
$ cd orswitch
$ GOFLAGS=-mod=vendor GOPROXY=off make build
$ bin/orswitch -version
$ bin/orswitch -conf conf -check

Cross-compile for ARM64 with CGO_ENABLED=0 GOARCH=arm64. Run make test for the unit and end-to-end tests.

Run in a container

container
$ make container
$ podman run --network host -v $PWD/conf:/etc/orswitch orswitch:0.10.1

Use host networking: SIP and RTP need the real ports.

Upgrade

Unpack the new version and run the installer again. Your configuration in /etc/orswitch is kept and missing database tables are added at start.

upgrade
$ sudo bash packaging/install.sh
$ sudo systemctl restart orswitch