Skip to content
This repository has been archived by the owner on Jul 11, 2019. It is now read-only.

Latest commit

 

History

History
68 lines (45 loc) · 1.6 KB

README.md

File metadata and controls

68 lines (45 loc) · 1.6 KB
Raw

peerbot

npm travis

Message seeding utility for friends p2p chat.

Run this on a server to ensure that there will always be a peer available to connect to for a given channel on friends.

Install

  1. Use newest io.js and npm (>= 1.8.1, >= 2.8.3).
  2. Install electron-prebuilt & electron-spawn globally.
  3. Install peerbot globally.
npm install -g peerbot

Usage

peerbot

peerbot always seeds the #friends channel. Pass --channel=mychannel to also seed another channel.

peerbot --channel=cats

You can specify as many channels as you want with multiple --channel flags.

Running on headless Ubuntu

If you're running peerbot on headless Ubuntu, you will need to use xvfb-run to create a virtual display so that Chromium can run:

$ sudo apt-get install xvfb
$ xvfb-run peerbot

Also you may need to apt-get install libgconf-2-4

Build and run peerbot locally

Same requirements as in Install.

git clone git@github.com:moose-team/peerbot.git
cd peerbot
npm install
npm run rebuild-leveldb
npm start

Contributing

Contributions welcome! Please read the contributing guidelines first.

License

MIT