Giter Club home page Giter Club logo

ssb-handbook's Introduction

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:

ssb-handbook's People

Contributors

ahdinosaur avatar mixmix avatar mmckegg avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.