git ssb

2+

cel / scuttlebot.io



Tree: b943b01f452dcc8c932c81886d0346f7a38269e4

Files: b943b01f452dcc8c932c81886d0346f7a38269e4 / tmpl / apis / scuttlebot / invite.md

1296 bytesRaw

scuttlebot invite plugin

Invite-token system, mainly used for pubs.

create: async

Create a new invite code.

sbot create {n}
sbot.create(n, cb)

This produces an invite-code which encodes the sbot server's address, and a keypair seed. The keypair seed is used to generate a keypair, which is then used to authenticate a connection with the sbot server. The sbot server will then grant access to the use call.

accept: async

Use an invite code.

sbot accept {invitecode}
sbot.accept(invitecode, cb)

This connects to the server address encoded in the invite-code, then calls use() on the server. It will cause the server to follow the local user.

use: async

Use an invite code created by this sbot instance (advanced function).

sbot use --feed {feedid}
sbot.use({ feed: }, cb)

This commands the receiving server to follow the given feed.

An invite-code encodes the sbot server's address, and a keypair seed. The keypair seed must be used to generate a keypair, then authenticate a connection with the sbot server, in order to use this function.

Built with git-ssb-web