<h1 align="center">
<img
alt="Hermies the hermit crab"
src="assets/hermies.png"
width="256"
height="256"
/>
<br />
SSB Handbook
</h1>
<h4 align="center">
A work-in-progress guide to the ssb-verse, key concepts and influences
</h4>
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.
Easy path
- Download an Installer for Windows, macOS and Linux
- Get a pub invite code
- Use the pub invite : in Patchwork click
+ Join Puband paste the invite code
Step 2 is important if you want to be able to find people further than your local network - it sets you up with a robot friend on the internet which helps you find and communicate with people. Read more about Pubs and their role here.
Build from Source
This is more technical than the easy path, mainly useful if you're interested in developing Patchwork.
On Linux you'll need some more dependencies. On Debian:
sudo apt-get install libxext-dev libxtst-dev libxkbfile-dev g++ m4 automake libtool
With node (>= 4) and npm (>= 2) installed:
$ git clone https://github.com/ssbc/patchwork
$ cd patchwork
$ npm install
$ npm start
Follow steps 2. and 3. above to connect to the network.
Join The Community
Check out the following channels by typing their name (with #) in the search bar:
- #new-people: introduce yourself
- #faq: first impressions, what is confusing as a new user?
- #patchwork: report bugs, suggestions, etc
- #scuttlebutt: protocol related discussion
Here are some other favourites:
- #boats: people living on, hacking, and bulding boats
- #cooking-channel: nerds sharing recipes
- #solarpunk: step into the future
- #gardening: get some gardening on with your off-grid
- #anarchitecture: decentralise all the things
Code of conduct
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
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:
Built with git-ssb-web