CLI

Arbiter Command Line Interface

In order to use the arbiter command line interface, a user must first create an AWS Account and install the following dependencies:

• AWS Command Line Interface: command line tool for managing AWS services.

Subsequently, a user must ensure that the AWS Command Line Interface is configured locally. This can be achieved by executing aws configure from the command line and passing in the following necessary credentials:

• AWS Access Key ID
• AWS Secret Access Key
• Default region

For more details on deriving the above credentials, please see the official docs.

Install

Install the Arbiter CLI with npm

$ npm install -g arbiter-wrtc

Commands

Arbiter deploy

Deploy Arbiter to your AWS account using the deploy command

$ arbiter deploy
running command...

USAGE
  $ arbiter deploy [FILE] [-n <value>] [-f]

FLAGS
  -f, --force
  -n, --name=<value>  name to print

DESCRIPTION
  deploy Arbiter to AWS

EXAMPLES
  $ arbiter deploy

The deploy command will prompt you for your AWS access key ID and secret access key. Your AWS IAM account must have permission to create infastructure and security groups. You will then be asked what region you want to use to deploy Arbiter, and how many rooms you would like idle. Note that idle rooms are able to be claimed by users. It is possible to run Arbiter with 0 idle rooms, but that may result in long wait times to create new rooms when a URL is visited. A room is docker container of Arbiter's SFU, and it can take several minutes for a room to instantiate and become available to be claimed.

When you deploy Arbiter, you will have the following architecture created:

This architecture includes:

• HTTP API Gateway
• WebSocket Gateway
• CoTURN ECS Cluster
• SFU ECS Cluster