Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/moose-team/peerbot
:radio: Message seeding utility for friends P2P chat.
https://github.com/moose-team/peerbot
Last synced: 9 days ago
JSON representation
:radio: Message seeding utility for friends P2P chat.
- Host: GitHub
- URL: https://github.com/moose-team/peerbot
- Owner: moose-team
- License: mit
- Archived: true
- Created: 2015-04-29T23:57:01.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-08-29T02:37:06.000Z (about 6 years ago)
- Last Synced: 2024-10-01T13:48:00.109Z (about 1 month ago)
- Language: JavaScript
- Homepage:
- Size: 15.6 KB
- Stars: 25
- Watchers: 8
- Forks: 11
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-peer-to-peer - peerbot
- awesome-peer-to-peer - peerbot
README
# peerbot
[![npm][npm-image]][npm-url]
[![travis][travis-image]][travis-url]
[npm-image]: https://img.shields.io/npm/v/peerbot.svg?style=flat-square
[npm-url]: https://www.npmjs.com/package/peerbot
[travis-image]: https://img.shields.io/travis/moose-team/peerbot.svg?style=flat-square
[travis-url]: https://travis-ci.org/moose-team/peerbot
Message seeding utility for [friends](https://github.com/moose-team/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`](https://github.com/atom/electron/issues/1518)
## Build and run peerbot locally
Same requirements as in [Install](#install).
```
git clone [email protected]:moose-team/peerbot.git
cd peerbot
npm install
npm run rebuild-leveldb
npm start
```
## Contributing
Contributions welcome! Please read the [contributing guidelines](CONTRIBUTING.md) first.
## License
[MIT](LICENSE.md)