add about page

max-mapper · Mar 21, 2015 · c4f0f11 · c4f0f11
1 parent 4f48715
commit c4f0f11
Show file tree

Hide file tree

Showing 17 changed files with 142 additions and 31 deletions.
diff --git a/about.html b/about.html
@@ -0,0 +1,43 @@
+<header class="bar bar-nav">
+  <a href="/">
+    <button class="btn btn-link btn-nav pull-left">
+      <span class="icon icon-left-nav"></span>
+      Back
+    </button>
+  </a>
+  <h1 class="title">About Monu</h1>
+</header>
+<div class="content" style="padding: 40px 20px">
+  <h5>What is Monu</h5>
+  <p>Monu is an open source process monitoring application for Mac OS. You can configure Monu to launch programs, and when Monu starts up it will start them. Additionally, it will monitor the processes and restart them if they crash.</p>
+  <h5>How to use Monu</h5>
+  <p>To configure Monu, click 'Open Config Folder' and open 'config.json' in a text editor. When you save and return to Monu your new configuration will be automatically loaded.</p>
+  <p>Be sure your JSON syntax is valid when editing the configuration. Here are supported options. These should be added as top level key/value pairs to 'config.json':</p>
+  <ul>
+    <li><b>processes</b> the processes to run (see below)</li>
+    <li><b>logs</b> the directory to store logs in (default config/pids)</li>
+    <li><b>pids</b> the directory to store PIDs in (default config/logs)</li>
+    <li><b>on-error</b> a command to run when a process cannot start (default none)</li>
+    <li><b>on-restart</b> a command to run when a process restarts (default none)</li>
+    <li><b>sleep</b> sleep seconds before re-executing (default 1)</li>
+    <li><b>attempts</b> restart attempts within 60 seconds before stopping app (default 10)</li>
+    <li><b>prefix</b> add a string prefix to the log (default none)</li>
+  </ul>
+  <h5>Adding Processes</h5>
+  <p>In the 'config.json' file add processes to the 'processes' key. The key must be a name (lowercase letters and hypens) and the value must be the launch command. For example:<p>
+  <pre><code>{
+  "logs": "./logs",
+  "pids": "./pids",
+  "processes": {
+    "web-1": "http-server . -p 8081",
+    "web-2": "http-server . -p 8082",
+    "web-3": "http-server . -p 8083"
+  }
+}</code></pre>
+  <h5>Launch on Startup</h5>
+  <p>When you open Monu.app, it will start all configured processes.</p>
+  <p>If you would like Monu.app to start when your Mac starts up, got to <b>System Preferences &gt; Users and Groups</b> and add Monu.app to <b>Login Items</b> for your User.</p>
+  <h5>About</h5>
+  <p>Monu is a portmanteau of 'monitor' and 'menu'. It has two C/C++ dependencies, Atom Shell and the Mon process monitor.</p>
+  <p>If you find bugs, want to send pull requests, or want the source code visit https://github.com/maxogden/monu</p>
+</div>
diff --git a/config/config.json b/config/config.json
@@ -0,0 +1,7 @@
+{
+  "logs": "./logs",
+  "pids": "./pids",
+  "processes": {
+
+  }
+}
diff --git a/config/logs/web-1.log b/config/logs/web-1.log
@@ -0,0 +1,9 @@
+[33mStarting up http-server, serving [39m[36m.[39m[33m on port: [39m[36m8080[39m
+Hit CTRL-C to stop the server
+mon : write mon pid to /Users/maxogden/src/js/monu/config/pids/web-1.mon.pid
+mon : child 13973
+mon : write pid to /Users/maxogden/src/js/monu/config/pids/web-1.pid
+mon : shutting down
+mon : kill(-13972, 3)
+mon : waiting for exit
+mon : bye :)
diff --git a/config/logs/web-2.log b/config/logs/web-2.log
@@ -0,0 +1,9 @@
+[33mStarting up http-server, serving [39m[36m.[39m[33m on port: [39m[36m8086[39m
+Hit CTRL-C to stop the server
+mon : write mon pid to /Users/maxogden/src/js/monu/config/pids/web-2.mon.pid
+mon : child 13975
+mon : write pid to /Users/maxogden/src/js/monu/config/pids/web-2.pid
+mon : shutting down
+mon : kill(-13974, 3)
+mon : waiting for exit
+mon : bye :)
diff --git a/config/logs/web-3.log b/config/logs/web-3.log
@@ -0,0 +1,9 @@
+[33mStarting up http-server, serving [39m[36m.[39m[33m on port: [39m[36m8090[39m
+Hit CTRL-C to stop the server
+mon : write mon pid to /Users/maxogden/src/js/monu/config/pids/web-3.mon.pid
+mon : child 13977
+mon : write pid to /Users/maxogden/src/js/monu/config/pids/web-3.pid
+mon : shutting down
+mon : kill(-13976, 3)
+mon : waiting for exit
+mon : bye :)
diff --git a/configure.html b/configure.html
@@ -4,6 +4,7 @@
   <style type="text/css">
     /* overrides */
     .content .table-view { margin: 0 !important; }
+    ul, code {font-size: 14px; color: #777;}
   </style>
 </head>
 <body>

diff --git a/configure.js b/configure.js
@@ -8,7 +8,8 @@ Ractive.DEBUG = false
 
 var templates = {
   configure: fs.readFileSync('./configure.tmpl').toString(),
-  detail: fs.readFileSync('./detail.tmpl').toString()
+  detail: fs.readFileSync('./detail.tmpl').toString(),
+  about: fs.readFileSync('./about.html').toString()
 }
 
 var state = {}
@@ -25,6 +26,10 @@ $(document).on('click', '.btn.quit', function(e) {
   ipc.send('terminate')
 })
 
+$(document).on('click', '.btn.open-dir', function(e) {
+  ipc.send('open-dir')
+})
+
 ipc.on('got-all', function gotAll (data) {
   data = data.map(function map (d) {
     if (d.uptime) {
@@ -41,7 +46,9 @@ ipc.on('got-all', function gotAll (data) {
     d.message = "Not Running"
     return d
   })
-  state.configure.set({items: data})
+  var obj = {items: data}
+  if (data.length > 0) obj.hasProcesses = true
+  state.configure.set(obj)
 })
 
 ipc.on('got-one', function gotOne (data) {
@@ -64,12 +71,17 @@ var routes = {
     ipc.once('status', function() {
       next()
     })
+  },
+  about: function(ctx, next) {
+    ctx.template = templates.about
+    state.about = render(ctx, {})
   }
 }
 
 // set up routes
 page('/', routes.configure)
 page('/detail/:name', routes.detail)
+page('/about', routes.about)
 
 // initialize router
 page.start()

diff --git a/configure.tmpl b/configure.tmpl
@@ -2,7 +2,12 @@
   {{#items}}
     <li class="table-view-cell media"><a href="/detail/{{name}}" class="navigate-right"><span class="media-object pull-left icon icon-gear"></span> {{name}} <button class="btn {{classes}}">{{message}}</button></a></li>
   {{/items}}
+  {{^items}}
+    <li class="table-view-cell table-view-divider">Processes</li>
+    <li class="table-view-cell media">No Processes Configured</li>
+  {{/items}}
   <li class="table-view-cell table-view-divider">Actions</li>
+  {{#hasProcesses}}
   <li class="table-view-cell media">
     <a rel="external" class="processAction" data-action="startAll">
       <span class="media-object pull-left icon icon-play"></span>
@@ -27,8 +32,20 @@
       </div>
     </a>
   </li>
+  {{/hasProcesses}}
+  <li class="table-view-cell media">
+    <a href="/about">
+      <span class="media-object pull-left icon icon-search"></span>
+      <div class="media-body">
+        About
+      </div>
+    </a>
+  </li>
 </ul>
 <div class="bar bar-standard bar-footer">
+  <button class="btn pull-left open-dir">
+    Open Config Folder
+  </button>
   <button class="btn pull-right quit">
     Quit
   </button>

diff --git a/images/Icon.png b/images/Icon.png
diff --git a/images/[email protected] b/images/[email protected]
diff --git a/images/Status.png b/images/Status.png
diff --git a/images/[email protected] b/images/[email protected]
diff --git a/images/StatusHighlighted.png b/images/StatusHighlighted.png
diff --git a/images/[email protected] b/images/[email protected]
diff --git a/index.js b/index.js
@@ -1,4 +1,5 @@
 var path = require('path')
+var child = require('child_process')
 
 var app = require('app')
 var Menu = require('menu')
@@ -26,28 +27,15 @@ app.on('ready', function() {
     e.preventDefault()
   })
 
-  var template = []
-
-  var iconPath = path.join(__dirname, 'images', 'Status.png')
-  var configFile = './test/config.json'
-  var conf = require(configFile)
-  var dir = path.dirname(configFile)
-
-  conf.exec = {cwd: path.resolve(dir)}
-  conf.logs = path.resolve(path.join(dir, conf.logs || 'logs'))
-  conf.pids = path.resolve(path.join(dir, conf.pids || 'pids'))
-
-  mkdir(conf.logs)
-  mkdir(conf.pids)
-
-  conf.mon = path.join(__dirname, 'mon')
+  var conf = loadConfig()
 
   // start all once
   start([], function started (err) {
     if (err) return console.log("error starting processes: " + err.message)
     console.log("started all processes")
   })
-
+
+  var iconPath = path.join(__dirname, 'images', 'Icon.png')
   icon = new Tray(iconPath)
 
   icon.on('clicked', function(e) {
@@ -60,6 +48,10 @@ app.on('ready', function() {
     app.terminate()
   })
 
+  ipc.on('open-dir', function openDir (ev) {
+    child.exec('open ' + conf.exec.cwd, function(err) {})
+  })
+
   ipc.on('get-all', function getAll (ev, data) {
     getStatus()
   })
@@ -81,6 +73,29 @@ app.on('ready', function() {
     }
   }) 
 
+  function loadConfig() {
+    var configFile = './config/config.json'
+    var conf
+
+    try {
+      conf = JSON.parse(fs.readFileSync(configFile))
+    } catch (e) {
+      throw new Error('Invalid configuration file -- could not parse JSON')
+    }
+
+    var dir = path.dirname(configFile)
+
+    conf.exec = {cwd: path.resolve(dir)}
+    conf.logs = path.resolve(path.join(dir, conf.logs || 'logs'))
+    conf.pids = path.resolve(path.join(dir, conf.pids || 'pids'))
+
+    mkdir(conf.logs)
+    mkdir(conf.pids)
+
+    conf.mon = path.join(__dirname, 'mon')
+    return conf
+  }
+
   function showConfigure() {
     if (configure) {
       getStatus()
@@ -104,7 +119,8 @@ app.on('ready', function() {
   function getStatus(err, procName) {
     if (err) throw err
     if (!configure) return
-    debug('get proc status...')
+    debug('reload config, get proc status...')
+    conf = loadConfig()
     var status = []
     var group = new Mongroup(conf)
     var procs = group.procs

diff --git a/test/config.json b/test/config.json
diff --git a/test/config.mon b/test/config.mon