Setup Credentials

Step 1 - Get the Agora Credentials

To get the App ID, you can follow this guide
To get the App Certificate, you can refer to this
To get Customer ID and Customer Certificate, you can refer this

Step 2 - Get AWS Credentials

First, you need to create an S3 bucket. This is where all your recording will be stored. You can refer to this guide on how to do that

Here's a guide on generating your access key and access secret

Step 3 - Setup Project name on the backend

You need to set SCHEME as the project name that was set in the console

Step 4 - Get OAuth Credentials

Link to the guides to setup authentication for each provider:

Example configuration file

{
  "APP_ID": "",
  "APP_CERTIFICATE": "",
  "CUSTOMER_ID": "",
  "CUSTOMER_CERTIFICATE": "",
  "BUCKET_NAME": "",
  "BUCKET_ACCESS_KEY": "",
  "BUCKET_ACCESS_SECRET": "",
  "GOOGLE_CLIENT_ID": "",
  "GOOGLE_CLIENT_SECRET": "",
  "PSTN_USERNAME": "",
  "PSTN_PASSWORD": "",
  "PSTN_ACCOUNT": "",
  "SCHEME": "",
  "ALLOWED_ORIGIN": "",
  "ENABLE_NEWRELIC_MONITORING": false,
  "RUN_MIGRATION": true,
  "ENABLE_OAUTH": true
}

For APP_ID, APP_CERTIFICATE, CUSTOMER_ID and CUSTOMER_CERTIFICATE, follow Step 1

For BUCKET_NAME, BUCKET_ACCESS_KEY AND BUCKET_ACCESS_SECRET, follow Step 2

For SCHEME, follow Step 3

For GOOGLE_CLIENT_ID and GOOGLE_CLIENT_SECRET follow Step Step 4

For PSTN_USERNAME, PSTN_PASSWORD and PSTN_ACCOUNT follow our PSTN Guide

For ALLOWED_ORIGIN, you can set it as the frontend URL for better security. It is used for setting the CORS header on the backend. Not setting it will default to allowing any frontend URL to send the request to the backend.

For ENABLE_NEWRELIC_MONITORING, setting it to true will allow you to use New Relic for monitoring.

For RUN_MIGRATION, setting it to true will run the database migration before starting the server. Setting it as false, will run the server without runnning the database migration.

For ENABLE_OAUTH, setting it as false will disable authentication on the backend.