ssbc / handbook.scuttlebutt.nz Goto Github PK

ssb handbook: A guide to the Secure Scuttlebutt key concepts and influences (see also, new website: https://gitlab.com/ssbc/scuttlebutt.nz/)

Home Page: https://handbook.scuttlebutt.nz

CSS 100.00%

handbook.scuttlebutt.nz's Introduction

Scuttlebutt

a decent(ralised) secure gossip platform

sea-slang for gossip - a scuttlebutt is basically a watercooler on a ship

This site is primarily for onboarding technical people and developers into knowledge of the SSB protocol and orientations from the conceptual to the practical aspects of writing and using SSB based applications.

If you would like to view a less technical and friendlier introduction to SSB, please visit scuttlebutt.nz/docs.

Contributor Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Have Other Questions?

A great place to learn more is our FAQ page

In addition, you'll find a wealth of resources within this handbook, accessible through the sidebar.

The resources are organized by these topics:

handbook.scuttlebutt.nz's People

Contributors

Stargazers

Watchers

Forkers

arithmetric cblgh dangerousbeans srccon hackergrrl nichoth nanomonkey wittjosiah robert-franklin mischa-s inoas lourinaldi richardlitt ersanchez alexmat2on l0010o0001l elevenpassin techwritingwhiz ccomendant mayel robbt georgeowell iblech trosel clevinson irishgordo productinfo utunga dariusk klarkc marylychee stv0g dpflug frijol connoropolous braydie timjrobinson soapdog zozs jontheniceguy rogeriochaves orvillered raimundojimenez planetary-social thebitfoundry krashanoff spaceexpanse adaptivefailure

handbook.scuttlebutt.nz's Issues

add roadmap

we should have a roadmap page!

it might help us provide an organized response to the feature requests that we often get asked, especially when we've had discussions regarding these features for years in some cases.

it could also be a way for us core contributors to signal what we are spending our energy on, so we can better coordinate together, although arguably the calls do this better, so maybe this is what we decide on as a group.

dominic's roadmap: %kDrsaJXkDiRwit9mCCmqoWBqI3WWxBxp+82fjZELluU=.sha256
message edits
- %hTtLupV6e7YolEcxY6PkKLINWwVkFlcjETF5UT42rb0=.sha256
- %jkhCRyKRRddr8NvGvgUSM69zeIeVC/GSAhPICcu9oYU=.sha256
- %M6v0bUiLAorHk1d+PcWd5kECKmit7H2Ksiyl5ArJgrw=.sha256
- %aK8uNWnpGgQqPsjOqKF6vzByx05MVpEDH+FubrnpYZs=.sha256
- %gVPywKpRYbzxj2Poqp6Va2sgGr0PlDd/zwvYrIaqxDg=.sha256
- %XWQv7bS5Jqd0Ks0g581bGcKrJ73X3jRe7xBBlLBYTfo=.sha256
multiple devices: #17
blob garbage collection: #20
patchwork i18n
- %mdlJLEUiWe+F0pqOmvKCnQDqo0vX5hJynfLgsdKm6rg=.sha256

... what else?

walk-through advanced message types like git-ssb

%UuS2GNZvfFJtBza1qVh34an/J0e1Ugf+XhoO7oIxrC4=.sha256

guide: how to get started with git-ssb

%zge1FZS5Q+JcbXhebwSUBvn0nKDzTayQmwGTzCwKuU4=.sha256

the thread link in multiple-devices.md throws a 502

https://github.com/ssbc/ssb-handbook/blob/master/faq/applications/multiple-devices.md

the clickable link therein doesn't work.

gossip peers: ~/.ssb/gossip.json

Documentation structure

Hello. We've been talking about revising the documentation on ssb for a while. Would people be interested in keeping track of ideas & direction here in github? (it's hard for me to keep track of ssb discussions).

I was wondering if people are working on updating docs already, what kind of scope of updates people are doing, visions for the future, stuff like that. I'll probably be either doing some writing of my own about ssb or submitting PRs here depending on the situation.

I had an idea of maybe refactoring this repo to be more developer-oriented, and the scuttlebutt.nz website could be more like an introduction for a non-technical audience.

What does everyone want?

"Publish a file" shows how to create a text file, and then references loading an image

Is it possible to clarify in this page (current version now) how one would upload a non-text file? For example, does one do:

cat my_file.jpg | ssb-server blobs.add

Or, can I do ssb-server blobs.add my_file.jpg

The guide also then goes on to say "you can reference this file in a post", with this:

ssb-server publish --type post --text "checkout this pic! ![CHC.jpg](&akkg6hKV7ee6sATu3mLeR6KfhgUbNGHWl/QJeALpQ0Y=.sha256)" --mentions.0.name CHC.jpg --mentions.0.link &akkg6hKV7ee6sATu3mLeR6KfhgUbNGHWl/QJeALpQ0Y=.sha256 --mentions.0.size 288388 --mentions.0.type image/jpeg

Do you need to provide the whole mentions.0.* stuff, or can you "just" use the text code, and let the client figure it out for themselves? If you do, is the .size in bytes?

Broken links in FAQ

Hi! I was reading the FAQ and noticed there are a few links that are broken (they point to the markdown file, instead of the generated page).

I looked into the raw markdown source for the faq index, but couldn't point to anything that looked wrong.

I found a few that are broken, mainly:

How do new users join the system?
How do I reserve my user name
Why do you have pub servers? isn't that a point of centralization?
How does user identity work?
Is it possible to delete or edit messages?
How do we prevent harassment and spam?

explain what happens when you join a pub

how to garbage collect blobs

%y/bu6OJ1xX7aFCdVdjCyEehqGSJ3cdE64IDlJBBn8g0=.sha256

how do i make an ssb bot?

walk-through basic message types

http://scuttlebot.io/docs/message-types/post.html

advanced walk-through: #4

Question about community forum and Ethereum hosted Pubs

Not sure where to put this question.
Does SSB have an community forum to ask questions and discuss anywhere? Or do you need to be on SSB / Manyverse / etc. in order to access the community forum?
Also, has anyone considered using Ethereum smartcontracts on the public Ethereum network to (eternally) host Pubs with lists of SSB addresses??
SSB GUIs could potentially directly communicate with smartcontracts on the Ethereum network whenever required.
Just an idea, probably already been floated in discussions??

add josiah's guides

%gZIsmmt1CPK6ihzByKUwHvCA8SXrZ3SGYWIwSn26o4E=.sha256

explain what Gatherings are and how they work

Delete merged branches

I've noticed that there a currently 42 branches in this repo of which most are already merged.

Unfortunately, most them are rebased onto master and the original branch remains unmerged and becomes stale.

I started to create a list of merged but stale branches:

scriptcast
add-epidom
add-rusty-post
fix-privacy-stuff
fix-coc-link
third-web-11
techfestival
zdnet-media
fix-media-table
zelf-radical-networks-2018
fix-andres-past-talk-images
andrestaltz-full-stack-fest
pubalicious

Can we delete these to keep a better overview?

setup guides section

crawl previous discussions for questions asked by newbies

Who can see all of the various names attached to your public key identity?

https://www.scuttlebutt.nz/concepts/identity

Let's say I'm part of a gaming community with many strangers. That crowd names me gamingHandle

Now let's say my mom is connected with me on SSB as well and she calls me childhoodNickname.

Can the gaming community click on my profile and see childhoodNickname attached to my public key as well?

%3nCbVgrZ8G5HiU/uS92npgcfvt629sSsnWz+S/ORBRM=.sha256

why is ssb different from dat, ipfs, webtorrent, etc?

layperson focused faq

It looks like this was started but never finished. Is it useful to track it as an issue so someone else can pick up from where Zach left off?

Would anyone else find it useful to have a layperson focused FAQ, that would perhaps live at ssb-handbook? I am thinking of questions and answers that tried to simplify the concepts and practices of SSB as much as possible, while also linking to more in-depth technical discussions for those interested.

In telling my friends about ssb, I'm finding they have questions that may seem overly simple, but really just point out how new of a concept scuttlebutt might be, and the trained social media concepts that people have to move past to really get the most out this

Example Questions I've heard (or have asked myself)

What is the difference between ssb and patchwork?
Where exactly does my diary live? Can I read it outside of patchwork? Can i switch to some other application and keep all my friends and feeds?
Am I downloading all my friends' feed? Won't that take up a lot of space?
If I post something, who all can see it? And do they now have it on their computer forever, even if I delete my diary?
What does subscribing to a channel mean, exactly?
etc.
I could help compile and write up this FAQ, if it would help! Basically, I would want to ask questions like these individually, and then edit down the useful and accurate responses. I'd also collect some of the best conversations on here already that we think a brand new user without a tech background would find useful.

these are my thoughts! what do y'all think?

how to get started contributing

Is there a "how to get started contributing" guide anywhere?"

%wfH5OHxDxPD0yH9C2S7q15TN9AUcSJv2wUoHeiR6t9U=.sha256

also how do i package ssb for my package manager?

capture and explain gossip replication messages

rename repo to scuttlebutt.nz

I fully did not realize this was the website. I propose we rename it. "the ssb handbook" can still appear in the byline of course

explain how local peer discovery works

add ssb-party to modules

%cJ1GJMhW1Npgj4FmdnrucUr4X/69lQ5iTjhUCyLHg4I=.sha256

ssb-party: %bS/WGqQrhQfH8eoyWieK+9M56DjJ8Q4ulkvb6sXZwPo=.sha256

how to deal with multiple devices

one of our most asked questions, like for example:

%q6qYcAlqig+3fqDxvBjaUzLyCoxG1yNUd4focPVSXhI=.sha256

channel subscription suggestions for new users

Be nice to put these in the handbook somewhere.

#new-people: introduce yourself
#faq: first impressions, what is confusing as a new user?
#patchwork: report bugs, suggestions, etc
#scuttlebutt: protocol related discussion

Code of Conduct link broken

If I knew better how gitbook deals with these links (or if this repo had some documentation on how to build it hint hint :) ) I would fix it for you, but instead I'll just point out that this the code of conduct https://www.scuttlebutt.nz/code-of-conduct.md doesn't show up on the site

how to build an app with ssb

%mngwyoNnKGbjoo+U72SH5B6GQRsbNKS3SEj6Qcv4rF4=.sha256

what's the ssb cap (app key)?

https://github.com/ssbc/scuttlebot/blob/master/lib/ssb-cap.js

how to setup a testnet

guide: how to setup a pub

explain how pub broadcasts allow you to replicate with other pubs

guide to how to get started contributing

%wfH5OHxDxPD0yH9C2S7q15TN9AUcSJv2wUoHeiR6t9U=.sha256

explain how to unfollow/block someone

quick start: add step for #new-people introduction

i feel it's been really nice having newbies introduce themselves, i think we should emphasize this process

add nichoths's survival guide

https://github.com/nichoth/ssb-survival-guide

Create readme for ssb-handbook that isn't index page

This is mostly a todo for myself, but I'd love to add a readme for the ssb-handbook module that isn't just the main page of the website.

improve talks section

add images for each talk
find any missing historical but relevant talks from Dominic or Paul

blob files

%rcK1yWqCxkyiEEM2cyo83N3hP4cLFsB0uQNVAxYla0g=.sha256

More clarity around degrees of separation and privacy/data

There are degrees of separation in SSB (I believe they're called "hops").

Degree of Separation	Name	Data Relationship	Privacy Relationship
1	friends	seed+leech	we see each others' feeds
2	friends of friends	leech only	we see each others' feeds
3	friends of friends of friends	leech only	we see each others' feeds

Ideally there would be more varied amounts of privacy and data relationships as the hops go on. For example, there should be a way to post things that only display to 1st degree relationships and it doesn't show for any others (maybe this kind of thing exists already).

Does my understanding capture how SSB works today?

NZ?

Are you in NZ? I'm currently doing a masters media design project at Victoria in Wellington making a program to scrape facebook data (like friends usernames, etc) and combine that with your downloadable archive, it would be really interesting to see if I could integrate with scuttlebutt in some way, to allow people a direct transfer to a decentralized site taking the social network with them.

Update/improve section on deleting and resyncing your database

This section https://handbook.scuttlebutt.nz/faq/basics/delete

Prompted by a discussion on mastodon https://merveilles.town/@ndpi/103720432396632607

The section talks about gossip.json and not conn.json, it asks the user to run ssb-server (instead of a more regular client), it warns the user not to fork their feed but not that they shouldn't use pub invites, and in turn it doesn't tell the user how to resync without using a pub invite (in case they don't have their conn.json).