buttcloud/buttpub-peer-client repository overview

⁠buttpub-peer

the peer server (aka sbot server) for your Scuttlebutt pub

(see TODO buttcloud/butt for how to run a production-quality pub server)

⁠usage

to interact with peer server, use peer client!

the usage should be the same as scuttlebot⁠

⁠server

⁠install

as Docker images:

docker pull buttcloud/buttpub-peer-server
docker run -it --rm --init \
  --name buttpub-peer-server \
  -v ~/.ssb:/home/node/.ssb \
  -p 8008:8008 \
  buttcloud/buttpub-peer-server

or standalone:

git clone git://github.com/buttcloud/buttpub-peer buttpub-peer
cd buttpub-peer
npm install
./server/bin.js

⁠config

to change buttpub-peer's default options, edit your ~/.ssb/config to have properties like:

{
  "port": 8008,
  "host": "::"
}

⁠client

⁠install

as Docker images:

docker pull buttcloud/buttpub-peer-client
docker run -it --rm --init \
  --name buttpub-peer-client \
  -v ~/.ssb:/home/node/.ssb \
  --net=host \
  buttcloud/buttpub-peer-client

or standalone:

git clone git://github.com/buttcloud/buttpub-peer buttpub-peer
cd buttpub-peer
npm install
./client/bin.js

⁠license

The AGPL-3.0⁠ License

Copyright © 2018 Michael Williams

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/⁠.