Support SO_MAX_PACING_RATE.
[cubemap] / 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  - Per-stream fwmark support, for TCP pacing through tc (separate config needed).
16  - Support for setting max pacing rate through the fq packet scheduler
17    (obsoletes the previous point, but depends on experimental kernel patches
18    that will hit Linux in 3.13 at the earliest)
19  - Reflects anything VLC can reflect over HTTP, even the muxes VLC
20    has problems reflecting itself (in particular, FLV).
21  - IPv4 support. Yes, Cubemap even supports (some) legacy protocols.
22
23
24 HOWTO:
25
26   sudo aptitude install libprotobuf-dev protobuf-compiler
27   make -j4
28
29 If you want to use HTTP input (you probably want to), patch VLC with the
30 included file vlc-metacube.diff. Then start the VLC encoder with the
31 “metacube” flag to the http access mux, like this:
32
33   cvlc [...] --sout '#std{access=http{metacube,mime=video/x-flv},mux=flv,dst=:4013/test.flv}'
34
35 Then look through cubemap.config.sample, copy it to cubemap.config,
36 compile and start cubemap.
37
38 To upgrade cubemap (after you've compiled a new binary), or to pick up new
39 config:
40
41   killall -HUP cubemap
42
43 Cubemap will serialize itself to disk, check that the new binary and config
44 are OK, and then exec() the new version, which deserializes everything and
45 keeps going.
46
47
48 Munin plugins:
49
50 To activate these, symlink them into /etc/munin/plugins. If you don't put
51 the files in the expected default locations (as done by 'make install'),
52 you probably want some configuration in /etc/munin/plugin-conf.d/cubemap or
53 similar, like this:
54
55 [cubemap*]
56 user <something>
57 env.cubemap_config /etc/cubemap/cubemap.config
58 env.cubemap_stats /var/lib/cubemap/cubemap.stats
59 env.cubemap_input_stats /var/lib/cubemap/cubemap-input.stats
60
61
62 Legalese: 
63
64 Copyright 2013 Steinar H. Gunderson <sgunderson@bigfoot.com>.
65 Licensed under the GNU GPL, version 2. See the included COPYING file.