Skip to content

Commit

Permalink
Updated README formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
meltingice committed Sep 1, 2010
1 parent d605acf commit 4d2114f
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.textile
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,22 @@
NodeMonitor is a distributed server monitoring system written in Javascript for <a href="http://github.com/ry/node">Node.JS</a>. It uses WebSockets to stream the data to the browser in near-realtime, and it uses a simple plugin system to add various monitoring capabilities to each node. <b>It is currently in a very alpha phase and a lot of functionality still needs to be added.</b> This is my first time ever using Node.JS so I'm sure the code could use a lot of improvement. Anyone who would like to contribute is welcome.

<h1>Requirements</h1>
*Linux/Unix (this includes Mac OSX; sorry, no Windows)
*<a href="http://github.com/ry/node">Node.JS</a>
* Linux/Unix (this includes Mac OSX; sorry, no Windows)
* <a href="http://github.com/ry/node">Node.JS</a>

<h1>How to Use</h1>
For a simple proof-of-concept:

*Configure config/server_config.js and config/node_config.js with the desired values. Should be pretty straightforward.
*Run the server on a single machine: sudo node NodeMonitor_Server.js
*Run the node on each machine you want to monitor (can be the same machine the server is running on): sudo node NodeMonitor_Node.js
*????????
*PROFIT!
* Configure config/server_config.js and config/node_config.js with the desired values. Should be pretty straightforward.
* Run the server on a single machine: sudo node NodeMonitor_Server.js
* Run the node on each machine you want to monitor (can be the same machine the server is running on): sudo node NodeMonitor_Node.js
* ????????
* PROFIT!

You should see data outputted from the server to the console as it comes in from the node(s).

<h1>What Needs to be Done?</h1>
*Basic plugins need to be finalized
*WebSocket server needs to be implemented
*Web interface needs to be implemented
*Lots more error handling and fault tolerance needs to be added
* Basic plugins need to be finalized
* WebSocket server needs to be implemented
* Web interface needs to be implemented
* Lots more error handling and fault tolerance needs to be added

0 comments on commit 4d2114f

Please sign in to comment.