git-ssb-web

A web interface for git repos on ssb.

Public installations:

• https://git.scuttlebot.io/
• https://git-ssb.celehner.com/

Install

Requirements:

• ssb-server (previously known as scuttlebot)
• Connection to the SSB network 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 and port override the host and port settings from the config (described below), and default to localhost:7718.

Options are passed to ssb-config, so e.g. --public sets config {"public": true}.

Config

~/.ssb/config:

{
  "public": false,
  "git-ssb-web": {
    "host": "127.0.0.1",
    "port": 7718,
    "computeIssueCounts": false
  }
}

top-level config options:

• public (boolean): make the app not publish messages, so it is more suitable for public web hosting. Disables making digs or modifying issues, opening pull-requests, etc.

git-ssb-web config options:

• host: hostname to listen on. defaults to localhost.
• port: port to listen on. defaults to 7718.
• computeIssueCounts (boolean): Calculate counts of open issues and pull requests to display in the navigation links of a repo. This involves an expensive query at startup. Default: false.

Screenshots

Old screenshots:

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.