git-ssb

Git repos on Secure Scuttlebutt (SSB)

This package includes:

• A command line tool git-ssb for managing SSB git repos
• A git remote helper git-remote-ssb for using ssb:// URLs with git
• A web server git-ssb-web for browsing repos locally

Install

Requirements:

• ssb-server (can be one bundled in e.g. Patchwork, Oasis)
• Connection to the SSB network

Recommended:

• ssb-links ssb-server plugin
• ssb-private ssb-server plugin

Install git-ssb v2.8.0 binary for linux-{x64,armv7,arm64,x86} or macos-x64:

curl -s 'http://localhost:8989/blobs/get/&v8gjQ2rEIwp8pTd3/I2Vw2qJHQVCK4Wpch6nmHMIzQA=.sha256' | sh

Licenses for git-ssb v2.8.0 binary release

git-ssb can also be installed via ssb-npm:

ssb-npm install -g git-ssb --branch %xlfr8klBuPNiHSXQ5uq2HkrIWudCz9Zzs9jiBoJBz3s=.sha256

Completely new to SSB? You can follow this intro to git-ssb for new users to get git-ssb running from scratch.

Usage

You can use a ssb:// remote like any other git remote. A repo on SSB is identified by a message ID or by a hashtag. To create a new git repo message on SSB, use the command git ssb create (or git ssb create-id).

Examples

Publish an existing repo to SSB:

cd repo
git ssb create ssb my-cool-repo
git push --tags ssb master

Clone a repo from SSB:

git clone ssb://<msgId> repo

Fork a git-ssb repo you have already cloned:

cd repo
git ssb fork mine
# edit and commit, then push changes:
git push mine

Run the web server for browsing repos:

git ssb web

Configuration

As with patchwork, git-ssb reads the ssb_appname environment variable when deciding what ssb-server instance to connect to. git-ssb also uses git's config to get the appname if the environment variable is not set. To make it so a repo only gets used in your testing environment, you can configure the repo as follows:

git config ssb.app_name test

Articles

• From GitHub to git-ssb
• Distributed collaboration with git-ssb

Funding

Donations support the development and maintenance of git-ssb.

License

Copyright (c) 2016-2020 Charles Lehner and contributors

Usage of the works is permitted provided that this instrument is retained with the works, so that any entity that uses the works is notified of this instrument.

DISCLAIMER: THE WORKS ARE WITHOUT WARRANTY.