git ssb - add version and config cmds to config section

Paul Frazee committed on 3/23/2016, 11:07:32 PM
Parent: 5018dc163eaf620159efec3f49b4bf2b2e286656

tmpl/docs/config/configure-scuttlebot.html.js	changed
tmpl/docs/config/create-a-pub.html.js	changed
tmpl/docs/config/creating-test-users.md	changed
tmpl/docs/config/get-active-config.html.js	added
tmpl/docs/config/get-active-config.md	added
tmpl/docs/config/get-current-version.html.js	added
tmpl/docs/config/get-current-version.md	added
tmpl/leftnav.part.js	changed

tmpl/docs/config/configure-scuttlebot.html.jsView
		@@ -5,6 +5,6 @@
5	5	section: 'docs',
6	6	tab: 'docs-config',
7	7	path: '/docs/config/configure-scuttlebot.html',
8	8	content: md.doc(__dirname+'/configure-scuttlebot.md'),
9		- next: ['/docs/config/creating-test-databases.html', 'Creating test databases']
	9	+ next: ['/docs/config/get-current-version.html', 'Get current version']
10	10	})

tmpl/docs/config/create-a-pub.html.jsView
		@@ -3,10 +3,10 @@
3	3
4	4	module.exports = () => page({
5	5	title: 'Create a Pub',
6	6	section: 'docs',
7		- tab: 'docs-social',
8		- path :'/docs/social/create-a-pub.html',
	7	+ tab: 'docs-config',
	8	+ path :'/docs/config/create-a-pub.html',
9	9	content: `
10	10	<h2>1. Get a public server</h2>
11	11	<p>
12	12	Pub servers need a static, publicly-reachable IP address.

tmpl/docs/config/creating-test-users.mdView
		@@ -3,8 +3,8 @@
3	3	Scuttlebot keeps all data and configuration in the `~/.ssb` directory.
4	4
5	5	The primary user's private key is kept in the `~/.ssb/secret` file.
6	6
7		-If you want to set a new primary user, while still using the same database, you can move `private` to some other location (eg `~/ssb/secret.backup`).
	7	+If you want to set a new primary user, while still using the same database, you can move `~/.ssb/secret` to some other location (eg `~/.ssb/secret.backup`).
8	8	Scuttlebot will automatically create a new user and secret, when started next.
9	9
10	10	Alternatively, you can [create secondary users](/docs/social/create-new-users.html).

tmpl/docs/config/get-active-config.html.jsView
		@@ -1,0 +1,10 @@
	1	+var md = require('../../../markdown')
	2	+var page = require('../../page.part')
	3	+module.exports = () => page({
	4	+ title: 'Get active config',
	5	+ section: 'docs',
	6	+ tab: 'docs-config',
	7	+ path: '/docs/config/get-active-config.html',
	8	+ content: md.doc(__dirname+'/get-active-config.md'),
	9	+ next: ['/docs/config/creating-test-databases.html', 'Creating test databases']
	10	+})

tmpl/docs/config/get-active-config.mdView
		@@ -1,0 +1,29 @@
	1	+# Get active Scuttlebot config
	2	+
	3	+To see what config options Scuttlebot is currently using, run:
	4	+
	5	+```bash
	6	+$ sbot config
	7	+{
	8	+ "host": "",
	9	+ "port": 8008,
	10	+ "timeout": 30000,
	11	+ "pub": true,
	12	+ "local": true,
	13	+ "friends": {
	14	+ "dunbar": 150,
	15	+ "hops": 3
	16	+ },
	17	+ "gossip": {
	18	+ "connections": 2,
	19	+ "seeds": [
	20	+ "slip.space:8008:@0GLMsG6IgXdv+GjG0U5UnZlwxHnomlfmrlWugx8i4dg=.ed25519"
	21	+ ]
	22	+ },
	23	+ "path": "/Users/bob/.ssb",
	24	+ "_": [
	25	+ "config"
	26	+ ]
	27	+}
	28	+
	29	+```

tmpl/docs/config/get-current-version.html.jsView
		@@ -1,0 +1,10 @@
	1	+var md = require('../../../markdown')
	2	+var page = require('../../page.part')
	3	+module.exports = () => page({
	4	+ title: 'Get current version',
	5	+ section: 'docs',
	6	+ tab: 'docs-config',
	7	+ path: '/docs/config/get-current-version.html',
	8	+ content: md.doc(__dirname+'/get-current-version.md'),
	9	+ next: ['/docs/config/get-active-config.html', 'Get active config']
	10	+})

tmpl/docs/config/get-current-version.mdView
		@@ -1,0 +1,6 @@
	1	+# Get current Scuttlebot version
	2	+
	3	+```bash
	4	+$ sbot version
	5	+7.6.5
	6	+```

tmpl/leftnav.part.jsView
		@@ -48,8 +48,10 @@
48	48	</ul>`
49	49
50	50	module.exports['docs-config'] = (c) => `<ul class="nav">
51	51	${item(c, '/docs/config/configure-scuttlebot.html', 'Configure Scuttlebot')}
	52	+ ${item(c, '/docs/config/get-current-version.html', 'Get current version')}
	53	+ ${item(c, '/docs/config/get-active-config.html', 'Get active config')}
52	54	${item(c, '/docs/config/create-a-pub.html', 'Create a Pub')}
53	55	${item(c, '/docs/config/creating-test-databases.html', 'Creating test databases')}
54	56	${item(c, '/docs/config/creating-test-users.html', 'Creating test users')}
55	57	</ul>`

cel / scuttlebot.io