Skip to content

Commit

Permalink
0.3.1 back-end errors in browser log, rewritten: godmodel godsocket g…
Browse files Browse the repository at this point in the history 
…odcontrol watchit watchcopy and app file loading
  • Loading branch information
@haraldrudell
haraldrudell committed Jan 26, 2013
1 parent a0a6abd commit ee08cef
Showing 1 changed file with 14 additions and 19 deletions.
33 changes: 14 additions & 19 deletions readme.md
View file
Original file line number Diff line number Diff line change
@@ -1,21 +1,16 @@
<!doctype html>
<title>Node God</title>


<h1>Node God</h1>
<p>Node God manages node applications, restarts them on crash and produces a shared log.</p>
<p>Node God manages node applications</p>
<img src=https://raw.github.com/haraldrudell/nodegod/master/test/images/nodegod.png alt="Nodegod Screen Shot" />
<p>&copy; <strong><a href=http://www.haraldrudell.com>Harald Rudell</a></strong> wrote Node God for node in May, 2012. MIT License</p>
<h1>Benefits</h1>
<ol>
<li><strong>Monitor</strong> a handful of apps on a handful of servers as you work on them</li>
<li><strong>Immediate glance</strong>: the top bar goes red if any app is in crash state or the connection is lost</li>
<li><strong>Focus</strong> on your current app by scrolling it into view
<li><strong>No command line.</strong> Ever.</li>
<li><strong>Immediate feedback</strong>: the large top window area goes red if any app is in crash state or the connection is lost</li>
<li><strong>Focus</strong> on your current app by scrolling it into view</li>
</ol>
<h1>Features</h1>
<ol>
<li>Launch and **lifecycle management** of any number of apps</li>
<li>Launch and <strong>lifecycle management</strong> of any number of apps</li>
<li><strong>Browser interface</strong> supporting remote machines over ssh tunnel</li>
<li>Websocket communication for <strong>real-time</strong> updates</li>
<li>Command queue and application state and transitions for <strong>run/stop/debug</strong>.</li>
Expand All @@ -28,7 +23,7 @@
<li>Aggregation of stdout from many apps to a <strong>common log</strong>.</li>
<li>Fetch of port and url from the app so <strong>direct link</strong> can be displayed in the ui.</li>
</ol>
<p><strong>Node God</strong> is robustly written as four detached processes carefully designed to stay running indefinitely. These processes will stay running until you power of your machine.</p>
<p><strong>Node God</strong> is robustly written as four detached processes carefully designed to stay running indefinitely. These processes stay running until you power of your computer.</p>


<h1>Run as demo</h1>
Expand All @@ -39,11 +34,12 @@ nodegod$ node app
=== 2012-06-23 13:24:21 Node God starting
info - socket.io started
process /home/foxyboy/Desktop/c505/node/nodegod/apps.json
Application Node God on node v0.6.14 available on port 1111 in development mode
Application Node God on node v0.6.14 available on port 1111 in
development mode
127.0.0.1
```

<p>opens a browser window that monitors an app that exits every 10 seconds.</p>
<p>Node God opens a browser window that monitors an app that exits every 10 seconds.</p>


<h1>Configuration Files</h1>
Expand All @@ -69,7 +65,6 @@ Application Node God on node v0.6.14 available on port 1111 in development mode
<li>sessionSecret: optional string, has a default value</li>
<li>defaultFolder: a parent folder for deployed apps, default the parent folder of where nodegod's app.js is located</li>
</ul>
<p>Note: pids are stored in a file at $HOME/tmp or the global temp folder</p>


<h2>Configuring files for monitored apps</h2>
Expand All @@ -88,12 +83,12 @@ Application Node God on node v0.6.14 available on port 1111 in development mode
```
<ul>
<li>Key: the name of this app</li>
<li>id: optional string: the identifier (computer-friendly string) used for this app. default is derived from the app name, for "Node.js #3" here it would be "nodejs3"<li>
<li>state: optional string: the initial state of the app: run/stop/debug, default run<li>
<li>folder: optional path: the folder where the app is deployed. Default is a sibling folder to nodegod, ie. the parent folder of nodegod with id appended.<li>
<li>start: optional string or array of strings: parameters to the node executable, default app.js in the app's folder<li>
<li>watchFiles: optional string or array of Strings: filenames and folders to watch. If any file changes the app is restarted<li>
<li>launchBrowser: optional string: url for which a browser window is launched once<li>
<li>id: optional string: the identifier (computer-friendly string) used for this app. default is derived from the app name, for "Node.js #3" here it would be "nodejs3"</li>
<li>state: optional string: the initial state of the app: run/stop/debug, default run</li>
<li>folder: optional path: the folder where the app is deployed. Default is a sibling folder to nodegod, ie. the parent folder of nodegod with id appended.</li>
<li>start: optional string or array of strings: parameters to the node executable, default app.js in the app's folder</li>
<li>watchFiles: optional string or array of Strings: filenames and folders to watch. If any file changes the app is restarted</li>
<li>launchBrowser: optional string: url for which a browser window is launched once</li>
</ul>
<p>&copy; <strong><a href=http://www.haraldrudell.com>Harald Rudell</a></strong> wrote Node God for node in May, 2012. MIT License</p>
</html>

0 comments on commit ee08cef

Please sign in to comment.