git ssb


0+

noffle / gits-ssb-intro



forked from noffle / from-github-to-git-ssb

Branch:

Stephen Whitmore committed adds licenseLatest: 3a7c5f7 on 2/23/2017, 1:14:11 PM
📄README.md

from github to git-ssb: a guide to hacking together on the distributed web

you came to the right place! git-ssb is a great fit for just this. this guide tries to act as a transition document for github (or vanilla git) users into the world of git-ssb. it will walk you through:

  1. understanding what "ssb" is
  2. installing scuttlebot, the ssb peer server, and joining the network
  3. installing the git-ssb command and the git-ssb-web web interface
  4. a walkthrough of using git-ssb to do common github workflows (creating repos, making pull requests, merging pull requests, issues, etc)

enter ssb

what is ssb?

ssb is secure scuttlebutt the protocol that powers the peer-to-peer log store, scuttlebot. there is a great deal of information to be found by reading these sites, if you're so inclined.

if you're familiar with bitcoin or blockchains, ssb is kind of like having your own personal blockchain: you can append messages of any kind, with any data you'd like. and, unlike bitcoin, there's no money involved: it's just a data structure on your local machine.

your personal log can only be appended to, and is cryptographically secure: each message references the hash of the message that came before it. the whole thing is then also signed by your public key, making it both tamper-proof, and appendable only to the private key holder (you).

the final piece of ssb that makes it all work is the gossip protocol: when you run scuttlebot, you become a peer in a network of other scuttlebot users. you can choose to 'follow' other people's personal logs. as a result, whenever you see that user (or any user that follows that user too) online, you can retrieve their latest log entries from them. all without any central server or central authentication.

git-ssb builds on top of this: things like commits, branches, issues, and pull requests are modeled as log entries on each participant's personal log, while the gossip protocol runs in the background and propagates new content to everyone involved in the git repository.

installing scuttlebot

first you'll need to install node and npm.

once you've done that, follow these instructions to install Patchwork, a nice front-end that also packages a Scuttlebot server. this involves getting an "invite" to the scuttlebot network. this isn't a strict requirement, but an invite means you'll have other peers willing to share your log around the network, which is necessary for git-ssb to be useful. stop by #ssb on Freenode via IRC and ask for an invite -- there are many folks who are happy to provide them.

installing git-ssb

git-ssb is primarily the work of cel, and comes in the form of a command-line program not unlike git or github's hub.

let's use npm to install the git-ssb command:

$ npm install --global git-ssb

you can run git-ssb (or git ssb) from the command line now and get a feel for the sorts of things it can do

git-ssb web

if you've already joined the ssb network successfully, you can take a look at what other hackers on ssb are working on! run git-ssb web and point your web browser at the URL it outputs.

git-ssb web screenshot

you'll see that it's not dissimilar from github: git-ssb-web
lets you see commit activity, view repositories, browse commit history, see issues and pull requests. all without a centralized authority.

there are at least a few public git-ssb web servers run by the community, for browsing git-ssb content without running your own scuttlebot:

creating an ssb git remote

git-ssb makes scuttlebot act like a git remote. navigate to an existing git repository of yours and run

$ git-ssb create ssb

this will create a new git repo on ssb. the command will output something that looks like

Created repo: ssb://%DEvlJYD+zuudMyNWFBjiiNvZ8DbOyBYhCkE5EVtWSV0=.sha256
(my-little-repo)

the string %DEvlJYD+zuudMyNWFBjiiNvZ8DbOyBYhCkE5EVtWSV0=.sha256 is a hash that uniquely identifies your git-ssb repository. to see this in action, you can navigate to /tmp and run

$ cd /tmp

$ git clone ssb://%DEvlJYD+zuudMyNWFBjiiNvZ8DbOyBYhCkE5EVtWSV0=.sha256 my-repo

and you'll see that /tmp/my-repo now exists. git-ssb talked to your local scuttlebot server and pulled down the entire git repository.

in fact, you can also view your handiwork by running git-ssb web and opening your browser: you'll see your brand new repo near the top of the activity list and can browse it like you might've on github.

collaboration: forks and pull requests

license

ISC


Built with git-ssb-web