ssb handbook Hermes the hermit crab

A work-in-progress guide to the ssb-verse and key concepts and influences

What Is Scuttlebutt?

Historically, sea-slang for gossip - a scuttlebutt is basically a watercooler on a ship.

Scuttlebutt is a decent(ralised) secure gossip platform.

This seems like a silly name, but I assure you, this is real science. Read this: http://www.cs.cornell.edu/home/rvr/papers/flowgossip.pdf

Or, if you're lazy: http://en.wikipedia.org/wiki/Scuttlebutt (laziness will get you nowhere, btw)

How To Get Started

The easiest way to get started is using patchwork, a classic social networking application.

screenshot of patchwork

Install Patchwork

Download Installers for Windows, macOS and Linux

See patchwork/releases

Or Build from Source

With node (>= 4) and npm (>= 2) installed:

$ git clone https://github.com/ssbc/patchwork
$ cd patchwork
$ npm install
$ npm start

On Linux you'll need some more dependencies. On Debian:

sudo apt-get install libxext-dev libxtst-dev libxkbfile-dev g++ m4 automake libtool

Be Invited To A Pub

In order to gossip outside your local network, you'll need to connect to a Pub.

You can find an invite to an available pub at the Pub servers registry.

Get an invite, then in patchwork: click "+ Join Pub" and paste the invite code.

This will cause you to follow the Pub and vise versa. If you haven't synchronized to this social network yet, prepare to wait a few minutes while your local server synchronizes.

Join The Community

  • #new-people: introduce yourself
  • #faq: first impressions, what is confusing as a new user?
  • #patchwork: report bugs, suggestions, etc
  • #scuttlebutt: protocol related discussion

About This Handbook

To view the public handbook, browse to scuttlebutt.nz

The handbook is organized by topics:

Other documentation

Over time we have scattered documentation around in a few places:

Please help us consolidate this here!

Other Projects

Scuttlebutt is not the only dex project:

results matching ""

    No results matching ""