staltz/ssb-room repository overview

⁠SSB Room 🏕

A server to find and connect to other SSB peers – a meeting place.

• A Secure Scuttlebutt (SSB)⁠ server for your community
• Friends currently online can connect to each other, bridged by the room server
• No developer skills required to set up your own room
• Comes with a friendly web page interface

⁠How does this compare to SSB pubs?

SSB Pubs⁠ are servers that hold copies of several SSB accounts, allowing you to sync with multiple friends, even if those friends are not currently online. Rooms are alternatives to Pubs that have an important difference: rooms do not store any user data, but instead allow currently online friends to connect to each other and synchronize their feeds.

The advantages are:

• Discover accounts that share a common interest with you
• Choose who you want to connect with (helps avoid a sudden influx of many strangers)
• Openly available invites makes it easy to onboard people onto SSB
• No concerns about hosting other people's data on the internet

The caveat is that you can only connect with accounts that are currently online in the same room. That said, you can still fetch the updates of an offline friend if another account online in the room also follows that offline friend.

⁠ℹ️ Read more in our FAQ⁠ and announcement blog post⁠

⁠How to setup an SSB room

1. Create an account on DigitalOcean⁠ and setup a billing method

2. Press this button to create a server on DigitalOcean and setup SSB Room

3. Follow the instructions on that page until you see this big button, and press it. "Go to your new app!"

1. You will see this initial page. Setup a name and description for your room server, and press "Done".

1. In the next page, your room is now ready to be used. It shows the invite code.

1. Copy the invite code and paste it into your preferred SSB app. Apps that support room invite codes: Manyverse (version 0.1908.12 or higher) and Patchwork.

1. In your SSB app, when friends join the room, your apps will sync. Send the room's website link to other friends to invite them too.

2. Announce the room's website publicly to the world by mentioning it anywhere on the web with the hashtag #ssbroom, or keep the link private to yourself and your friends.

For other use cases and setups, read the FAQ⁠.

⁠Acknowledgements and donations

A large portion of this project was forked from ahdinosaur's superb ssb-pub⁠. Support them on their OpenCollective⁠.

As for myself, you can support my work on the Manyverse OpenCollective⁠.

⁠License

AGPL-3.0