Eyevinn Open Intercom Server

Part of Eyevinn Open Intercom Solution

Eyevinn Open Intercom is a low latency, web based, open source, high quality, voice-over-ip intercom solution. It is designed to be used in broadcast and media production environments, where low latency and high quality audio are critical. The solution is built on top of WebRTC technology and provides a user-friendly interface for managing intercom channels and users.

Requirements

• A Symphony Media Bridge running and reachable
• A MongoDB server or CouchDB server
• Docker engine

Hosted Solution

Available as a hosted service on Open Source Cloud if you prefer not to manage the infrastructure yourself. Read the documentation to get started.

Deploy to Eyevinn Open Source Cloud using Terraform

You can deploy the complete Open Intercom solution (including database, media bridge, and intercom manager) to Eyevinn Open Source Cloud using Terraform. See the OSC Intercom Terraform Examples repository for complete configuration examples.

Quick Setup

1. Clone the Terraform examples repository:

   git clone https://github.com/EyevinnOSC/terraform-examples.git
   cd terraform-examples/examples/intercom
   

2. Set required environment variables:

   export TF_VAR_osc_pat="your-personal-access-token"
   export TF_VAR_smb_api_key="your-smb-api-key"
   export TF_VAR_db_admin_password="your-db-password"
   

3. Initialize and deploy:

   terraform init
   terraform plan
   terraform apply
   

Configuration Variables

The osc_eyevinn_intercom_manager resource requires these variables:

• name: Intercom system name (lowercase letters and numbers only)
• smb_url: Symphony Media Bridge instance URL
• smb_api_key: Symphony Media Bridge API key
• db_url: Database connection URL
• osc_access_token: OSC Personal Access Token (optional)

Environment variables

Variable name	Description
PORT	Intercom-Manager API port (default: 8000)
SMB_ADDRESS	The address:port of the Symphony Media Bridge instance (default: http://localhost:8080)
SMB_APIKEY	When set, provide this API key for the Symphony Media Bridge (optional)
DB_CONNECTION_STRING	DB connection string (default: mongodb://localhost:27017/intercom-manager). Supports MongoDB (mongodb://) and CouchDB (http:///https://)
PUBLIC_HOST	Hostname for frontend application for generating URLs to share (default: http://localhost:8000)
CORS_ORIGIN	Comma-separated list of allowed CORS origins, e.g. http://localhost:5173,http://localhost:5174. When unset, CORS is disabled. Required for local development when the frontend runs on a different port
WHIP_AUTH_KEY	When set, WHIP and WHEP endpoints require a Bearer token matching this key (optional)
ENDPOINT_IDLE_TIMEOUT_S	Idle timeout in seconds for SMB endpoints (default: 60)
OSC_ACCESS_TOKEN	Personal Access Token from OSC for link sharing and reauthenticating (optional)
ICE_SERVERS	Comma-separated list of ICE servers in the format: turn:username:password@turn.example.com,stun:stun.example.com. If no STUN server is provided, and WHIP endpoints are used, Google's default STUN server (stun:stun.l.google.com:19302) will be used.
MONGODB_CONNECTION_STRING	DEPRECATED: Use DB_CONNECTION_STRING instead

Installation / Usage

Start an Intercom Manager instance:

docker run -d -p 8000:8000 \
  -e PORT=8000 \
  -e SMB_ADDRESS=http://<smburl>:<smbport> \
  -e DB_CONNECTION_STRING=<mongodb|http>://<host>:<port>/<db-name> \
  eyevinntechnology/intercom-manager

The API docs is then available on http://localhost:8000/api/docs/

Development

Requires Node JS engine >= v18 and MongoDB (tested with MongoDB v7) or CouchDB.

Install dependencies

npm install

Run tests

npm test

Start server locally

SMB_ADDRESS=http://<smburl>:<smbport> SMB_APIKEY=<smbapikey> npm start

See Environment Variables for a full list of environment variables you can set. The default DB_CONNECTION_STRING is probably what you want to use for local development unless you use a remote db server.

Terraform infrastructure

Requires terraform and AWS access

cd infra
terraform init -var-file="dev.tfvars"

Development workspace

Create or select workspace dev

cd infra
terraform workspace new dev

or

cd infra
terraform workspace select dev

Create resources with variables for dev environment

terraform plan -var-file="dev.tfvars"
terraform apply -var-file="dev.tfvars"

Production workspace

Create or select workspace prod

cd infra
terraform workspace select prod

terraform plan -var-file="prod.tfvars"
terraform apply -var-file="prod.tfvars"

Contributing

See CONTRIBUTING

Support

Join our community on Slack where you can post any questions regarding any of our open source projects. Eyevinn's consulting business can also offer you:

• Further development of this component
• Customization and integration of this component into your platform
• Support and maintenance agreement

Contact sales@eyevinn.se if you are interested.

About Eyevinn Technology

Eyevinn Technology is an independent consultant firm specialized in video and streaming. Independent in a way that we are not commercially tied to any platform or technology vendor. As our way to innovate and push the industry forward we develop proof-of-concepts and tools. The things we learn and the code we write we share with the industry in blogs and by open sourcing the code we have written.

Want to know more about Eyevinn and how it is to work here. Contact us at work@eyevinn.se!