bitchan-node
v0.1.0
Published
Node bitchan client
Downloads
2
Maintainers
Readme
bitchan-node
NOTE: bitchan-node is in early alpha and may contain a lot of bugs. So it is recommended to use only trusted peer mode for a moment.
bitchan and Bitmessage client for Node.js.
Works as a common node in the Bitmessage network and also provides WebSocket gateway for bitchan web clients. Read more about bitchan at the wiki.
Usage
With npm
$ [sudo] npm install -g bitchan-node
$ bitchan
It will automatically create default config
at ~/.bitchan/bitchan.yaml
and run bitchan-node
in a trusted peer
mode. Trusted peer is located at localhost:8444 by default (if you have
PyBitmessage running at the same computer, most probably it will listen
here). WebSocket server will listen at 18444. By default SQLite database
will be used to store Bitmessage objects at ~/.bitchan/bitchan.db
.
Logs will be placed at ~/.bitchan/bitchan.log
.
To run bitchan-node
in a background you may either use
forever utility or some sort of
terminal multiplexing/nohup.
With deb package
TODO
License
bitchan-node - Node bitchan client
Written in 2014-2015 by Kagami Hiiragi [email protected]
To the extent possible under law, the author(s) have dedicated all copyright and related and neighboring rights to this software to the public domain worldwide. This software is distributed without any warranty.
You should have received a copy of the CC0 Public Domain Dedication along with this software. If not, see http://creativecommons.org/publicdomain/zero/1.0/.