git.sesse.net Git - cubemap/blob - README

   1 Cubemap is a high-performance, high-availability video reflector,
   2 specifically made for use with VLC.
   3
   4 A short list of features:
   5
   6  - High-performance, through a design with multiple worker threads,
   7    epoll and sendfile (yes, sendfile); a 2GHz quadcore can saturate
   8    10 gigabit Ethernet, given a modern kernel, a modern NIC
   9    and the right kernel tuning.
  10  - High-availability. You can change any part of the configuration
  11    (and even upgrade to a newer version of Cubemap) by changing cubemap.config
  12    and sending a SIGHUP; all clients will continue as if nothing had happened
  13    (unless you delete the stream they are watching, of course).
  14    Cubemap also survives the encoder dying and reconnecting.
  15  - Support for setting max pacing rate through the fq packet scheduler
  16    (depends on Linux 3.13 or newer).
  17  - Reflects anything VLC can reflect over HTTP, even the muxes VLC
  18    has problems reflecting itself (in particular, FLV).
  19  - Multicast support, both for sending and receiving (supports only protocols
  20    that can go over UDP, e.g. MPEG-TS). Supports both ASM and SSM.
  21  - IPv4 support. Yes, Cubemap even supports (some) legacy protocols.
  22
  23
  24 HOWTO:
  25
  26   sudo aptitude install libprotobuf-dev protobuf-compiler libsystemd-dev
  27   ./configure
  28   make -j4
  29
  30 If you want to use HTTP input (you probably want to), you want VLC 2.2.0
  31 or newer. Then start the VLC encoder with the “metacube” flag to the http
  32 access mux, like this:
  33
  34   cvlc [...] --sout '#std{access=http{metacube,mime=video/x-flv},mux=flv,dst=:4013/test.flv}'
  35
  36 Then look through cubemap.config.sample, copy it to cubemap.config,
  37 compile and start cubemap.
  38
  39 To upgrade cubemap (after you've compiled a new binary), or to pick up new
  40 config:
  41
  42   killall -HUP cubemap
  43
  44 Cubemap will serialize itself to disk, check that the new binary and config
  45 are OK, and then exec() the new version, which deserializes everything and
  46 keeps going.
  47
  48
  49 Munin plugins:
  50
  51 To activate these, symlink them into /etc/munin/plugins. If you don't put
  52 the files in the expected default locations (as done by 'make install'),
  53 you probably want some configuration in /etc/munin/plugin-conf.d/cubemap or
  54 similar, like this:
  55
  56 [cubemap*]
  57 user <something>
  58 env.cubemap_config /etc/cubemap/cubemap.config
  59 env.cubemap_stats /var/lib/cubemap/cubemap.stats
  60 env.cubemap_input_stats /var/lib/cubemap/cubemap-input.stats
  61
  62
  63 Legalese:
  64
  65 Copyright 2013 Steinar H. Gunderson <steinar+cubemap@gunderson.no>.
  66 Licensed under the GNU GPL, version 2. See the included COPYING file.