Skip to content

Latest commit

 

History

History
28 lines (14 loc) · 2.87 KB

guide.md

File metadata and controls

28 lines (14 loc) · 2.87 KB

Getting Started

What is Secure Scuttlebutt

Secure Scuttlebutt is an offline-first decentralized peer-to-peer network in which people can share data with each other and their friends forming a social graph similar to how friendship and gossip work in the physical world. Even though this is a correct way of explaining it, it doesn't really help you understand what it is, does it? The best explanation is the video found on the main page of https://scuttlebutt.nz which is linked below:

<iframe src="https://player.vimeo.com/video/236358264" width="640" height="360" frameborder="0" allow="autoplay; fullscreen" allowfullscreen></iframe>

A Scuttlebutt Love Story from zach on Vimeo.

How does Patchfox fit into it

There are many applications you can use to access Secure Scuttlebutt (we call them clients). You may be familiar with the two most popular ones Patchwork and Patchbay. There are many other clients available besides these two. Patchfox is another client, one that lives inside your web browser and helps bridge the web browsing experience with the scuttlebutting experience so that both the web and the dweb appear as one.

Since the implementation of Secure Scuttlebutt requires some technical features which are not available to browser add-ons -- such as sockets, filesystem access -- we can't ship the full sbot server (also known as ssb-server) with Patchfox like the other desktop clients do. So, to use the add-on you need to be running your own sbot. It doesn't matter if your running sbot from the embedded copies inside Patchwork or Patchbay or if you're starting it from the command line from the ssb-server NPM package, the important thing is that there is a server running when you start Patchfox.

Most clients have a way for the user to run without starting embedded copies of sbot, this makes it possible to have only one sbot running and multiple clients connecting to it.

You might want to checkout our semi-official page about Secure Scuttlebutt, there is a getting started guide there that will help you get your sbot running.

How to configure it

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 verify the configuration, if you're not running scuttle-shell, it will ask you if you want to run it. You can open the settings screen by clicking here.

<script src="/docs/help.js">