giraffe-web

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Bluebox Index</title>  <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css"> <link type="text/css" rel="stylesheet" href="styles/site.cerulean.css"> </head> <body> <div class="container-fluid"> <div class="navbar navbar-fixed-top navbar-inverse"> <div class="navbar-inner"> <a class="brand" href="index.html">Bluebox</a> <ul class="nav"> <li class="dropdown"> <a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a> <ul class="dropdown-menu "> <li> <a href="GiraffeWeb.html">GiraffeWeb</a> </li> </ul> </li> </ul> </div> </div> <div class="row-fluid"> <div class="span8"> <div id="main"> <span class="page-title">Index</span> <section> <article><h1>giraffe-web</h1> <blockquote> <p>Giraffe dashboard for Graphite wrapped in a webserver</p> </blockquote> <h2>Jump to Section</h2> <ul> <li><a href="#introduction">Introduction</a></li> <li><a href="#installation">Installation</a></li> <li><a href="#usage">Usage</a></li> <li><a href="#configuration">Configuration</a></li> <li><a href="#building-and-testing">Building and Testing</a></li> <li><a href="#license">License</a></li> </ul> <h2>Introduction</h2> <p><a href="#jump-to-section">[Back To Top]</a></p> <p><a href="https://github.com/kenhub/giraffe">Giraffe</a> is an awesome dashboard for <a href="http://graphite.wikidot.com/">Graphite</a></p> <p>Big Kudos to <a href="https://github.com/kenhub">@kenhub</a></p> <p>This project : - merely extends it into <strong>a webserver</strong> - allows you to <strong>specify your own config file</strong> without changing the Giraffe content - allows you to <strong>proxy requests</strong> to an internal Graphite server - provides a self executable version requiring nothing but bash to run it</p> <p>This project is maintained at:</p> <p><a href="http://github.com/jedi4ever/giraffe-web.js">http://github.com/jedi4ever/giraffe-web.js</a></p> <h2>Installation</h2> <p><a href="#jump-to-section">[Back To Top]</a></p> <p>a) Installing giraffe-web is easy. You can install it like any other npm module</p> <p><code>npm install - giraffe-web</code></p> <p>b) For your convenience we provide a <code>bashpack</code> allowing you to run it without having node installed.</p> <p>Download it for your platform:</p> <ul> <li><a href="https://github.com/jedi4ever/giraffe-web.js/raw/master/dist/giraffe-web-darwin-x64.run">graphite-web-darwin-x64.run</a></li> <li><a href="https://github.com/jedi4ever/giraffe-web.js/raw/master/dist/giraffe-web-linux-x64.run">graphite-web-linux-x64.run</a></li> </ul> <p>Note: <a href="http://github.com/jedi4ever/bashpack">Bashpacks</a> are nodejs applications wrapped in a simple shell-executable.</p> <h2>Usage</h2> <p><a href="#jump-to-section">[Back To Top]</a></p> <h2>CLI options</h2> <pre><code>$ ./bin/giraffe-web Usage: giraffe-web [options] Options: -h, --help output usage information -V, --version output the version number -p, --port <port> port to listen on [9000] -c , --config-file [configFile] Giraffe dashboard.js file containing the dashboards --graphite-url [url] Graphite Host to connect to [http://localhost:8080] --proxy-graphite If enabled, this server will proxy graphite requests to the Graphite host specified [false]</code></pre> <h2>Running it</h2> <pre><code>./bin/giraffe-web -c dashboard.js --proxy-graphite --graphite-url=http://your-graphite-url</code></pre> <h2>Configuration</h2> <p><a href="#jump-to-section">[Back To Top]</a></p> <p>You need to create your own Giraffe <code>dashboards.js</code> file.</p> <p>Checkout the detailed description on configuring Giraffe</p> <p><a href="https://github.com/kenhub/giraffe#configuration">https://github.com/kenhub/giraffe#configuration</a></p> <h2>Building and Testing</h2> <p><a href="#jump-to-section">[Back To Top]</a></p> <p>We rely on Grunt tasks to do our job</p> <h2>Testing</h2> <pre><code>grunt test</code></pre> <p>We currently only lint testing</p> <h2>Updating Giraffe code</h2> <p>We fetch the giraffe into <code>vendor</code>/giraffe Updating can be done via</p> <pre><code>grunt bower</code></pre> <h2>Building Documentation</h2> <p>We generate the Readme and the Jsdocs</p> <pre><code>grunt docs</code></pre> <h2>Building Bashpacks</h2> <p>We generate two bashpacks (that go into dist)</p> <pre><code>grunt bashpack:linux grunt bashpack:darwin</code></pre> <h2>Releasing</h2> <p>Updates the package version, commits to git, pushes to github , adds tag , and publishes to npm</p> <pre><code>grunt gh-pages grunt release</code></pre> <h2>License</h2> <p><a href="#jump-to-section">[Back To Top]</a></p> <p>Copyright (c) 2010-2013 Patrick Debois</p> <p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p> <p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p> <p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p></article> </section> </div> <div class="clearfix"></div> <footer> </div> <div class="span3"> <div id="toc"></div> </div> <br clear="both"> </div> </div> <script src="scripts/sunlight.js"></script> <script src="scripts/sunlight.javascript.js"></script> <script src="scripts/sunlight-plugin.doclinks.js"></script> <script src="scripts/sunlight-plugin.linenumbers.js"></script> <script src="scripts/sunlight-plugin.menu.js"></script> <script src="scripts/jquery.min.js"></script> <script src="scripts/jquery.scrollTo.js"></script> <script src="scripts/jquery.localScroll.js"></script> <script src="scripts/bootstrap-dropdown.js"></script> <script src="scripts/toc.js"></script> <script> Sunlight.highlightAll({lineNumbers:true, showMenu: true, enableDoclinks :true}); </script> <script> $( function () { $( "#toc" ).toc( { selectors : "h1,h2,h3,h4", showAndHide : false, scrollTo : 60 } ); $( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" ); $( "#main span[id^='toc']" ).addClass( "toc-shim" ); } ); </script> </body> </html>