Merge pull request #507 from maraoz/fix/config-defaults

works without config.js, and improved docs

.gitignore

@@ -40,7 +40,6 @@ lib/*
 !lib/socket.io.js
 
 js/copayBundle.js
-config.js
 
 webapp/copay-webapp
 webapp/download

README.md

@@ -1,9 +1,8 @@
 [![Build Status](https://secure.travis-ci.org/bitpay/copay.png)](http://travis-ci.org/bitpay/copay)
 
-Copay
+# Copay
-=====
 
-Installation:
+## Installation:
 
 ```
 git clone https://github.com/bitpay/copay.git
@@ -21,7 +20,6 @@ Build Copay:
 npm install
 bower install
 grunt shell --target=dev
-cp config.template.js config.js
 ```
 
 Open Copay:
@@ -31,6 +29,8 @@ node app.js
 
 Then visit localhost:3000 in your browser.
 
+
+## Running copay
 To run on a different port:
 ```
 PORT=3001 node app.js
@@ -45,14 +45,19 @@ PORT=3004 node app.js
 PORT=3005 node app.js
 ```
 
-To open n different instances just run:
+To open n different instances more easily, just run:
 ```
-node launch.js n
+n=5
+node launch.js $n &
 ```
 
+## Configuration
+Default configuration can be found in the config.js file.
+See config.js for more info on configuration options.
 
-About Copay
+
-===========
+
+# About Copay
 
 General
 -------

config.js

@@ -1,26 +1,44 @@
 'use strict';
 var defaultConfig = {
+  // livenet or testnet
   networkName: 'testnet',
+
+  // wallet limits
+  limits: {
+    totalCopayers: 12,
+    mPlusN: 100
+  },
+
+  // network layer (PeerJS) config
   network: {
-    // key: 'lwjd5qra8257b9', //Copay API key for public PeerJS server
+    // Use this to run your own local PeerJS server
-    //   This is for running local peerJs with params: ./peerjs  -p 10009  -k 'sdfjhwefh'
+    // with params: ./peerjs  -p 10009  -k '6d6d751ea61e26f2'
-    //key: 'sdfjhwefh',
+    /*
-    //host: 'localhost',
+    key: '6d6d751ea61e26f2',
-    //port: 10009,
+    host: 'localhost',
-    //path: '/',
+    port: 10009,
-    //
+    path: '/',
-    key: 'satoshirocks',    // api key for the peerjs server
+    */
-    host: '162.242.219.26', // peerjs server
+
+    // Use this to connect to bitpay's PeerJS server
+    key: 'satoshirocks', 
+    host: '162.242.219.26',
     port: 80,
     path: '/',
+
+    // other PeerJS config
     maxPeers: 15,
     debug: 3,
+
+    // Network encryption config
     sjclParams: {
       salt: 'mjuBtGybi/4=', // choose your own salt (base64)
       iter: 1000,
       mode: 'ccm',
       ts: parseInt(64),
     },
+
+    // PeerJS internal config object 
     config: {
       'iceServers': [
         // Pass in STUN and TURN servers for maximum network compatibility
@@ -78,28 +96,35 @@ var defaultConfig = {
       ]
     }
   },
-  limits: {
+
-    totalCopayers: 12,
+  // wallet default config
-    mPlusN: 100
-  },
   wallet: {
     requiredCopayers: 2,
     totalCopayers: 3,
     spendUnconfirmed: 1,
     verbose: 1,
   },
+
+  // blockchain service API config
   blockchain: {
     host: 'test.insight.is',
     port: 3001
   },
+  // socket service API config
   socket: {
     host: 'test.insight.is',
     port: 3001
   },
+
+  // local encryption/security config
   passphrase: {
     iterations: 100,
     storageSalt: 'mjuBtGybi/4=', 
   },
+
+  // theme list
   themes: ['default'],
+
+
   verbose: 1,
 };

index.html

@@ -725,6 +725,7 @@ on supported browsers please check <a href="http://www.webrtc.org/">http://www.w
       <p class="text-center"><a href="#/">go back...</a></p>
     </script>
 
+
     <script src="config.js"></script>
 
     <script src="lib/angular/angular.min.js"></script>