https://github.com/soapdog/patchfox
A client for scuttlebutt network as a Firefox WebExtension
https://github.com/soapdog/patchfox
firefox-webextension nodejs scuttlebutt webextensions
Last synced: 5 months ago
JSON representation
A client for scuttlebutt network as a Firefox WebExtension
- Host: GitHub
- URL: https://github.com/soapdog/patchfox
- Owner: soapdog
- License: mit
- Created: 2018-01-15T18:01:23.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-03-31T21:43:18.000Z (6 months ago)
- Last Synced: 2025-04-20T04:23:41.210Z (6 months ago)
- Topics: firefox-webextension, nodejs, scuttlebutt, webextensions
- Language: JavaScript
- Size: 208 MB
- Stars: 172
- Watchers: 11
- Forks: 23
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Patchfox
This is a new client for [Secure Scuttlebutt](http://scuttlebutt.nz) packaged as a Web Extension. This is a new client for [Secure Scuttlebutt](http://scuttlebutt.nz) packaged as a Web Extension for Firefox. It is available on:
* [Firefox Add-ons Portal](https://addons.mozilla.org/en-US/firefox/addon/patchfox/)
* [Chrome Web Store](https://chrome.google.com/webstore/detail/patchfox/ocanekmedfooidiahhelofknmpobdmdp?hl=en-GB&authuser=0)
So if you just want to run it, that's the easiest way. Read on if you want to develop with it. Read on if you want to develop with it.
## Requirements
* [Firefox Developer Edition](https://www.mozilla.org/en-US/firefox/developer/) or [Firefox Nightly](https://www.mozilla.org/en-US/firefox/nightly/) (needed so that you can sideload unsigned add-ons)
* [Scuttle Shell](https://github.com/ssbc/scuttle-shell). This is a soft requirement. You can use your own _sbot_ or even have another client such as [Patchwork](http://github.com/ssbc/patchwork) or [Patchbay](http://github.com/ssbc/patchbay) running and providing a running _sbot_.
## Setup & Building
Patchfox uses [Svelte](https://svelte.technology) and requires [NodeJS](https://nodejs.org) for development. After you have NodeJS installed, you can install the dependencies with:
```
$ npm install
```
And build the add-on with:
```
$ npm run clean-build
```
If you use:
```
$ npm run clean-dev
```
It will build the add-on using sourcemaps which makes debugging easier but can't be submit to AMO because they limit bundles to 4mb.
## Running
Go to [about:debugging](about:debugging) on Firefox, select `this firefox` and click to add a temporary add-on. Select the `manifest.json` file from the `dist/` folder from this repository.
## Setup inside Patchfox
Once patchfox is running, it needs to learn your _remote_ and _secret_, you can just click the "browse" button on the setup screen and select your `.ssb/secret` file. Patchfox will use the data inside your secret file to derive your remote address. Remember to click save.
After saving Patchfox will then try loading your public feed. You need to have a running _sbot_ for it to work.
# Testing the protocol schemas
After installing and configuring patchfox, try browsing to:
[ssb://message/sha256/Acm4sCjCDGWADCw773gfQyQ03tVYmxQLhyUWET8wLPc%3D](ssb://message/sha256/Acm4sCjCDGWADCw773gfQyQ03tVYmxQLhyUWET8wLPc%3D)
# Commentary, getting help
If you're interested in learning more about the technologies behind this add-on, check out:
* [MDN Web Docs - WebExtensions](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/).
* [Native Messaging API](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Native_messaging)
* [Native Messaging setup](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Native_messaging#Setup)
* [Secure Scuttlebutt Protocol Guide](https://ssbc.github.io/scuttlebutt-protocol-guide/)
Don't hesitate to reach out to me at:
* Scuttlebutt: `@gaQw6z30GpfsW9k8V5ED4pHrg8zmrqku24zTSAINhRg=.ed25519`
* Mastodon: [@soapdog@toot.cafe](https://toot.cafe/@soapdog)
* Twitter: [@soapdog](http://twitter.com/soapdog/)
# Sponsorship
Do you want a decentralized internet too? Are you worried about the loss of net neutrality and realized that radical decentralization is the way to fight back? If you want to make a financial contribution to help me fund development of this and other dex focused software, I would love to receive contributions through these channels:
* [Patchfox Open Collective](https://opencollective.com/patchfox)
# Artwork attribution
Patchfox is using artwork by many artists including:
* Art made by Angelica.
* Some icons made by Eucalyp from www.flaticon.com.
* Artwork for the 2020.2.1 release poster was done by: Photo by Krista Stucchio on Unsplash
# Third party vendored libraries
* Keymage 1.1.3: http://github.com/piranha/keymage
* ssb-custom-uri: https://git.sr.ht/~soapdog/ssb-custom-uri
* browser-polyfill: https://github.com/mozilla/webextension-polyfill
# Dependencies Licenses
Check [licenses.html](licenses.html)