Fix E_NOTICES on php 8.2
[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 If your dreambox web interface is password protected, add the username
32 and password to the ``$dreamboxUrl`` configuration variable::
33
34   $dreamboxUrl = 'http://user:pass@dreambox';
35
36
37 =====
38 Usage
39 =====
40 Send the web site URL via POST to ``play.php``::
41
42     $ curl -XPOST --data http://example.org/page.htm\
43           -H 'Content-type: text/plain'\
44           http://proxy.example.org/play.php
45
46 You can test it on command line, too::
47
48     $ php www/play.php http://example.org/page.htm
49
50 Testing the URL selection without playing on the dreambox is possible::
51
52     $ php www/play.php http://example.org/page.htm --dry-run
53
54
55 =======
56 License
57 =======
58 This application is available under the `AGPL v3`__ or later.
59
60 __ http://www.gnu.org/licenses/agpl.html
61
62
63 ======
64 Author
65 ======
66 Written by `Christian Weiske`__, cweiske@cweiske.de
67
68 __ http://cweiske.de/