X-Git-Url: https://git.sesse.net/?p=cubemap;a=blobdiff_plain;f=README;h=029de77ff966abd7b4cd07c15945b8d380da8271;hp=a8692219df4f22ece9e19481597e76b1ed98b0f2;hb=d4f9b205e5091c496f0367dcd4dcc29e0a842f7f;hpb=aa3c6213114be76ab3adcfc3eeeed7865c746280

diff --git a/README b/README
index a869221..029de77 100644
--- a/README
+++ b/README
@@ -1,18 +1,20 @@
 Cubemap is a high-performance, high-availability video reflector,
-specifically made for use with VLC. It is currently in alpha stage.
+specifically made for use with VLC.
 
 A short list of features:
 
- - High-performance. Exactly how high-performance remains to be seen,
-   but it is designed to go to 10 Gbit/sec and beyond, through a
-   design with multiple worker threads, epoll and sendfile
-   (yes, sendfile).
+ - High-performance, through a design with multiple worker threads,
+   epoll and sendfile (yes, sendfile); a 2GHz quadcore can saturate
+   10 gigabit Ethernet, given a modern kernel, a modern NIC
+   and the right kernel tuning.
  - High-availability. You can change any part of the configuration
    (and even upgrade to a newer version of Cubemap) by changing cubemap.config
    and sending a SIGHUP; all clients will continue as if nothing had happened
    (unless you delete the stream they are watching, of course).
    Cubemap also survives the encoder dying and reconnecting.
  - Per-stream fwmark support, for TCP pacing through tc (separate config needed).
+ - Support for setting max pacing rate through the fq packet scheduler
+   (obsoletes the previous point, but depends on Linux 3.13 or newer).
  - Reflects anything VLC can reflect over HTTP, even the muxes VLC
    has problems reflecting itself (in particular, FLV).
  - IPv4 support. Yes, Cubemap even supports (some) legacy protocols.
@@ -42,6 +44,20 @@ are OK, and then exec() the new version, which deserializes everything and
 keeps going.
 
 
+Munin plugins:
+
+To activate these, symlink them into /etc/munin/plugins. If you don't put
+the files in the expected default locations (as done by 'make install'),
+you probably want some configuration in /etc/munin/plugin-conf.d/cubemap or
+similar, like this:
+
+[cubemap*]
+user <something>
+env.cubemap_config /etc/cubemap/cubemap.config
+env.cubemap_stats /var/lib/cubemap/cubemap.stats
+env.cubemap_input_stats /var/lib/cubemap/cubemap-input.stats
+
+
 Legalese: 
 
 Copyright 2013 Steinar H. Gunderson <sgunderson@bigfoot.com>.