https://github.com/rcasto/peer-pass

A service facilitating in connecting peers together.
https://github.com/rcasto/peer-pass

p2p peer-to-peer webrtc webrtc-signaling

Last synced: 7 days ago
JSON representation

A service facilitating in connecting peers together.

• Host: GitHub
• URL: https://github.com/rcasto/peer-pass
• Owner: rcasto
• License: mit
• Created: 2021-07-05T19:26:40.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-07-12T04:20:45.000Z (over 3 years ago)
• Last Synced: 2024-11-19T04:30:14.280Z (2 months ago)
• Topics: p2p, peer-to-peer, webrtc, webrtc-signaling
• Language: TypeScript
• Homepage: https://peer-pass.com
• Size: 220 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# peer-pass

A service facilitating in connecting peers together.

![peer-pass call flow diagram](./peer-pass.png)

## Background

peer-pass can be thought of as a signaling storage API. It does not prescribe how the one-time codes get from one peer to another.

The primary benefit of peer-pass is in simplifying the transfer of an SDP from one peer to another. Instead of copy/pasting or attempting to send the SDP directly from one peer to another, you only need to send the one-time code.

There are of course alternatives to this approach that don't require peers to exchange these SDP's themselves, or even one-time codes for that matter. Those models typically involve WebSockets, polling requests, and/or Server Sent Events. There are multiple ways to approach this. peer-pass takes a simpler stance here and may or may not suit your needs.

## API

The API documentation can be found at:  

https://peer-pass.com

There are 2 endpoints:

- /api/peer/submit

    - Used to submit an offer or answer SDP for a fellow peer to then retrieve.

- /api/peer/retrieve

    - Used to pick up an offer or answer SDP that a fellow peer has submitted