mup - npm Package Compare versions

Comparing version 0.5.2 to 0.5.3

example/mup.json

@@ -19,4 +19,4 @@ {
 
-  // WARNING: If nodeVersion omitted will setup 0.10.28 by default. Do not use v, only version number.
-  "nodeVersion": "0.10.28",
+  // WARNING: If nodeVersion omitted will setup 0.10.29 by default. Do not use v, only version number.
+  "nodeVersion": "0.10.29",
 
@@ -23,0 +23,0 @@ // Install PhantomJS in the server

package.json

 {
   "name": "mup",
-  "version": "0.5.2",
+  "version": "0.5.3",
   "description": "Production Quality Meteor Deployments",
@@ -5,0 +5,0 @@ "dependencies": {

README.md

@@ -5,3 +5,3 @@ # Meteor Up
 
-Meteor Up (mup for short) is a command line tool that allows you to deploy any meteor app into your own server. It supports Ubuntu 12.04 or higher servers from any Cloud Infrastructure Provider.
+Meteor Up (mup for short) is a command line tool that allows you to deploy any [Meteor](http://meteor.com) app to your own server. It supports any Open Solaris or Debian/Ubuntu 12.04 or higher servers.
 
@@ -51,3 +51,3 @@ **Table of Contents**
 
-If you are looking for password based authentication, you need to [install sshpass](https://gist.github.com/arunoda/7790979) on your local development machine.
+If you are looking for password-based authentication, you need to [install sshpass](https://gist.github.com/arunoda/7790979) on your local development machine.
 
@@ -60,3 +60,3 @@ ### Creating a Meteor Up Project
 
-This will create two files in your Meteor Up project directory, which are:
+This will create two files in your Meteor Up project directory:
 
@@ -66,3 +66,3 @@ * mup.json - Meteor Up configuration file
 
-`mup.json` is commented and easy to follow (it supports JavaScript comments)
+`mup.json` is commented and easy to follow (it supports JavaScript comments).
 
@@ -80,7 +80,10 @@ ### Example File
       // or pem file (ssh based authentication)
+      // WARNING: Keys protected by a passphrase are not supported
       //"pem": "~/.ssh/id_rsa"
+      // Also, for non-standard ssh port use this
+      //"sshOptions": { "Port" : 49154 }
     }
   ],
 
-  // Install MongoDB in the server, does not destroy local MongoDB on future setup
+  // Install MongoDB on the server. Does not destroy the local MongoDB on future setups
   "setupMongo": true,
@@ -91,9 +94,9 @@
 
-  // WARNING: If nodeVersion omitted will setup 0.10.28 by default. Do not use v, only version number.
-  "nodeVersion": "0.10.28",
+  // WARNING: nodeVersion defaults to 0.10.29 if omitted. Do not use v, just the version number.
+  "nodeVersion": "0.10.29",
 
-  // Install PhantomJS in the server
+  // Install PhantomJS on the server
   "setupPhantom": true,
 
-  // Application name (No spaces)
+  // Application name (no spaces)
   "appName": "meteor",
@@ -112,4 +115,4 @@
 
-  // Meteor Up checks if the app comes online just after the deployment
-  // before mup checks that, it will wait for no. of seconds configured below
+  // Meteor Up checks if the app comes online just after the deployment.
+  // Before mup checks that, it will wait for the number of seconds configured below.
   "deployCheckWaitTime": 15
@@ -123,7 +126,7 @@ }
 
-This will setup the server for the mup deployments. It will take around 2-5 minutes depending on the server's performance and network availability.
+This will setup the server for the `mup` deployments. It will take around 2-5 minutes depending on the server's performance and network availability.
 
 #### Ssh based authentication
 
-The setup process will require NOPASSWD access to sudo. (Since Meteor needs port 80, sudo access is required.)
+Please ensure your key file (pem) is not protected by a passphrase. Also the setup process will require NOPASSWD access to sudo. (Since Meteor needs port 80, sudo access is required.)
 
@@ -150,10 +153,10 @@ You can add your user to the sudo group:
 
-This is how Meteor Up will configure the server for you based on the given appName or using "meteor" as default appName. This information will help you to customize server for your needs.
+This is how Meteor Up will configure the server for you based on the given `appName` or using "meteor" as default appName. This information will help you customize the server for your needs.
 
-* your app is lives in `/opt/<appName>/app`
-* mup uses upstart with a config file at `/etc/init/<appName>.conf`
+* your app lives at `/opt/<appName>/app`
+* mup uses `upstart` with a config file at `/etc/init/<appName>.conf`
 * you can start and stop the app with upstart: `start <appName>` and `stop <appName>`
-* logs are located at: `/var/log/upstart/app.log`
-* MongoDB installed and bind to the local interface (cannot access from the outside)
-* `<appName>` is the name of the database
+* logs are located at: `/var/log/upstart/<appName>.log`
+* MongoDB installed and bound to the local interface (cannot access from the outside)
+* the database is named `<appName>`
 
@@ -166,7 +169,7 @@ For more information see [`lib/taskLists.js`](https://github.com/arunoda/meteor-up/blob/master/lib/taskLists.js).
 
-This will bundle the meteor project and deploy it to the server.
+This will bundle the Meteor project and deploy it to the server.
 
 #### Deploy Wait Time
 
-Meteor Up checks for if the deployment is successful or not just after the deployment. By default, it will wait 10 seconds before the check. You can configure the wait time with `deployCheckWaitTime` option in the `mup.json`
+Meteor Up checks if the deployment is successful or not just after the deployment. By default, it will wait 10 seconds before the check. You can configure the wait time with the `deployCheckWaitTime` option in the `mup.json`.
 
@@ -181,3 +184,3 @@ #### Multiple Deployment Targets
 
-Sometime, you might be using Meteor from a git checkout or using `mrt`. By default Meteor Up uses `meteor`. You can ask Meteor Up to use the correct binary with `meteorBinary` option.
+Sometimes, you might be using `mrt`, or Meteor from a git checkout. By default, Meteor Up uses `meteor`. You can ask Meteor Up to use the correct binary with the `meteorBinary` option.
 
@@ -196,15 +199,15 @@ ~~~js
 
-Mup can tail logs from the server and it supports all the options of `tail`
+Mup can tail logs from the server and supports all the options of `tail`.
 
 ### Reconfiguring & Restarting
 
-After you've edit environmental variables or settings.json, you can reconfigure the app without deploying again. Use following command for that.
+After you've edit environmental variables or `settings.json`, you can reconfigure the app without deploying again. Use the following command for that.
 
     mup reconfig
 
-This will also restart the app, so you can use it for that purpose even if you didn't change the configuration file.
+This will also restart the app, so you can use it for that purpose even if you haven't changed the configuration file.
 
 ### Accessing the Database
 
-You can't access the MongoDB from the outside of the server. To access the MongoDB shell you need to log into your server by SSH first and then run the following command.
+You can't access the MongoDB from the outside the server. To access the MongoDB shell you need to log into your server via SSH first and then run the following command:
 
@@ -215,3 +218,3 @@ mongo appName
 
-Meteor UP supports multiple operating systems. See the list of supported operation systems:
+Meteor UP supports multiple operating systems:
 
@@ -221,6 +224,4 @@ * linux - Any Ubuntu/Debian based OS
 
-All you've to do is, specify the type of `os` when defining the server info. See below:
+All you have to do is specify the type of `os` (default `linux` if omitted) when defining the server info:
 
-> If you've leave `os`as blank, `linux` will be set as the default value
-
 ~~~js
@@ -246,9 +247,9 @@ {
 
-Meteor Up supports multiple deployments into a single server. Meteor Up only does the deployment; if you need to configure subdomains, you need to manually setup a reverse proxy yourself.
+Meteor Up supports multiple deployments to a single server. Meteor Up only does the deployment; if you need to configure subdomains, you need to manually setup a reverse proxy yourself.
 
-Let's assume, we need to deploy a production and the staging versions of the app into the same server. Production App runs on the PORT 80 and staging app run on PORT 8000.
+Let's assume, we need to deploy production and staging versions of the app to the same server. The production app runs on port 80 and the staging app runs on port 8000.
 
-We need to have two separate Meteor Up Projects. For that create two directories and initialize Meteor Up and add necessary configurations.
+We need to have two separate Meteor Up projects. For that, create two directories and initialize Meteor Up and add the necessary configurations.
 
-In the staging configurations add a field called `appName` with the value `staging` into the `mup.json`. You can add any name you prefer instead of `staging`. Since we are running our staging app in port 8000, add an environment variable called `PORT` with the value 3000.
+In the staging `mup.json`, add a field called `appName` with the value `staging`. You can add any name you prefer instead of `staging`. Since we are running our staging app on port 8000, add an environment variable called `PORT` with the value 8000.
 
@@ -259,5 +260,5 @@ Now setup both projects and deploy as you need.
 
-If you are using binary npm modules either with meteor-npm or with some other package you can't deploy and run your app by default. That's because, binaries in the bundle are not compatible with your deployment environment.
+If you are using binary npm modules either with meteor-npm or with some other package you can't deploy and run your app by default. That's because binaries in the bundle are not compatible with your deployment environment.
 
-So, you need to specify binary modules and which packages are then as shown below in your `mup.json`.
+So, you need to specify in `mup.json` the binary modules and which packages they are in.
 
@@ -264,0 +265,0 @@ ~~~json

No alert changes

Improved metrics

Total package byte prevSize

35553

increased by0.31%

Number of lines in readme file

268

increased by0.37%

No dependency changes