visage-app 0.2.0 → 0.2.1

data/README.md

@@ -25,56 +25,41 @@ Or check out [a live demo](http://visage.unstated.net/nadia/cpu+load).
 Installing
 ----------
 
+N.B: Visage must be deployed on a machine where `collectd` stores its stats in RRD.
+
 On Ubuntu, to install dependencies run:
 
-    $ sudo apt-get install -y librrd-ruby ruby rubygems
+    $ sudo apt-get install -y librrd-ruby ruby ruby-dev rubygems collectd
 
 On CentOS, to install dependencies run:
 
-    $ sudo yum install -y rrdtool ruby rubygems
+    $ sudo yum install -y rrdtool ruby rubygems collectd
 
 Then install the app with:
 
     $ gem install visage-app
 
-
 Running
 -------
 
-You can try out the application quickly with:
+You can try out Visage quickly with:
 
     $ visage start
 
-Configuring
------------
-
-Config lives in several files under `config/`.
-
- * `profiles.yaml` - groups of graphs Visage is to display
- * `plugin-colors.yaml` - colors for specific plugins/plugin instances
- * `fallback-colors.yaml` - ordered list of fallback colors
- * `init.rb` - bootstrapping code, specifies collectd's RRD directory
-
-`profiles.yaml` isn't setup by default, but you can copy `profiles.yaml.sample`
-across and edit to taste. The plugins are in the format of
-`plugin/plugin-instance`, with `plugins-instance` being optional.
+Then paste the URL from the output into your browser.
 
-If you don't specify a `plugin-instance` Visage will attempt to graph all plugin
-instances under the specified `plugin`, e.g. `cpu-0` will display `cpu-idle`,
-`cpu-interrupt`, `cpu-nice`, etc, whereas `cpu-0/cpu-wait` will only show
-`cpu-wait`. You can also choose a specific group of plugin instances to graph,
-with something like `cpu-0/cpu-system/cpu-user/cpu-wait`.
+If you get a `command not found` when running the above command (RubyGems likely
+isn't on your PATH), try this instead:
 
-It should be pretty easy to deduce the config format from the existing file
-(it's simple nested key-value data).
-
-Make sure collectd's RRD directory is readable by whatever user the web server
-is running as. You can specify where collectd's rrd directory is in `init.rb`,
-with the `c['rrddir']` key.
+    $ $(dirname $(dirname $(gem which visage-app)))/bin/visage start
 
 Deploying
 ---------
 
+Visage can be deployed on Apache with Passenger:
+
+    $ sudo apt-get install libapache2-mod-passenger
+
 Visage can attempt to generate an Apache vhost config for use with Passenger:
 
     $ visage genapache
@@ -94,9 +79,29 @@ Visage can attempt to generate an Apache vhost config for use with Passenger:
 
 Copypasta this into your system's Apache config structure and tune to taste.
 
-Ubuntu users looking for Passenger packages should add John Ferlito's
-[mod-passenger PPA](https://launchpad.net/~johnf-inodes/+archive/mod-passenger)
-to their apt sources.
+To do this on Debian/Ubuntu:
+
+    $ sudo -s
+    $ visage genapache > /etc/apache2/sites-enabled/visage
+    $ a2dissite default
+    $ service apache2 reload
+
+Then head to your Apache instance and Visage will be up and running.
+
+Configuring
+-----------
+
+On the off chance you need to tweak Visage's configuration, it lives in several files
+under `lib/visage/config/`.
+
+ * `plugin-colors.yaml` - colors for specific plugins/plugin instances
+ * `fallback-colors.yaml` - ordered list of fallback colors
+ * `init.rb` - bootstrapping code, specifies collectd's RRD directory
+
+Make sure collectd's RRD directory is readable by whatever user the web server
+is running as. You can specify where collectd's rrd directory is in `init.rb`,
+with the `c['rrddir']` key.
+
 
 Developing + testing
 --------------------

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/bin/visage

@@ -2,6 +2,9 @@
 
 require 'pathname'
 
+require 'socket'
+fqdn = Socket.gethostbyname(Socket.gethostname).first
+
 @root = Pathname.new(File.dirname(__FILE__)).parent.expand_path
 action = ARGV[0]
 
@@ -9,6 +12,17 @@ case action
 when "start"
   require 'rubygems'
   require 'rack'
+
+  puts ' _    ___'
+  puts '| |  / (_)________ _____ ____'
+  puts '| | / / / ___/ __ `/ __ `/ _ \\'
+  puts '| |/ / (__  ) /_/ / /_/ /  __/'
+  puts '|___/_/____/\__,_/\__, /\___/'
+  puts '                 /____/'
+  puts
+  puts "will be running at http://#{fqdn}:9292/"
+  puts
+
   config = @root.join('lib/visage/config.ru').to_s
   server = Rack::Server.new(:config => config, :Port => 9292)
   server.start

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Lindsay Holmwood