Improve documentation and config files

Author: byronigoe

config/config.js

@@ -71,7 +71,7 @@ config.development = {
     },
     // Config for local storage when storageType value is "local".
     local: {
-        // Binary files storage dir, Do not use tmpdir and it's public download dir.
+        // Binary files storage dir, Do not use tmpdir and its public download dir.
         storageDir: process.env.STORAGE_DIR || os.tmpdir(),
         // Binary files download host address which Code Push Server listen to. the files storage in storageDir.
         downloadUrl:
@@ -90,26 +90,25 @@ config.development = {
         // determine whether new account registrations are allowed
         allowRegistration: toBool(process.env.ALLOW_REGISTRATION),
         /*
-         * tryLoginTimes is control login error times to avoid force attack.
-         * if value is 0, no limit for login auth, it may not safe for account. when it's a number, it means you can
-         * try that times today. but it need config redis server.
+         * tryLoginTimes limits login error attempts to avoid force attack.
+         * if value is 0, no limit for login auth, it may not be safe.
+         * when it's a number, it means you can try that many times today,
+         * but it needs a redis server.
          */
         tryLoginTimes: toNumber(process.env.TRY_LOGIN_TIMES, 4),
         // create patch updates's number. default value is 3
         diffNums: toNumber(process.env.DIFF_NUMS, 3),
-        // data dir for caclulate diff files. it's optimization.
+        // data dir to calculate diff files. it's optimization.
         dataDir: process.env.DATA_DIR || os.tmpdir(),
         // storageType which is your binary package files store. options value is ("local" | "qiniu" | "s3"| "oss" || "tencentcloud")
         storageType: process.env.STORAGE_TYPE || 'local',
         // options value is (true | false), when it's true, it will cache updateCheck results in redis.
         updateCheckCache: toBool(process.env.UPDATE_CHECK_CACHE),
         // options value is (true | false), when it's true, it will cache rollout results in redis
         rolloutClientUniqueIdCache: toBool(process.env.ROLLOUT_CLIENT_UNIQUE_ID_CACHE),
-
-        // CodePush Web(https://github.com/lisong/code-push-web) login address.
-        //codePushWebUrl: "http://127.0.0.1:3001/login",
     },
-    // Config for smtp email，register module need validate user email project source https://github.com/nodemailer/nodemailer
+    // Config for smtp email; register module needs to validate user email
+    // project source https://github.com/nodemailer/nodemailer
     smtpConfig: {
         host: process.env.SMTP_HOST,
         port: process.env.SMTP_PORT || 465,

docs/install-server.md

@@ -1,6 +1,6 @@
 ## INSTALL NODE AND NPM
 
-[see](https://nodejs.org/en/download/)
+[Node Downloads](https://nodejs.org/en/download/)
 
 > (choose latest LTS version)
 
@@ -22,7 +22,7 @@ $ sudo npm i -g pm2
 ## GET code-push-server FROM NPM
 
 ```shell
-$ npm install @byronigoe/code-push-server@latest -g
+$ npm install byronigoe/code-push-server -g
 ```
 
 ## GET code-push-server FROM SOURCE CODE
@@ -35,42 +35,66 @@ $ npm install
 
 # GET Redis
 
+```shell
+yum install redis.x86_64
+```
 [Redis for Windows](https://github.com/microsoftarchive/redis/releases)
 
 ## INIT DATABASE
 
+Create a MySQL user, e.g.
 ```shell
-$ code-push-server-db init --dbhost "your mysql host" --dbport "your mysql port"  --dbuser "your mysql user" --dbpassword "your mysql password"
+CREATE USER 'codepush'@'localhost' IDENTIFIED BY 'create_a_password';
+```
+
+Grant appropriate permissions, e.g.
+```shell
+GRANT ALL PRIVILEGES ON codepush . * TO 'codepush'@'localhost';
+```
+
+Full command
+```shell
+$ code-push-server-db init --dbhost "your mysql host" --dbport "your mysql port" --dbname "your database" --dbuser "your mysql user" --dbpassword "your mysql password"
+```
+
+Defaults (if omitted) are:
+| dbhost | localhost |
+| dbport | 3306 |
+| dbname | codepush |
+| dbuser | root |
+
+Minimally
+```shell
+$ code-push-server-db init --dbpassword "your mysql root password"
 ```
 
 or from source code
 
 ```shell
-$ ./bin/db init --dbhost "your mysql host" --dbport "your mysql port"  --dbuser "your mysql user" --dbpassword "your mysql password"
+$ ./bin/db init --dbhost "your mysql host" --dbport "your mysql port" --dbname "your database" --dbuser "your mysql user" --dbpassword "your mysql password"
 ```
 
 > output: success
 
 ## CONFIGURE for code-push-server
 
-save the file [config.js](https://github.com/byronigoe/code-push-server/blob/master/config/config.js)
-
-some config have to change:
+Save the file [config.js](https://github.com/byronigoe/code-push-server/blob/master/config/config.js) and modify the properties, or set the corresponding environment variables (e.g. in process.json).
 
--   `local`.`storageDir` change to your directory,make sure have read/write permissions.
--   `local`.`downloadUrl` replace `127.0.0.1` to your machine ip.
--   `common`.`dataDir` change to your directory,make sure have read/write permissions.
--   `jwt`.`tokenSecret` get the random string from `https://www.grc.com/passwords.htm`, and replace the value `INSERT_RANDOM_TOKEN_KEY`.
--   `db` config: `username`,`password`,`host`,`port` change your own's
+-   `local`.`storageDir` change to your directory, make sure you have read/write permissions.
+-   `local`.`downloadUrl` replace `127.0.0.1` to your machine's IP.
+-   `common`.`dataDir` change to your directory, make sure you have read/write permissions.
+-   `jwt`.`tokenSecret` get a random string from `https://www.grc.com/passwords.htm`, and replace the value `INSERT_RANDOM_TOKEN_KEY`.
+-   `db` config: `username`,`password`,`host`,`port` set the environment variables, or change them in this file.
+-   `smtpConfig` config: `host`,`auth.user`,`auth.pass` needed if you enable `common.allowRegistration`
 
 ## CONFIGURE for pm2
 
-save the file [process.json](https://github.com/byronigoe/code-push-server/blob/master/docs/process.json)
+Save the file [process.json](https://github.com/byronigoe/code-push-server/blob/master/process.json)
 
-some config have to change:
+Some configuration properties have to change:
 
 -   `script` if you install code-push-server from npm use `code-push-server`, or use `"your source code dir"/bin/www`
--   `CONFIG_FILE` above config.js file path, use absolute path.
+-   `CONFIG_FILE` absolute path to the config.js you downloaded.
 
 ## START SERVICE
 
@@ -81,7 +105,7 @@ $ pm2 start process.json
 ## RESTART SERVICE
 
 ```shell
-$ pm2 restart process.json
+$ pm2 reload process.json
 ```
 
 ## STOP SERVICE

process.json

@@ -7,7 +7,9 @@
       "instances": "max", // Number of open instances, 'max' is the number of cpu cores
       "exec_mode": "cluster", // Cluster mode to maximize website concurrency
       "env": {
-        "NODE_ENV": "production"
+        "NODE_ENV": "production",
+        "PORT": 3000,
+        "CONFIG_FILE": "/path/to/config.js"
       }
     }
   ]