Support joining multicast addresses (both ASM and SSM).

[cubemap] / README

diff --git a/README b/README
index 4410010d148cde515898ffb7af9b49ddff91a97b..69efbc733cacccf80de21a7c8e59fd2892c451c5 100644 (file)
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
 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:
 
@@ -12,9 +12,12 @@ A short list of features:
    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
+   (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).
+ - Multicast support, both for sending and receiving (supports only protocols
+   that can go over UDP, e.g. MPEG-TS). Supports both ASM and SSM.
  - IPv4 support. Yes, Cubemap even supports (some) legacy protocols.
 
 
@@ -23,9 +26,9 @@ HOWTO:
   sudo aptitude install libprotobuf-dev protobuf-compiler
   make -j4
 
-If you want to use HTTP input (you probably want to), patch VLC with the
-included file vlc-metacube.diff. Then start the VLC encoder with the
-“metacube” flag to the http access mux, like this:
+If you want to use HTTP input (you probably want to), you want VLC 2.2.0
+or newer. Then start the VLC encoder with the “metacube” flag to the http
+access mux, like this:
 
   cvlc [...] --sout '#std{access=http{metacube,mime=video/x-flv},mux=flv,dst=:4013/test.flv}'
 
@@ -42,6 +45,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>.