add dreambox extension dependencies
[playVideoOnDreambox.git] / README.rst
1 **********************
2 Play video on Dreambox
3 **********************
4
5 Firefox addon (extension) that adds a "Play on Dreambox" button to the
6 toolbar.
7 Pressing it plays the video of the current tab on your Dreambox__ satellite
8 receiver.
9
10 Works fine with a Dreambox `DM7080 HD`__.
11
12 You can also right-click a link to a video page and select
13 "Play linked video on Dreambox".
14 That way you don't even need to open video detail pages.
15
16 __ http://www.dream-multimedia-tv.de/products
17 __ http://www.dream-multimedia-tv.de/dm7080-hd
18
19 .. contents::
20
21
22 Features
23 ========
24 - Toolbar button to play the video on the current page
25 - Context menu item to play the video on the linked page.
26   Nice for video lists; no need to access the detail page anymore.
27 - Dreambox web interface access token support
28 - Supports hundreds of video sites, see the `youtube-dl site support list`__.
29 - Errors are displayed via the operating system's notification system
30
31 __ http://rg3.github.io/youtube-dl/supportedsites.html
32
33
34 Configuration options
35 =====================
36 In the addons manager
37
38 youtube-dl path
39   Full path to the ``youtube-dl`` executable, e.g. ``/usr/bin/youtube-dl``
40 Dreambox IP/host name
41   IP address of your dreambox satellite receiver, e.g. ``192.168.1.21``
42
43
44 Dependencies
45 ============
46 ``youtube-dl``
47   for video URL extraction.
48
49   Installable on a standard Debian/Ubuntu system via::
50
51     $ apt-get install youtube-dl
52
53   https://github.com/rg3/youtube-dl
54 Dreambox extensions
55   The following extensions have to be installed on your Dreambox:
56
57   - Media Player (``enigma2-plugin-extensions-mediaplayer``)
58   - Webinterface (``enigma2-plugin-extensions-webinterface``)
59
60
61 License
62 =======
63 ``playVideoOnDreambox`` is licensed under the `GPL v3`__ or later.
64
65 __ http://www.gnu.org/licenses/gpl.html
66
67
68 Homepage
69 ========
70 Web site
71   http://cweiske.de/playVideoOnDreambox.htm
72 Source code
73   http://git.cweiske.de/playVideoOnDreambox.git
74
75   Mirror: https://github.com/cweiske/playVideoOnDreambox
76 Firefox Add-ons site
77   https://addons.mozilla.org/de/firefox/addon/play-video-on-dreambox/
78 Dreambox forum thread
79   http://www.dream-multimedia-tv.de/board/index.php?page=Thread&threadID=20224
80
81
82 Author
83 ======
84 Written by Christian Weiske, cweiske@cweiske.de
85
86
87 Alternatives
88 ============
89 - `MovieStreamer v1.3 - Internet-Filme auf der Box abspielen.`__
90
91 __ http://www.dream-multimedia-tv.de/board/index.php?page=Thread&threadID=17776