https://github.com/smudger/webrtc-signalling-server
A serverless WebRTC signaling server implementation using AWS API Gateway, Lambda, and DynamoDB, orchestrated via the AWS CDK.
https://github.com/smudger/webrtc-signalling-server
aws aws-cdk dynamodb lambda signaling-server typescript webrtc
Last synced: 3 months ago
JSON representation
A serverless WebRTC signaling server implementation using AWS API Gateway, Lambda, and DynamoDB, orchestrated via the AWS CDK.
- Host: GitHub
- URL: https://github.com/smudger/webrtc-signalling-server
- Owner: smudger
- Created: 2023-08-16T18:35:04.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-26T17:49:58.000Z (almost 2 years ago)
- Last Synced: 2025-01-18T10:44:46.197Z (5 months ago)
- Topics: aws, aws-cdk, dynamodb, lambda, signaling-server, typescript, webrtc
- Language: TypeScript
- Homepage:
- Size: 387 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# WebRTC Signaling Server
A serverless WebRTC signaling server implementation using AWS API Gateway, Lambda, and DynamoDB, orchestrated via the AWS CDK.
Inspired by [this article](https://medium.com/collaborne-engineering/serverless-yjs-72d0a84326a2) on creating a serverless signaling server by Ronny Roeller.
## Requirements
This project uses Node v16.
The AWS CDK app requires the following two secrets to be set in the AWS Secrets Manager:
- `github-token`: A GitHub personal access token with the `repo` scope.
- `webrtc-slack-webhook-url`: A Slack webhook URL for sending notifications from the monitoring stack.
## Useful commands
- `npm run build` compile typescript to js
- `npm run watch` watch for changes and compile
- `npm run test` perform the jest unit tests
- `cdk deploy` deploy this stack to your default AWS account/region
- `cdk diff` compare deployed stack with current state
- `cdk synth` emits the synthesized CloudFormation template
## Testing locally
The `./invoke.ts` script can be used to invoke the signaling server Lambda function locally. It requires the following environment variables to be set:
- `AWS_REGION`: The AWS region to use.
- `TOPICS_TABLE`: The name of the DynamoDB table to use for storing topics (from the deployed data stack).
The `./WebRtc.http` file contains examples of requests that can be sent to the signaling server.