├── README.md
└── screenshot.jpg


/README.md:
--------------------------------------------------------------------------------
  1 | # Patchfoo & SSB
  2 | 
  3 | [Patchfoo](http://git.scuttlebot.io/%25YAg1hicat%2B2GELjE2QJzDwlAWcx0ML%2B1sXEdsWwvdt8%3D.sha256) is a simple web client for [Secure
  4 | Scuttlebutt (SSB)](https://scuttlebut.nz), written by
  5 | [cel](https://git.scuttlebot.io/%40f%2F6sQ6d2CMxRUhLpspgGIulDxDCwYD7DzFzPNr7u5AU%3D.ed25519).
  6 | It uses HTML forms instead of client-side Javascript, making for a fast and
  7 | low-power SSB experience. People who might enjoy this include folks on older
  8 | computers, computers with small batteries, or people who just want a simple
  9 | client that isn't very hard to [hack
 10 | on](%25mgQ7t%2BaBDF71ZGmzQVk8yEQiB8Wj2dF5nmmVyYynOoQ%3D.sha256).
 11 | 
 12 | ![screenshot](screenshot.jpg)
 13 | 
 14 | # Install `ssb-server`
 15 | 
 16 | Scuttlebot (the `ssb-server` command) is the secure scuttlebut server program. This is
 17 | what finds, syncs, and manages the feeds of other SSB users, and lets you write
 18 | messages to the network.
 19 | 
 20 | Patchfoo depends on the `ssb-server` command being available. You can install this on
 21 | your machine via [npm](https://npmjs.org)
 22 | 
 23 | ```
 24 | $ npm install --global scuttlebot
 25 | ```
 26 | 
 27 | or by following the [scuttlebot installation
 28 | instructions](https://handbook.scuttlebutt.nz/guides/ssb-server/install).
 29 | 
 30 | Run `ssb-server start` to start your SSB peer.
 31 | 
 32 | # Join the network
 33 | 
 34 | To join the SSB network, you will need a "pub server" invite code. Pub servers
 35 | don't store your data, nor do they have any authority or lock-in capabilities.
 36 | 
 37 | You can remove pubs, add new pubs, or just sync with other peer directly, at any
 38 | time.
 39 | 
 40 | Pub servers are like a "dumb pipe" that lets you find other peers in the
 41 | network, making them ideal for new users who don't know any peers yet.
 42 | 
 43 | You can find an invite code from a pub
 44 | [here](https://github.com/ssbc/scuttlebot/wiki/Pub-Servers), or ask in
 45 | `#scuttlebutt` on Freenode IRC.
 46 | 
 47 | # Install ssb-npm
 48 | 
 49 | Many of patchfoo's javascript dependencies live on scuttlebutt itself, on a
 50 | special ssb-based registry called
 51 | [ssb-npm](http://git.scuttlebot.io/%25iqhz%2FsQCZCSp91JYAqfQPzHuDYrjw1geKPf1wJ1CvlA%3D.sha256).
 52 | 
 53 | You can follow the guide [ssb-npm 101](https://github.com/noffle/ssb-npm-101) to
 54 | get the registry set up and running locally, as well installing the `ssb-npm`
 55 | command.
 56 | 
 57 | # Install patchfoo
 58 | 
 59 | As per the [patchfoo README](http://git.scuttlebot.io/%25YAg1hicat%2B2GELjE2QJzDwlAWcx0ML%2B1sXEdsWwvdt8%3D.sha256):
 60 | 
 61 | ## Standalone
 62 | 
 63 | ```sh
 64 | git clone https://github.com/ssbc/patchfoo
 65 | cd patchfoo
 66 | ssb-npm install
 67 | npm start
 68 | ```
 69 | 
 70 | ## As an `ssb-server` plugin
 71 | 
 72 | You'll need `ssb-server start` running in the background.
 73 | 
 74 | ```sh
 75 | cd ~/.ssb/node_modules
 76 | git clone https://github.com/ssbc/patchfoo
 77 | cd patchfoo
 78 | ssb-npm install
 79 | ssb-server plugins.enable patchfoo
 80 | # restart ssb-server
 81 | ```
 82 | 
 83 | ## Install extras
 84 | 
 85 | To most effectively render things, patchfoo needs the `ssb-backlinks` scuttlebot
 86 | plugin:
 87 | 
 88 | ```sh
 89 | ssb-server plugins.install ssb-backlinks --yes
 90 | ssb-server plugins.enable ssb-backlinks
 91 | # restart ssb-server
 92 | ```
 93 | 
 94 | # Open patchfoo
 95 | 
 96 | Direct your favourite web browser to [http://localhost:8027](http://localhost:8027).
 97 | 
 98 | Click on the 'public' tab. You should start to see messages as the sync process
 99 | with the pub server works.
100 | 
101 | # License
102 | 
103 | CC0
104 | 
105 | 


--------------------------------------------------------------------------------
/screenshot.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/hackergrrl/sailing-patchfoo/fe6fad8ea352264256d1ed1046715301330af129/screenshot.jpg


--------------------------------------------------------------------------------