|Dominic Tarr f8b8ebdf38 12.1.0||1 day ago|
|lib||3 weeks ago|
|plugins||1 week ago|
|test||2 weeks ago|
|.gitignore||1 year ago|
|.npmignore||3 years ago|
|.travis.yml||4 months ago|
|README.md||2 weeks ago|
|api.md||2 weeks ago|
|bin.js||1 month ago|
|index.js||1 day ago|
|package.json||1 day ago|
Scuttlebot is an open source peer-to-peer log store used as a database, identity provider, and messaging system. It has:
Scuttlebot behaves just like a Kappa Architecture DB. 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 Scuttlebots comprise a global gossip-protocol mesh without any host dependencies.
Join us in #scuttlebutt on freenode.
to get a known working shrinkwrapped version, install
It is recommended to only use this repo for development.
npm install -g scuttlebot-release
scuttlebot-release uses an
so that it's possible to install it globally with known dependencies.
You can also use this to install old versions, with dependencies
that worked at that time.
There are already several applications built on scuttlebot, one of the best ways to learn about secure-scuttlebutt is to poke around in these applications.
it is recommended to get started with patchwork, and then look into git-ssb and patchbay.
# In bash: # Start the server with extra log detail # Leave this running in its own terminal/window sbot server --logging.level=info # publish a message sbot publish --type post --text "My First Post!" # stream all messages in all feeds, ordered by publish time sbot feed # stream all messages in all feeds, ordered by receive time sbot log # stream all messages by one feed, ordered by sequence number sbot hist --id $FEED_ID
Scuttlebot's message-based data structure makes it ideal for mail and forum applications (see Patchwork). However, it is sufficiently general to be used to build:
Because Scuttlebot doesn't depend on hosts, its users can synchronize over WiFi or any other connective medium, making it great for Sneakernets.
Scuttlebot is eventually-consistent with peers, and requires exterior coordination to create strictly-ordered transactions. Therefore, by itself, it would probably make a poor choice for implementing a crypto-currency. (We get asked that a lot.)