Files: 8231016cf1abf0fb60c43b11d9ef9dbe69d6e5c0 / tmpl / docs / config / configure-scuttlebot.md
1816 bytesRaw
Configure Scuttlebot
Scuttlebot keeps all data and configuration in the ~/.ssb
directory.
Configuration is stored in ~/.ssb/config
, which is a JSON file:
{
"host": "",
"port": 8008,
"timeout": 30000,
"pub": true,
"local": true,
"friends": {
"dunbar": 150,
"hops": 3
},
"gossip": {
"connections": 2
},
"master": [],
"logging": {
"level": "notice"
}
}
You can also specify config flags in the ssb-server start
call.
For example:
ssb-server start --port 1234 --timeout 500
The options:
host
(string) The domain or ip address forsbot
. Defaults to your public ip address.port
(string|number) The port forsbot
. Defaults to8008
.timeout
: (number) Number of milliseconds a replication stream can idle before it's automatically disconnected. Defaults to30000
.pub
(boolean) Replicate with pub servers. Defaults totrue
.local
(boolean) Replicate with local servers found on the same network viaudp
. Defaults totrue
.friends.dunbar
(number)Dunbar's number
. Number of nodes your instance will replicate. Defaults to150
.friends.hops
(number) How many friend of friend hops to replicate. Defaults to3
.gossip.connections
(number) How many other nodes to connect with at one time. Defaults to2
.
master
(array) Pubkeys of users who, if they connect to the Scuttlebot instance, are allowed to command the primary user with full rights. Useful for remotely operating a pub. Defaults to[]
.logging.level
(string) How verbose should the logging be. Possible values are error, warning, notice, and info. Defaults tonotice
.
See ssb-config for more info about the config.
Built with git-ssb-web