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