Service: Intercom - EyevinnOSC/community GitHub Wiki

Getting Started

Open Source Intercom Solution providing production-grade audio quality and real-time latency. This tutorial gives you a walk-through how to quickly get started with intercom as an open web service in Eyevinn Open Source Cloud.

Prerequisites

  • If you have not already done so, sign up for an Eyevinn OSC account
  • Requires 2 available services in your plan. If you have no available services in your plan you can purchase each service individually or upgrade your plan.

Step 1: Create a database for the Intercom system

Create a NoSQL database for the Intercom system by navigating to the CouchDB open web service. Click on the button "Create couchdb".

Skärmavbild 2025-02-16 kl  23 08 18

Give the database instance the name intercom and enter a secret admin password.

When the database is up and running click on the instance card. Take a note of the URL to the database server instance.

Skärmavbild 2025-02-16 kl  23 09 18

Login with the admin password that you set.

Skärmavbild 2025-02-16 kl  23 09 43

Click on the button Create Database in the top right corner.

Skärmavbild 2025-02-16 kl  23 10 40

Give the database the name intercom and press create.

Step 2: Create Intercom system

Now go back to the Eyevinn Open Source Cloud web console and navigate to the open web service called Intercom. Create a new system by clicking on the button Create system.

Skärmavbild 2025-05-25 kl  14 16 01

Entering the values:

  • Name: tutorial
  • SmbUrl: https://sfu02-se-sto.node.osaas.io - this is a demo/test Symphony Media Bridge. For production use you need to run your own dedicated instance. Contact [email protected] if you want assistance with setting this up or that we will host it for you.
  • SmbApiKey: ZRTdTVS3rJ
  • DbUrl: Enter the URL to the CouchDB instance you created, in our example https://admin:[email protected]/intercom where intercom is the name of the database you created.
  • OscAccessToken: Provide personal access token for automatic re-authentication and sharing production lines with external users. In the screenshot above the token is stored in a secret called osctoken. This field can be left empty to start with.

Troubleshooting

If the instance is not starting up correctly check the following:

  • verify that the database URL contains the credentials, hostname and the database url. The URL should be in the form https://admin:<database-password>@<tenant-id>-<database-instance-name>.apache-couchdb.auto.prod.osaas.io/<database-name> for example https://admin:[email protected]/intercom
  • verify that the database referred to has been correctly created and exists.
  • if you are referring to secrets for instance parameters make sure they exists in this service.

Step 4: Access the application

When the instance is up and running click on the card to access the application.

You will be asked to give permissions to the audio devices. Accept for this website or once.

Skärmavbild 2025-02-16 kl  23 18 04

Enter your username and press Next.

Step 5: Create a production

Create a new production with one line. You can add more lines later.

Skärmavbild 2025-02-16 kl  23 19 10

Click on the back arrow when the production has been created.

Join the line testing in your production by clicking on the button Join.

Screenshot 2025-05-20 at 15 10 31

Now you have joined the line and can invite others.

Skärmavbild 2025-02-16 kl  23 20 55

Step 6: Invite others to the production

Invite users to your tenant (team) in Eyevinn Open Source Cloud and ask them to navigate to the Intercom open web service. Then they will click on the instance card that you created and will get access to the intercom system you created. Only users logged in and part of your team will have access to your system.

Skärmavbild 2025-02-16 kl  23 24 55

Invite external users to your production line

If you want to share a line with someone who is not logged into Eyevinn Open Source Cloud, you can do that from both a call and from the main page.

Pressing the link-button on the main page will show unique URLs to all lines in that production.

Note: Each URL can only be used once. If you want to invite multiple people who are not logged in, you’ll need to refresh the URL for each recipient.

share-production-links


production-links

If you are in a call you can click the 'Share Line' button to generate the unique URL.

call-hotkeys call-participants
⚠️ **GitHub.com Fallback** ⚠️