filter out HLS streams
[playVideoOnDreamboxProxy.git] / README.rst
1 ***********************************
2 Play video on Dreambox proxy server
3 ***********************************
4 Server for the `"Play video on Dreambox" android app`__.
5
6 Accepts an URL, runs `youtube-dl`__ on it to extract the video
7 URL and lets the Dreambox__ satellite receiver play this file.
8
9
10 __ http://cweiske.de/playVideoOnDreambox.htm#android
11 __ http://rg3.github.io/youtube-dl/
12 __ http://dream-multimedia-tv.de/
13
14
15 =====
16 Setup
17 =====
18 Point your web server's document root to the ``www/`` directory.
19
20 Altenatively symlink the ``www/play.php`` file into your document root
21 directory.
22
23
24 Configuration
25 =============
26 You can adjust the path to ``youtube-dl`` and the Dreambox host name
27 or IP address by creating a config file in ``data/config.php``.
28
29 Simply copy ``data/config.php.dist`` onto ``data/config.php`` and adjust it.
30
31
32 =====
33 Usage
34 =====
35 Send the web site URL via POST to ``play.php``::
36
37     $ curl -XPOST --data http://example.org/page.htm\
38           -H 'Content-type: text/plain'\
39           http://proxy.example.org/play.php
40
41
42 =======
43 License
44 =======
45 This application is available under the `AGPL v3`__ or later.
46
47 __ http://www.gnu.org/licenses/agpl.html
48
49
50 ======
51 Author
52 ======
53 Written by `Christian Weiske`__, cweiske@cweiske.de
54
55 __ http://cweiske.de/