Update README and development docs
[playVideoOnDreambox.git] / README.rst
1 **********************
2 Play video on Dreambox
3 **********************
4
5 Firefox__ browser 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 __ https://www.mozilla.org/firefox
17 __ http://www.dream-multimedia-tv.de/products
18 __ http://www.dream-multimedia-tv.de/dm7080-hd
19
20 .. contents::
21
22
23 Features
24 ========
25 - Toolbar button to play the video on the current page
26 - Context menu item to play the video on the linked page.
27   Nice for video lists; no need to access the detail page anymore.
28 - Dreambox web interface access token support
29 - Supports hundreds of video sites, see the `youtube-dl site support list`__.
30 - Errors are displayed via the operating system's notification system
31
32 __ http://rg3.github.io/youtube-dl/supportedsites.html
33
34
35 Configuration options
36 =====================
37 In the addons manager
38
39 youtube-dl path
40   Full path to the ``youtube-dl`` executable, e.g. ``/usr/bin/youtube-dl``
41 Dreambox IP/host name
42   IP address of your dreambox satellite receiver, e.g. ``192.168.1.21``
43
44
45 Dependencies
46 ============
47 ``youtube-dl``
48   for video URL extraction.
49
50   Installable on a standard Debian/Ubuntu system via::
51
52     $ apt-get install youtube-dl
53
54   https://github.com/rg3/youtube-dl
55
56   The version packaged in the Debian repository is pretty old;
57   it's better to use the recent PyPi version::
58
59     $ pip install youtube-dl
60
61 Dreambox extensions
62   The following extensions have to be installed on your Dreambox:
63
64   - Media Player (``enigma2-plugin-extensions-mediaplayer``)
65   - Webinterface (``enigma2-plugin-extensions-webinterface``)
66
67
68 License
69 =======
70 ``playVideoOnDreambox`` is licensed under the `GPL v3`__ or later.
71
72 __ http://www.gnu.org/licenses/gpl.html
73
74
75 Homepage
76 ========
77 Web site
78   http://cweiske.de/playVideoOnDreambox.htm
79 Source code
80   http://git.cweiske.de/playVideoOnDreambox.git
81
82   Mirror: https://github.com/cweiske/playVideoOnDreambox
83 Firefox Add-ons site
84   https://addons.mozilla.org/de/firefox/addon/play-video-on-dreambox/
85 Dreambox forum thread
86   http://www.dream-multimedia-tv.de/board/index.php?page=Thread&threadID=20224
87
88
89 Author
90 ======
91 Written by Christian Weiske, cweiske@cweiske.de
92
93
94 Alternatives
95 ============
96 - `MovieStreamer v1.3 - Internet-Filme auf der Box abspielen.`__
97
98 __ http://www.dream-multimedia-tv.de/board/index.php?page=Thread&threadID=17776