Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mafintosh/hyperirc
Read IRC through hypercore
https://github.com/mafintosh/hyperirc
Last synced: 7 days ago
JSON representation
Read IRC through hypercore
- Host: GitHub
- URL: https://github.com/mafintosh/hyperirc
- Owner: mafintosh
- License: mit
- Created: 2016-06-09T20:37:19.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-12-07T00:53:07.000Z (almost 7 years ago)
- Last Synced: 2024-10-23T13:41:26.174Z (16 days ago)
- Language: JavaScript
- Size: 12.7 KB
- Stars: 70
- Watchers: 6
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-peer-to-peer - hyperirc
- awesome-dat - hyperirc - bot that mirrors irc channels to a hypercore read-only log (Dat Applications / Community Applications)
- awesome-peer-to-peer - hyperirc
- awesome-starred - mafintosh/hyperirc - Read IRC through hypercore (others)
README
# hyperirc
Read IRC through hypercore.
## What is it?
[Hypercore](https://github.com/mafintosh/hypercore) is the underlying p2p network that powers [Dat](https://dat-data.com)
Hyperirc is a bot that mirrors irc channels to a hypercore append-only log.
This allows you to read an IRC channel using the hypercore p2p network. Anyone who is reading the irc logs is also helping hosting them.
## Usage
```
npm install -g hyperirc
```
## Usage
First, somewhere, start a mirror.
``` sh
hyperirc --mirror=an-irc-channel
```
This will mirror `an-irc-channel` on freenode into a hyperdrive feed.
The feed key is printed out.
Then on a couple of other computers run this to tail the channel
``` sh
hyperirc --tail=the-key-printed-out-above
```
Thats it! Every peer tailing (and the peer mirroring) will join the p2p network and help eachother host the irc logs.
By default, hyperirc will save its database under `~/.hyperirc`. You may choose your own location.
```sh
hyperirc --mirror=an-irc-channel --database=/path/to/db
```
For more options run `hyperirc --help`.
## Browser support
You can also seed the irc logs to the browser by adding the `--webrtc` option. This will make hyperirc join a p2p webrtc swarm
as well.
``` sh
hyperirc --tail=the-key-printed-out-above --webrtc
```
To view the logs in the browser visit the static website hosted here, https://github.com/mafintosh/hyperirc-www
## Mirrored IRC channels
* #dat on freenode, `hyperirc --tail=227d9212ee85c0f14416885c5390f2d270ba372252e781bf45a6b7056bb0a1b5`
* #sciencefair on freenode, `hyperirc --tail=d5ec4f72d2dfde000510b1d84912242a2c10400bbd9721311a548a1e3a7913b5`
* #beakerbrowser on freenode, `hyperirc --tail=18bab41fd4cfd47425226bebf6030ef270091481b39a1959768c2ccc90db02a3`
If you mirror a channel open a PR and add your key.
## License
MIT