Skip to content

README.md

Latest commit

 

History

History
76 lines (59 loc) · 2.39 KB

README.md

File metadata and controls

76 lines (59 loc) · 2.39 KB

arbiter_banner

Usage

Arbiter's CLI can be installed globally with npm

$ npm install -g arbiter-wrtc

Deploy Arbiter to your AWS account using the deploy command

$ arbiter deploy
running command...

Check your current version or get help with

$ arbiter (--version)
arbiter-wrtc/0.1.1 darwin-x64 node-v20.6.1
$ arbiter --help [COMMAND]
USAGE
  $ arbiter COMMAND
...

Commands

arbiter deploy

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: Screen Shot 2023-12-05 at 9 14 52 PM

This architecture includes: HTTP API Gateway WebSocket Gateway CoTURN ECS Cluster SFU ECS Cluster

Please refer to the documentation on Arbiter's Homepage for API documentation. See code: src/commands/deploy.ts

The Team

Stephen Watzman Software Engineer • Detroit, MI

Tyler Frye Software Engineer • Tampa Bay, FL

Jay Jayabose Software Engineer • New York, NY