visage-app 0.3.0 → 0.3.1

data/README.md

@@ -91,17 +91,43 @@ 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/`.
+Visage looks for two environment variables when starting up:
 
- * `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
+  * `CONFIG_PATH`, an entry on the configuration file search path
+  * `RRDDIR`, the location of collectd's RRDs
 
-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.
+Visage has a configuration search path which can be used for overriding
+individual files. By default it has one entry: `$VISAGE_ROOT/lib/visage/config/`.
+You can set the `CONFIG_PATH` environment variable to add another directory to
+the config load path. This directory will be searched when loading up
+configuration files.
 
+    CONFIG_PATH=/var/lib/visage visage
+
+This is especially useful when you want to deploy + run Visage from an installed
+gem with Passenger. e.g.
+
+    <VirtualHost *:80>
+      ServerName monitoring.example.org
+      ServerAdmin me@example.org
+
+      SetEnv CONFIG_PATH /var/lib/visage
+      SetEnv RRDDIR /opt/collectd/var/lib/collectd
+
+      DocumentRoot /var/lib/gems/1.8/gems/visage-app-0.3.0/lib/visage/public
+      <Directory />
+        Options FollowSymLinks
+        AllowOverride None
+      </Directory>
+
+      LogFormat "%h %l %u %t \"%r\" %>s %b" common
+      CustomLog /var/log/apache2/access.log common
+    </VirtualHost>
+
+Also to keep in mind when deploying with Passenger, the `CONFIG_PATH` directory
+and its files need to have the correct ownership:
+
+    chown nobody:nogroup -R /var/lib/visage
 
 Developing + testing
 --------------------
@@ -126,12 +152,3 @@ Run all cucumber features:
 
     $ rake cucumber
 
-TODO
-----
-
- * make other lines slightly opaque when hovering over labels
- * detailed point-in-time data on hover (timestamp, value)
- * give graph profile an alternate private url
- * make notes/annotations on private url
- * include table of axis mappings + default y-axis heights for rendering
- * view metrics from multiple hosts on the same graph

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Lindsay Holmwood
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-15 00:00:00 +11:00
+date: 2010-10-18 00:00:00 +11:00
 default_executable: visage
 dependencies: 
 - !ruby/object:Gem::Dependency