git ssb

2+

cel / scuttlebot.io



Commit 49437e227262ebc5c6640ddceaf3d47e04765d73

update ssb-config docs

Paul Frazee committed on 3/26/2016, 7:40:38 PM
Parent: 77a423762af23f456e61ef2394b4c5869382aca8

Files changed

tmpl/apis/modules/ssb-config.mdchanged
tmpl/docs/config/configure-scuttlebot.mdchanged
tmpl/apis/modules/ssb-config.mdView
@@ -6,18 +6,13 @@
66
77 ``` js
88 var config = require('ssb-config')
99
10-// if you want to set up a test network, that
11-// doesn't collide with main ssb network,
12-// pass the name of that network in.
10+//if you want to set up a test network, that
11+//doesn't collide with main ssb pass the name of that network in.
1312
14-var test_config = require('ssb-config/inject')(
15- 'testnet', // name
16- { port: 9999 } // opts
17-)
18-// you can also pass a second argument,
19-// which overrides the default opts.
13+var test_config = require('ssb-config/inject')('testnet', {port: 9999})
14+//you can also pass a second argument, which overrides the default defaults.
2015 ```
2116
2217 ## Configuration
2318
@@ -29,8 +24,10 @@
2924 * `friends.dunbar` *(number)* [`Dunbar's number`](https://en.wikipedia.org/wiki/Dunbar%27s_number). Number of nodes your instance will replicate. Defaults to `150`.
3025 * `friends.hops` *(number)* How many friend of friend hops to replicate. Defaults to `3`.
3126 * `gossip.connections` *(number)* How many other nodes to connect with at one time. Defaults to `2`.
3227 * `path` *(string)* Path to the application data folder, which contains the private key, message attachment data (blobs) and the leveldb backend. Defaults to `$HOME/.ssb`.
28+* `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 `[]`.
29+* `logging.level` *(string)* How verbose should the logging be. Possible values are error, warning, notice, and info. Defaults to `notice`.
3330
3431 There are some configuration options for the sysadmins out there. All configuration is loaded via [`rc`](https://github.com/dominictarr/rc). You can pass any configuration value in as cli arg, env var, or in a file.
3532
3633 [View on Github](https://github.com/ssbc/ssb-config)
tmpl/docs/config/configure-scuttlebot.mdView
@@ -10,14 +10,18 @@
1010 "port": 8008,
1111 "timeout": 30000,
1212 "pub": true,
1313 "local": true,
14- friends: {
14+ "friends": {
1515 "dunbar": 150,
1616 "hops": 3
1717 },
1818 "gossip": {
1919 "connections": 2
20+ },
21+ "master": [],
22+ "logging": {
23+ "level": "notice"
2024 }
2125 }
2226 ```
2327
@@ -36,5 +40,7 @@
3640 - `pub` *(boolean)* Replicate with pub servers. Defaults to `true`.
3741 - `local` *(boolean)* Replicate with local servers found on the same network via `udp`. Defaults to `true`.
3842 - `friends.dunbar` *(number)* [`Dunbar's number`](https://en.wikipedia.org/wiki/Dunbar%27s_number). Number of nodes your instance will replicate. Defaults to `150`.
3943 - `friends.hops` *(number)* How many friend of friend hops to replicate. Defaults to `3`.
40-- `gossip.connections` *(number)* How many other nodes to connect with at one time. Defaults to `2`.
44+- `gossip.connections` *(number)* How many other nodes to connect with at one time. Defaults to `2`.
45+* `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 `[]`.
46+* `logging.level` *(string)* How verbose should the logging be. Possible values are error, warning, notice, and info. Defaults to `notice`.

Built with git-ssb-web