Documentation · version 0.2.0

How to run Onyx Voice

Installing and running the Onyx Voice phone system: the server and its network, extensions and numbers, desk phones and softphones, call centre queues, reports, security, backups and high availability. New here? Start with Getting started.

Start here

Getting startedWhat Onyx Voice is made of (tenants, extensions, devices, numbers, trunks) and the first hour with a new server.Installing the serverSystem requirements, the installer ISO, the Hyper-V and VMware images, packages on Ubuntu, and the first-boot setup.Network, NAT and firewallA fixed address, the public address behind a router, the ports to forward and open, and DNS.Names and certificatesThe server's name, Let's Encrypt, your own certificate, and how HTTPS and SIP TLS use it.The web console and sign-in accountsSigning in, system and tenant administrators, two-factor sign-in, themes, search and the change history.

Phone system

Tenants (companies)Running several companies on one server: creating, suspending and removing tenants, and what each one owns.Extensions and usersCreating extensions, voicemail, caller ID, devices and SIP credentials, and giving people a portal sign-in.Calling features and feature codesForwarding, do not disturb, voicemail, ring groups, paging and intercom, parking, pickup, call recording and hot desking.Auto attendants, opening hours and promptsMenus callers press keys in, time conditions with holidays and overrides, recorded prompts and hold music.Phone numbers and routesIncoming numbers (DIDs) and where they ring, outbound routes and dial patterns, caller ID and emergency calls.Trunks (carriers)Connecting a SIP carrier: provider templates, registration or IP authentication, number formats, failover and encryption.

Devices

Desk phonesPhones that set themselves up: supported makes, plug-and-play, DHCP option 66, keys, DECT handsets, firmware and encrypted calls.SoftphonesThe browser softphone in the portal, Onyx Softphone for Windows, Android and iPhone, and other SIP apps.The user portalWhat people do themselves: voicemail, call history, forwarding and do not disturb, the softphone, the switchboard and their sign-in.

Call handling

Call centreQueues, agents and log-in codes, the wallboard, supervisors listening and whispering, callbacks and queue reports.Conference rooms and the switchboardConference rooms with PINs and moderators, and the operator switchboard for receptionists.Contacts and directory syncThe company phone book, caller names on incoming calls, and syncing people from Active Directory, LDAP or Microsoft 365.

Reports and billing

Call history and reportsFinding a call, live calls, the operations dashboard, analytics and exports.Call recordingsRecording calls, finding and playing them, retention periods and legal hold.BillingRate plans, pricing outside calls, monthly fees and the monthly bill per tenant.

Security

SecurityIntrusion prevention, the never-block list, two-factor sign-in for administrators, and encrypted calls.Call limits (toll fraud)International calling rules, premium numbers, call rate and spending caps, and what happens when a limit trips.

Running the server

Server toolsThe Server pages and the console menu: network, storage, system and services, logs and the support bundle.Backup and restoreScheduled backups to a share, what a backup holds, and restoring a server.UpdatesHow Onyx Voice and Ubuntu are updated, from the console or the command line.Importing from FreePBX and 3CXMoving extensions, ring groups, queues, IVRs, time conditions and numbers from another phone system.High availabilityTwo servers and a witness: what fails over, setting it up, switchovers and what to expect.TroubleshootingOne-way audio, phones that do not register, calls that do not arrive, and where to look.

Reference

Command line (onyx)Every onyx command for running the phone system from a shell or a script.Server settings referenceEvery server setting, what it does and its default.

Can't find what you need? Ask us.