https://github.com/hackergrrl/sailing-patchfoo
Sail the high seas of scuttlebutt with Patchfoo! :boat:
https://github.com/hackergrrl/sailing-patchfoo
Last synced: 8 months ago
JSON representation
Sail the high seas of scuttlebutt with Patchfoo! :boat:
- Host: GitHub
- URL: https://github.com/hackergrrl/sailing-patchfoo
- Owner: hackergrrl
- Created: 2017-09-22T19:00:46.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-08-13T17:23:41.000Z (almost 6 years ago)
- Last Synced: 2025-10-13T16:03:44.583Z (8 months ago)
- Homepage:
- Size: 91.8 KB
- Stars: 33
- Watchers: 1
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Patchfoo & SSB
[Patchfoo](http://git.scuttlebot.io/%25YAg1hicat%2B2GELjE2QJzDwlAWcx0ML%2B1sXEdsWwvdt8%3D.sha256) is a simple web client for [Secure
Scuttlebutt (SSB)](https://scuttlebut.nz), written by
[cel](https://git.scuttlebot.io/%40f%2F6sQ6d2CMxRUhLpspgGIulDxDCwYD7DzFzPNr7u5AU%3D.ed25519).
It uses HTML forms instead of client-side Javascript, making for a fast and
low-power SSB experience. People who might enjoy this include folks on older
computers, computers with small batteries, or people who just want a simple
client that isn't very hard to [hack
on](%25mgQ7t%2BaBDF71ZGmzQVk8yEQiB8Wj2dF5nmmVyYynOoQ%3D.sha256).
# Install `ssb-server`
Scuttlebot (the `ssb-server` command) is the secure scuttlebut server program. This is
what finds, syncs, and manages the feeds of other SSB users, and lets you write
messages to the network.
Patchfoo depends on the `ssb-server` command being available. You can install this on
your machine via [npm](https://npmjs.org)
```
$ npm install --global scuttlebot
```
or by following the [scuttlebot installation
instructions](https://handbook.scuttlebutt.nz/guides/ssb-server/install).
Run `ssb-server start` to start your SSB peer.
# Join the network
To join the SSB network, you will need a "pub server" invite code. Pub servers
don't store your data, nor do they have any authority or lock-in capabilities.
You can remove pubs, add new pubs, or just sync with other peer directly, at any
time.
Pub servers are like a "dumb pipe" that lets you find other peers in the
network, making them ideal for new users who don't know any peers yet.
You can find an invite code from a pub
[here](https://github.com/ssbc/scuttlebot/wiki/Pub-Servers), or ask in
`#scuttlebutt` on Freenode IRC.
# Install ssb-npm
Many of patchfoo's javascript dependencies live on scuttlebutt itself, on a
special ssb-based registry called
[ssb-npm](http://git.scuttlebot.io/%25iqhz%2FsQCZCSp91JYAqfQPzHuDYrjw1geKPf1wJ1CvlA%3D.sha256).
You can follow the guide [ssb-npm 101](https://github.com/noffle/ssb-npm-101) to
get the registry set up and running locally, as well installing the `ssb-npm`
command.
# Install patchfoo
As per the [patchfoo README](http://git.scuttlebot.io/%25YAg1hicat%2B2GELjE2QJzDwlAWcx0ML%2B1sXEdsWwvdt8%3D.sha256):
## Standalone
```sh
git clone https://github.com/ssbc/patchfoo
cd patchfoo
ssb-npm install
npm start
```
## As an `ssb-server` plugin
You'll need `ssb-server start` running in the background.
```sh
cd ~/.ssb/node_modules
git clone https://github.com/ssbc/patchfoo
cd patchfoo
ssb-npm install
ssb-server plugins.enable patchfoo
# restart ssb-server
```
## Install extras
To most effectively render things, patchfoo needs the `ssb-backlinks` scuttlebot
plugin:
```sh
ssb-server plugins.install ssb-backlinks --yes
ssb-server plugins.enable ssb-backlinks
# restart ssb-server
```
# Open patchfoo
Direct your favourite web browser to [http://localhost:8027](http://localhost:8027).
Click on the 'public' tab. You should start to see messages as the sync process
with the pub server works.
# License
CC0