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