# git-ssb-web

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

Public installations:

- https://gitmx.com/
- https://git-ssb.celehner.com/
- http://git.mixmix.io/

## Install

NOTE: If you are running a modern version of Patchwork or Scuttlebot, `git-ssb-web` will **automatically be available at [http://localhost:7718](http://localhost:7718)** and **you do not have to install it yourself**.

```
npm install -g git-ssb-web
```

Or, if you also want the git remote helper and other goodies, install the
[git-ssb][] suite:

```
npm install -g git-ssb
```

## Usage

```
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": true
  }
}

Set `computeIssueCounts` to `false` for faster start up.

## Screenshots

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

![screenshot of a repo](static/screenshot-repo.png)

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

[secure-scuttlebutt]: https://github.com/ssbc/secure-scuttlebutt
[git-ssb]: %n92DiQh7ietE+R+X/I403LQoyf2DtR3WQfCkDKlheQU=.sha256

## License

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