| 1 | # git-ssb
|
| 2 |
|
| 3 | Git repos on [secure-scuttlebutt (SSB)][ssb].
|
| 4 |
|
| 5 | This package includes:
|
| 6 |
|
| 7 | - A command line tool `git-ssb` for managing SSB git repos
|
| 8 | - A git remote helper [`git-remote-ssb`][] for using `ssb://` URLs with git
|
| 9 | - A web server [`git-ssb-web`][] for browsing repos locally
|
| 10 |
|
| 11 | ## Install
|
| 12 |
|
| 13 | ```
|
| 14 | npm install -g git-ssb
|
| 15 | ```
|
| 16 |
|
| 17 | ## Usage
|
| 18 |
|
| 19 | You can use a `ssb://` remote like any other git remote. A repo on SSB is
|
| 20 | identified by a message ID. To create a new git repo on SSB, use the command
|
| 21 | `git ssb create`.
|
| 22 |
|
| 23 | ## Examples
|
| 24 |
|
| 25 | Publish an existing repo to SSB:
|
| 26 |
|
| 27 | cd repo
|
| 28 | git ssb create ssb my-cool-repo
|
| 29 | git push --tags ssb master
|
| 30 |
|
| 31 | Clone a repo from SSB:
|
| 32 |
|
| 33 | git clone ssb://<msgId> repo
|
| 34 |
|
| 35 | Fork a git-ssb repo you have already cloned:
|
| 36 |
|
| 37 | cd repo
|
| 38 | git ssb fork mine
|
| 39 | # edit and commit, then push changes:
|
| 40 | git push mine
|
| 41 |
|
| 42 | Run the web server for browsing repos:
|
| 43 |
|
| 44 | git ssb web
|
| 45 |
|
| 46 | ## Configuration
|
| 47 |
|
| 48 | As with [patchwork][], `git-ssb` reads the `ssb_appname` environment
|
| 49 | variable when deciding what scuttlebot instance to connect to.
|
| 50 | `git-ssb` also uses [git's config][git config] to get the appname if the
|
| 51 | environment variable is not set. To make it so a repo only gets used in your
|
| 52 | [testing environment][patchwork-testing], you can configure the repo as
|
| 53 | follows:
|
| 54 |
|
| 55 | git config ssb.app_name test
|
| 56 |
|
| 57 | [ssb]: https://github.com/ssbc/secure-scuttlebutt
|
| 58 | [git config]: http://git-scm.com/docs/git-config
|
| 59 | [patchwork]: https://github.com/ssbc/patchwork
|
| 60 | [patchwork-testing]: https://github.com/ssbc/patchwork/blob/3f6d2d60b66361c3c926ff0a9e81847e71c8cfdd/docs/TESTING.md
|
| 61 | [`git-ssb-web`]: http://git-ssb.celehner.com/%25q5d5Du%2B9WkaSdjc8aJPZm%2BjMrqgo0tmfR%2BRcX5ZZ6H4%3D.sha256
|
| 62 | [`git-remote-ssb`]: http://git-ssb.celehner.com/%25ZVTOK3GA2aewEDI2rPxJqKXEIv4OIUN2swMPE2FeJm8%3D.sha256
|
| 63 | ## License
|
| 64 |
|
| 65 | Copyright (c) 2016 Charles Lehner
|
| 66 |
|
| 67 | Usage of the works is permitted provided that this instrument is
|
| 68 | retained with the works, so that any entity that uses the works is
|
| 69 | notified of this instrument.
|
| 70 |
|
| 71 | DISCLAIMER: THE WORKS ARE WITHOUT WARRANTY.
|