Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/RangerMauve/hyperswarm-web
Implementation of the hyperswarm API for use in web browsers
https://github.com/RangerMauve/hyperswarm-web
Last synced: 4 months ago
JSON representation
Implementation of the hyperswarm API for use in web browsers
- Host: GitHub
- URL: https://github.com/RangerMauve/hyperswarm-web
- Owner: RangerMauve
- License: mit
- Created: 2019-11-02T16:23:09.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-02-15T22:26:48.000Z (almost 3 years ago)
- Last Synced: 2024-05-01T21:23:05.474Z (8 months ago)
- Language: JavaScript
- Size: 34.2 KB
- Stars: 100
- Watchers: 10
- Forks: 15
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# hyperswarm-web
Implementation of the hyperswarm API for use in web browsers
## Using in an application
```
npm i -s hyperswarm-web
```
```js
// Based on example in hyperswarm repo
// Try running the regular hyperswarm demo with node
const hyperswarm = require('hyperswarm-web')
const crypto = require('crypto')
const swarm = hyperswarm({
// Specify a server list of HyperswarmServer instances
bootstrap: ['ws://yourhyperswarmserver.com'],
// You can also specify proxy and signal servers separated
wsProxy: [
'ws://proxy1.com',
'ws://proxy2.com'
],
webrtcBootstrap: [
'ws://signal1.com',
'ws://signal2.com'
],
// The configuration passed to the SimplePeer constructor
// See https://github.com/feross/simple-peer#peer--new-peeropts
// for more options
simplePeer: {
// The configuration passed to the RTCPeerConnection constructor, for more details see
// https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/RTCPeerConnection#RTCConfiguration_dictionary
config: {
// List of STUN and TURN servers to connect
// Without the connection is limited to local peers
iceServers: require('./ice-servers.json')
}
},
// Maximum number of peers (optional)
// Used in both webrtc (default 5) and ws proxy config (default 24)
maxPeers: 10,
// Websocket reconnect delay in milliseconds (optional) (default 1000)
wsReconnectDelay: 5000
})
// look for peers listed under this topic
const topic = crypto.createHash('sha256')
.update('my-hyperswarm-topic')
.digest()
swarm.join(topic)
swarm.on('connection', (socket, details) => {
console.log('new connection!', details)
// you can now use the socket as a stream, eg:
// socket.pipe(hypercore.replicate()).pipe(socket)
})
swarm.on('disconnection', (socket, details) => {
console.log(details.peer.host, 'disconnected!')
console.log('now we have', swarm.peers.length, 'peers!')
})
```
Build it with [Browserify](http://browserify.org/) to get it running on the web.
You could also compile an existing codebase relying on hyperswarm to run on the web by adding a `browser` field set to `{"hyperswarm": "hyperswarm-web"}` to have Browserify alias it when compiling dependencies.
## Setting up a proxy server
`HyperswarmServer` provides two services:
- [HyperswarmProxyWS](https://github.com/RangerMauve/hyperswarm-proxy-ws): to proxy hyperswarm connections over websockets. Path: `ws://yourserver/proxy`
- [SignalServer](https://github.com/geut/discovery-swarm-webrtc#server): for P2P WebRTC signaling connections. Path: `ws://yourserver/signal`
Running a `HyperswarmServer` will allows you to use both services in one single process.
```
npm i -g hyperswarm-web
# Run it! Default port is 4977 (HYPR on a phone pad)
hyperswarm-web
# Run it with a custom port
hyperswarm-web --port 42069
```
### Running as a Linux service with SystemD
```bash
sudo cat << EOF > /etc/systemd/system/hyperswarm-web.service
[Unit]
Description=Hyperswarm proxy server which webpages can connect to.
[Service]
Type=simple
# Check that hyperswarm-web is present at this location
# If it's not, replace the path with its location
# You can get the location with 'whereis hyperswarm-web'
# Optionally add a --port parameter if you don't want 4977
ExecStart=/usr/local/bin/hyperswarm-web
Restart=always
[Install]
WantedBy=multi-user.target
EOF
sudo chmod 644 /etc/systemd/system/hyperswarm-web.service
sudo systemctl daemon-reload
sudo systemctl enable hyperswarm-web
sudo systemctl start hyperswarm-web
sudo systemctl status hyperswarm-web
```