Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ambianic/ambianic-pnp
An ephemeral signaling server that allows peers to auto discover each other on a local WiFi network and connect directly.
https://github.com/ambianic/ambianic-pnp
ambianic browser edge iot nodejs p2p peer-to-peer peerfetch plugandplay pnp webrtc webrtc-signaling
Last synced: 22 days ago
JSON representation
An ephemeral signaling server that allows peers to auto discover each other on a local WiFi network and connect directly.
- Host: GitHub
- URL: https://github.com/ambianic/ambianic-pnp
- Owner: ambianic
- Created: 2019-11-28T19:38:43.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T02:24:06.000Z (almost 2 years ago)
- Last Synced: 2024-10-31T17:58:57.425Z (about 2 months ago)
- Topics: ambianic, browser, edge, iot, nodejs, p2p, peer-to-peer, peerfetch, plugandplay, pnp, webrtc, webrtc-signaling
- Language: JavaScript
- Homepage:
- Size: 1.37 MB
- Stars: 24
- Watchers: 6
- Forks: 13
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- Security: SECURITY.md
Awesome Lists containing this project
README
# Ambianic PnP
[](https://github.com/ambianic/ambianic-pnp/actions?query=workflow%3A%22Node+CI%22)
[](https://badge.fury.io/js/ambianic-pnp)
[](https://github.com/semantic-release/semantic-release)
[](https://codecov.io/gh/ambianic/ambianic-pnp)
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fambianic%2Fambianic-pnp?ref=badge_shield)
[](https://www.codefactor.io/repository/github/ambianic/ambianic-pnp)
Ambianic Plug and Play (PnP) server allows [`peerfetch`](https://github.com/ambianic/peerfetch) peers to auto discover each other on a local WiFi network and connect directly.
Ambianic PnP is based on the popular [PeerJS Server](https://github.com/peers/peerjs-server). It is an emphemeral NodeJS app that normally runs on a host with public IP which can be accessed at all times by `peerfetch` devices. It acts as a [WebRTC peer discovery](https://developer.mozilla.org/en-US/docs/Web/API/WebRTC_API/Signaling_and_video_calling) server (also known as a **registrar** in the telecom world).
By default Ambianic UI (peerfetch client) and Ambianic Edge (peerfetch server) devices use the Ambianic PnP service at pnp.ambianic.ai. The service is available for FREE to all users, but is not recommended for business critical application as it does not provide any strict uptime or SLA guarantees. For such cases, it is better to deploy and configure your own Ambianic PnP server.
Ambianic PnP does not see any of the data exchanged between users and their edge devices. Its a transient "matchmaking" service without a database layer. No user data is collected, stored and used in any way. Please feel free to inspect the code and point out (or rip out) any code that contradicts with Ambianic's main principles of privacy, transperancy and ultimate user control.
## Running Locally
Make sure you have [Node.js](http://nodejs.org/) installed.
```sh
# git clone this project from github
$ cd ambianic-pnp
$ npm install
$ npm start
```
The Ambianic PnP server should now be running on [localhost:9779](http://localhost:9779/).
## Deploying to Heroku
You can run Ambianic PnP on many NodeJS hosting services, including Heroku. Click the button below to deploy to Heroku.
[](https://heroku.com/deploy)
Alternatively you can use the [Heroku CLI](https://devcenter.heroku.com/articles/getting-started-with-nodejs)
## NPM package
Ambianic PnP is packaged and released to npmjs as [ambianic-pnp](https://www.npmjs.com/package/ambianic-pnp).
## Documentation
Not available yet. Contributors welcome!
## Acknowledgements
- Ambianic PnP was originally inspired by the awesome [ShareDrop](https://github.com/cowbell/sharedrop) project.
- [PeerJS](https://github.com/peers/peerjs) is another great source of inspiration for Ambianic PnP.