An alternative Secure Scuttlebutt client interface that is fully compatible with Patchwork https://www.scuttlebutt.nz/applications#patchbay
Anders Rune Jensen 9b38b8a34c
Merge pull request #318 from staltz/ssb-legacy-conn
13 hours ago
.github Add org-wide config for Stale app 2 months ago
about profile page tidyup - relationships tabs, order 1 month ago
app /network: WIP display replication data (ebt based) 1 month ago
assets Send logs to stdout with console require 4 months ago
blob/sync standard autofix 1 year ago
contact/html fix peer activity to show _asserted publish time_ not received time! 1 month ago
message/html fix message.html.render for about messages 3 months ago
router Merge pull request #306 from ssbc/support-ssb-uri 1 month ago
sbot/async ssb-unread : show unread bells on message threads 7 months ago
styles standard autofix 1 year ago
.babelrc Adds patchbay-gatherings 1 year ago
.eslintrc.js bump marama, tweak meta/private, lint some 6 months ago
.gitignore Add *.sqlite3 to gitignore file. 1 year ago
README.md Add ssb-suggest to dev install. Closes #308 1 month ago
config.js fix device scope 3 weeks ago
index.js /network: WIP display replication data (ebt based) 1 month ago
main.js --amend 4 months ago
package-lock.json Merge branch 'master' into ssb-legacy-conn 19 hours ago
package.json Merge branch 'master' into ssb-legacy-conn 19 hours ago
screenshot.png drop shadow 1 year ago
server.js replace gossip plugin with new rewrite 19 hours ago

README.md

Patchbay

Patchbay is a scuttlebutt client designed to be easy to modify and extend. It uses the same database as Patchwork and Patchfoo, so you can easily take it for a spin with your existing identity.

Patchbay was created by Dominic Tarr towards the end of the life of Patchwork v1. It was born our out of the observation that maintaining a large client apps can be really hard work. Patchbay was designed to sidestep this by using some technology (depject) to make parts easier to swap and extend.

Patchbay now shares a common core library (patchcore) with Patchwork, and connects this in using the depject This is another experiment in sharing useful code and mainmtenance.

Current features boasted:

  • gatherings - a booking system
  • chess - p2p chess games and chat
  • bookblub - a book review interface
  • blogs - can read blogposts created in Ticktack

Install

Download easy installer for Mac / Windows / Linux here : https://github.com/ssbc/patchbay/releases

If you'd like to hack on Patchbay, check out the Developer Install below.

Keyboard shortcuts

See here or in patchbay for to the page /shortcuts

Developer Install

Libsodium has some build dependencies. On ubuntu systems the following might help:

sudo apt-get install m4 libtool eclipse-cdt-autotools

On MacOS you may need the following packages installed (in this example, via Homebrew):

brew install libtool automake autoconf

Easy Install

This runs an embedded sbot with all the right plugins already installed.

git clone https://github.com/ssbc/patchbay.git
cd patchbay
npm install

Patchbay doesn't give you a way to join pubs yet, so this is good if you've already done that with another client (like Patchwork).

Harder Install (full dev setup)

Install a standalone ssb-server (your gossip server)

npm install ssb-server@latest -g
sbot server

# then in another tab (these must be separate commands)
sbot plugins.install ssb-about
sbot plugins.install ssb-backlinks
sbot plugins.install ssb-unread
sbot plugins.install ssb-suggest
sbot plugins.install ssb-search # for search
sbot plugins.install ssb-chess-db # for chess
sbot plugins.install ssb-private # for private messages
sbot plugins.install ssb-meme # for image search

# restart sbot server (go back to previous tab and kill it)

Restart your sbot, then (optionally) use an invite code. This will give you your first friend, from which point you can find others:

sbot invite.accept LONG_INVITE_CODE_MAYBE_IN_QUOTES

Install Patchbay

git clone https://github.com/ssbc/patchbay.git
cd patchbay
npm install

Running the desktop app

Easy mode (embedded sbot):

# from the patchbay repo folder
npm start

Harder mode:

sbot server

# from the patchbay repo folder
npm run dev

Development

Key depject modules in Patchbay

Here's a quick high level overview of the depject modules you're going to want to know about:

app.html.app

The top level module which starts the front end js.

app.sync.initialise

A collection of function which are called on app start. Does things like load css into the app, set up custom listeners, set default settings

app.sync.goTo(location)

The function you call when you want to open a new location. location can be a string (like a message or blob id) or an object.

Note - some locations are normalised before being passed onto the router. Check out router.async.normalise for explicit detail.

router.sync.router

This is the module where you can add routes to the app. This is ultimately reduced along with all other router.sync.router modules into the final router.

app.html.settings

Giving modules here will add settings sections to the settings page (app.page.settings).

Requiring the core of patchbay

If you don't want the default modules, you can grab the main part of patchbay and pick and choose modules like this:

const patchcore = require('patchcore')
const patchbay = require('patchbay/main')
const combine = require('depject')
const entry = require('depject/entry')
const nest = require('depnest')

const sockets = combine(
  require('patchbay-dark-crystal'), // the module(s) you want
  patchbay,
  patchcore // required
)

const api = entry(sockets, nest('app.html.app', 'first'))
document.body.appendChild(api.app.html.app())

You'll need to be running your own sbot and launch this with electro / electron. See index.js to see that

How to add a new page

e.g. to add a 'cats' page to the app:

  • Add a file app/page/cats.js which gives app.page.cats
  • Tell the router to send people browsing to location {page: 'cats'} to send them to this page
    • route will look like [location => location.page === 'cats', api.app.page.cats]
    • Note the normaliser will automaticall turn location /cats to {page: 'cats'}
  • Add a link somewhere which will trigger that route:
    • e.g. activateapi.app.sync.goTo('/cats') onclick
    • e.g. add a link <a href='/cats'>Cats!</a> (which will be clicked up by listeners)

Module graph

TODO!

License

AGPL-3.0