Git Product home page Git Product logo

mewconnect-api-v2's Introduction

MewConnect Pairing Server

The MewConnect Pairing Server attempts to pair two "signaling" peers together via a secure AWS Lambda Websocket connection. These peers will then establish a WebRTC connection to each other, allowing secure communication using the credentials created during the pairing process.

Setup

It is a required that you have node.js, Docker, and Docker Compose installed on your system.

.env

Before installing, it is required that you create a .env file with the following variables obtained via your AWS and Twilio accounts:

# AWS Info and Credentials
AWS_DEFAULT_REGION=us-west-1
AWS_ACCESS_KEY_ID=****************************
AWS_SECRET_ACCESS_KEY=****************************
AWS_REGION=us-west-1
TABLE_NAME=signal-server-table
S3_BUCKET=signal-server-bucket

# Twilio Credentials (For TURN server)
TWILIO_ID=****************************
TWILIO_TOKEN=****************************
TWILIO_TTL=3600

Install

npm install

Test

Testing requires a proper .env.test file to be in the root directory.

WEBSOCKET_URL=wss://**********.execute-api.us-west-1.amazonaws.com/dev
STUN_SERVER=stun:global.stun.twilio.com:3478?transport=udp
npm run test

Deploying to AWS

npm run deploy

mewconnect-api-v2's People

Contributors

dgomesbr avatar gsiuniak avatar hyandell avatar jt0 avatar mhart avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.