3dtoolkit-signal
Advanced tools
3dtoolkit webrtc signal implementation, using http :satellite:
This enables webrtc peer communication across the 3dtoolkit server/client stack. This means that it can be used to faciliate communication between N clients, N peers, and/or both. It uses http as a protocol, and can run over https as well. Further, authentication can be toggled on, requiring clients to provide valid OAuth 2.0 tokens in order to successfully access the service.
This implementation is built on top of the following components:
This implementation supports the following configuration settings, controlled via environment variables:
PORT - the port to start the server onWEBRTC_SIGNAL_LOGGING - boolean flag indicating if bunyan logging should be enabledWEBRTC_HEARTBEAT_ENABLED - boolean flag indicating if webrtc-signal-http-heartbeat should be enabledWEBRTC_HEARTBEAT_MS - (requires heartbeat) number of ms after which a client is marked as stale and removed if they have not issued a GET /heartbeatWEBRTC_HEARTBEAT_GC_MS - (requires heartbeat) number of ms at which the stale clients are "garbage collected" and removedWEBRTC_AUTH_ENABLED - boolean flag indicating if passport-azure-ad should be enabledWEBRTC_AUTH_B2C_APP_ID - Azure AD B2C application id. required if auth is enabledWEBRTC_AUTH_B2C_TENANT_ID - Azure AD B2C tenant id. required if auth is enabledWEBRTC_AUTH_B2C_POLICY_NAME - Azure AD B2C policy name. likely b2c_1_signup. required if auth is enabledWEBRTC_AUTH_APP_ID - Azure AD application id. required if auth is enabledWEBRTC_AUTH_TENANT_ID - Azure AD tenant id. required if auth is enabledWEBRTC_CAPACITY_ENABLED - boolean flag indicating if webrtc-signal-http-capacity should be enabledWEBRTC_RECOGNITION_ENABLED - boolean flag indicating if webrtc-signal-http-peer-identification should be enabledWEBRTC_PEERID_RESPECT_CAPACITY - hands out peers such that capacity reported by the webrtc-signal-http-capacity plugin is respectedWEBRTC_PEERID_PAIRING - pairs clients to servers. if WEBRTC_PEERID_RESPECT_CAPACITY is set, capacity will be considered, otherwise 1:1 pairings will be usedSee:
Our API is simply those APIs combined, with this added requirement:
All requests must have a valid Authorization: Bearer <token> header if WEBRTC_AUTH_ENABLED is true. See the AzureAD docs to learn how to acquire one.
Building: docker build -t 3dtoolkit-signal .
Running: docker run --rm -it -p 3000:3000 3dtoolkit-signal
MIT
FAQs
3dtoolkit webrtc signal implementation, using http
The npm package 3dtoolkit-signal receives a total of 3 weekly downloads. As such, 3dtoolkit-signal popularity was classified as not popular.
We found that 3dtoolkit-signal demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.