# git-ssb-web

A web interface for git repos on [ssb][secure-scuttlebutt].

Public installations:

- https://git.scuttlebot.io/
- https://build.with.parts/
- https://git-ssb.celehner.com/

## Install

Requirements:

- [scuttlebot][]
- Connection to the [SSB network][Scuttlebutt] network
- [ssb-npm-registry][] scuttlebot plugin

Optional requirement:

- [ssb-private][] scuttlebot plugin

Install via ssb-npm:

```
npm install -g git-ssb-web --registry=http://localhost:8043/
```
Or, if you also want the git remote helper and other goodies, install the
[git-ssb][] suite:

```
npm install -g git-ssb --registry=http://localhost:8043/
```

## Usage

NOTE: If you are running a modern version of Patchwork, and have installed `git-ssb-web`, it will **automatically be available at <http://localhost:7718>** whenever you run Patchwork, and you do not need to start it separately.

```
git ssb web [<options>] [<host:port>]
```
- `host`: hostname to listen on. defaults to `localhost`.
- `port`: port to listen on. defaults to `7718`.

Options:
- `--public`: make the app read-only (e.g. disable making digs), to make it
  suitable for serving publicly

## Config

`~/.ssb/config`:
```
{
  "git-ssb-web": {
    "host": "127.0.0.1",
    "port": 7718,
    "computeIssueCounts": false
  }
}
```

Set `computeIssueCounts` to `true` to calculate counts of open issues and pull requests to display in the navigation links of a repo. This involves an expensive query at startup.

## Screenshots

![screenshot](&f2f7WFd2qr2aKd5DFvYKZgmeSdJ3rayqQg0DxwLSCRg=.sha256)

Old screenshots:

![screenshot of a user's activity](static/screenshot-user-activity.png)

![screenshot of a pull request](static/screenshot-pr.png)

[Scuttlebutt]: https://www.scuttlebutt.nz/
[scuttlebot]: https://scuttlebot.io/
[secure-scuttlebutt]: https://github.com/ssbc/secure-scuttlebutt
[git-ssb]: %n92DiQh7ietE+R+X/I403LQoyf2DtR3WQfCkDKlheQU=.sha256
[ssb-npm-registry]: %pFqjcdVKHqsrtOjVEAVZeCF0iY4s+3Hr0vA3EFCq5UM=.sha256
[ssb-private]: %i/Ck3BU3P0xUAVIvtH6XKn8bNQWDNk2DdtteI5XNjDw=.sha256

## License

Copyright (c) 2016-2019 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.