Something went wrong. Try again.
secure-scuttlebot classic
Something went wrong. Try again.
Files
- JavaScript 96%
- CSS 4%
README.md
# Secure-Scuttlebot Classic
sbotc is an open source **peer-to-peer log store** used as a database, identity provider, and messaging system.
It has:
- Global replication
- File-synchronization
- End-to-end encryption
`ssb-server` behaves just like a [Kappa Architecture DB](http://milinda.pathirage.org/kappa-architecture.com/).
In the background, it syncs with known peers.
Peers do not have to be trusted, and can share logs and files on behalf of other peers, as each log is an unforgeable append-only message feed.
This means ssb-servers comprise a [global gossip-protocol mesh](https://en.wikipedia.org/wiki/Gossip_protocol) without any host dependencies.
### Classic rational
ssb was abandoned in 2024, this is an attempt to restore the original "classic" functionality. You can find the original project documentation at [scuttlebot.io](https://scuttlebot.io). This repo is maintained by Everett Bogue. please reach out if you have any questions to the contact information present at https://evbogue.com/
---
## Installation
### Prerequisites
- You must have [Node.js](https://nodejs.org/) (version 14 or higher) and `npm` installed.
### Install from NPM
From the repo root:
- `npm install`
This will download the server, all dependencies, and make the `sbot` command available within the project.
---
## Getting Started
Follow these steps to get your server running and connected to the network.
### 1. Start the Server
First, start your secure scuttlebutt server. This process will run in your terminal, and you should leave it running. It will generate your unique ssb identity and store data in `~/.ssb`.
From the repo root:
```bash
npm start
```
This is equivalent to `node bin start`. You should see output like:
```
ssb-server <version> <path> logging.level:<level>
my key ID: <@yourPublicKey>
```
**Leave this terminal window open!** It is your local sbot node. All other commands will be run in a **new, separate terminal window.**
### 2. Use the Command-Line Interface (CLI)
With the server running, you can…