Update performance claims in README.
[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 (even with TLS) given a modern kernel.
9  - High-availability. You can change any part of the configuration
10    (and even upgrade to a newer version of Cubemap) by changing cubemap.config
11    and sending a SIGHUP; all clients will continue as if nothing had happened
12    (unless you delete the stream they are watching, of course).
13    Cubemap also survives the encoder dying and reconnecting.
14  - Support for setting max pacing rate through the fq packet scheduler
15    (depends on Linux 3.13 or newer).
16  - Reflects anything VLC can reflect over HTTP, even the muxes VLC
17    has problems reflecting itself (in particular, FLV).
18  - Multicast support, both for sending and receiving (supports only protocols
19    that can go over UDP, e.g. MPEG-TS). Supports both ASM and SSM.
20  - TLS output support, through the TLSe library (requires libtomcrypt)
21    and the Linux kernel's kTLS (Linux 4.13 or newer). There are a few
22    limitations; see below.
23  - IPv4 support. Yes, Cubemap even supports (some) legacy protocols.
24
25
26 HOWTO:
27
28   sudo apt install libprotobuf-dev protobuf-compiler libsystemd-dev libtomcrypt-dev
29   ./configure
30   make -j4
31
32 If you want to use HTTP input (you probably want to), you want VLC 2.2.0
33 or newer. Then start the VLC encoder with the “metacube” flag to the http
34 access mux, like this:
35
36   cvlc [...] --sout '#std{access=http{metacube,mime=video/x-flv},mux=flv,dst=:4013/test.flv}'
37
38 Then look through cubemap.config.sample, copy it to cubemap.config,
39 compile and start cubemap.
40
41 To upgrade cubemap (after you've compiled a new binary), or to pick up new
42 config:
43
44   killall -HUP cubemap
45
46 Cubemap will serialize itself to disk, check that the new binary and config
47 are OK, and then exec() the new version, which deserializes everything and
48 keeps going.
49
50
51 Notes on TLS support:
52
53 Cubemap supports TLS on output, so that you can play video on TLS
54 web sites without issues with mixed content. TLS on input streams is
55 not (yet) supported.
56
57 TLS requires kTLS, ie., Linux >= 4.13 with CONFIG_TLS enabled. Only cipher
58 suites supported by kTLS is supposed, ie., AES-128-GCM (if no such cipher
59 suite is available, the connection will be aborted). If the server is restarted
60 before the key exchange for a connection is completed, that connection will
61 not survive the restart, unlike all other connections. (This is a TLSe
62 limitation.) You can have different certificates on different ports (and
63 have separate ports for TLS and non-TLS), but SNI is not yet supported.
64
65
66 Munin plugins:
67
68 To activate these, symlink them into /etc/munin/plugins. If you don't put
69 the files in the expected default locations (as done by 'make install'),
70 you probably want some configuration in /etc/munin/plugin-conf.d/cubemap or
71 similar, like this:
72
73 [cubemap*]
74 user <something>
75 env.cubemap_config /etc/cubemap/cubemap.config
76 env.cubemap_stats /var/lib/cubemap/cubemap.stats
77 env.cubemap_input_stats /var/lib/cubemap/cubemap-input.stats
78
79
80 Legalese: 
81
82 Copyright 2013 Steinar H. Gunderson <steinar+cubemap@gunderson.no>.
83 Licensed under the GNU GPL, version 2. See the included COPYING file.
84
85 See tlse/LICENSE for TLSe licensing.