Navigator Prefabricating Marinates
Have ideas to improve npm?Join in the discussion! »

hyperswarm-web

2.1.1 • Public • Published

hyperswarm-web

Implementation of the hyperswarm API for use in web browsers

Using in an application

npm i -s hyperswarm-web
// 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 setvers to connect
      // Without the connection is limited to local peers
      iceServers:require("./ice-servers.json")
    }
  }
})
 
// 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)
})

Build it with Browserify 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: to proxy hyperswarm connections over websockets. Path: ws://yourserver/proxy
  • SignalServer: 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

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

Install

npm i hyperswarm-web

DownloadsWeekly Downloads

106

Version

2.1.1

License

MIT

Unpacked Size

14.2 kB

Total Files

8

Last publish

Collaborators

  • avatar