conf: adding config docs

esatterwhite · Apr 30, 2017 · 9a4f327 · 9a4f327
1 parent 2802448
commit 9a4f327
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/conf/index.js b/conf/index.js
@@ -1,6 +1,21 @@
 'use strict'
+/**
+ * Configuration options for skyring. See {@link module:keef} on ways to pass configuration
+ * @module skyring/conf
+ * @author Eric Satterwhite
+ * @since 1.0.0
+ **/
 
 module.exports = {
+/**
+ * @property {String|String[]} [seeds=127.0.0.1:3455,127.0.0.1:3456] A list of seed nodes to use for bootstrapping a ring cluster
+ * @property {Object} channel
+ * @property {String} [channel.host=127.0.0.1] hostname or ip addres for tchannel to listen on
+ * @property {Number} [channel.port=3455] Port number for tchannel to bind to
+ * @property {Number} [PORT=3000] The port number for the http API server to bind to
+ * @property {Object} nats Nats queue specific configuration
+ * @property {String|String[]} [nats.hosts=127.0.0.1:4222] host:port of instances of a nats cluster. One is usually enough.
+ **/
   seeds: ['127.0.0.1:3455', '127.0.0.1:3456']
 , channel: {
     host:'127.0.0.1'