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