playVideoOnDreambox as WebExtension
[playVideoOnDreambox.git] / README.rst
1 *************************************
2 playVideoOnDreambox Firefox extension
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 Dependencies
36 ============
37 You need to have the playVideoOnDreamboxProxy software running in your
38 network.
39 It will do the heavy lifting of extracting the video URL from the website
40 and sending it to the dreambox.
41
42 This browser extension only sends the current tab URL to this proxy service.
43
44 In the extension settings, configure the proxy URL (it ends with ``play.php``).
45
46
47 License
48 =======
49 ``playVideoOnDreambox`` is licensed under the `GPL v3`__ or later.
50
51 __ http://www.gnu.org/licenses/gpl.html
52
53
54 Homepage
55 ========
56 Web site
57   http://cweiske.de/playVideoOnDreambox.htm#firefox
58 Source code
59   http://git.cweiske.de/playVideoOnDreambox.git
60
61   Mirror: https://github.com/cweiske/playVideoOnDreambox
62 Firefox Add-ons site
63   https://addons.mozilla.org/de/firefox/addon/play-video-on-dreambox/
64 Dreambox forum thread
65   http://www.dream-multimedia-tv.de/board/index.php?page=Thread&threadID=20224
66
67
68 Author
69 ======
70 Written by Christian Weiske, cweiske@cweiske.de