diff options
Diffstat (limited to 'plugins/playvideos/README.md')
-rw-r--r-- | plugins/playvideos/README.md | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/plugins/playvideos/README.md b/plugins/playvideos/README.md new file mode 100644 index 00000000..ec1ead8d --- /dev/null +++ b/plugins/playvideos/README.md | |||
@@ -0,0 +1,71 @@ | |||
1 | ### ► Play Videos plugin for Shaarli | ||
2 | This plugin adds a `► Play Videos` button to [Shaarli](https://github.com/shaarli/Shaarli)'s toolbar. Click this button to play all videos on the page in an overlay HTML5 player. Nice for continuous stream of music, documentaries, talks... | ||
3 | |||
4 | This uses code from https://zaius.github.io/youtube_playlist/ and is currently only compatible with Youtube videos. | ||
5 | |||
6 | ![](https://cdn.mediacru.sh/D_izf0zjAtxy.png) | ||
7 | |||
8 | #### Installation and setup | ||
9 | Place the files in the `tpl/plugins/playvideos/` directory of your Shaarli. | ||
10 | This is a default Shaarli plugin, you just have to enable it. | ||
11 | |||
12 | To enable the plugin, add `playvideos` to the `TOOLBAR_PLUGINS` config option in your `index.php` or `data/options.php`. Example: | ||
13 | |||
14 | $GLOBALS['config']['TOOLBAR_PLUGINS'] = array('aplugins', 'anotherone', 'playvideos'); | ||
15 | |||
16 | #### Troubleshooting | ||
17 | If your server has [Content Security Policy](http://content-security-policy.com/) headers enabled, this may prevent the script from loading fully. You should relax the CSP in your server settings. Example CSP rule for apache2: | ||
18 | `Header set Content-Security-Policy "script-src 'self' 'unsafe-inline' https://www.youtube.com https://s.ytimg.com 'unsafe-eval'"` | ||
19 | |||
20 | ### License | ||
21 | ``` | ||
22 | File: youtube_playlist.js | ||
23 | Copyright: (c) 2010-2014, David Kelso <david@kelso.id.au> | ||
24 | License: The ISC License (http://opensource.org/licenses/ISC) | ||
25 | |||
26 | Files: jquery*.js | ||
27 | License: MIT License (http://opensource.org/licenses/MIT) | ||
28 | Copyright: (C) jQuery Foundation and other contributors, https://jquery.com/download/ | ||
29 | |||
30 | ----------------------------------------------------- | ||
31 | |||
32 | The ISC License (http://opensource.org/licenses/ISC) | ||
33 | |||
34 | Copyright (c) 2010-2014, David Kelso (david at kelso dot id dot au) | ||
35 | Copyright (c) 2010-2014, nodiscc (nodiscc at gmail dot com) | ||
36 | |||
37 | Permission to use, copy, modify, and/or distribute this software for any | ||
38 | purpose with or without fee is hereby granted, provided that the above | ||
39 | copyright notice and this permission notice appear in all copies. | ||
40 | |||
41 | THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES | ||
42 | WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | ||
43 | MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR | ||
44 | ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | ||
45 | WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | ||
46 | ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | ||
47 | OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE | ||
48 | |||
49 | ---------------------------------------------------- | ||
50 | MIT LICENSE | ||
51 | |||
52 | Permission is hereby granted, free of charge, to any person obtaining a copy | ||
53 | of this software and associated documentation files (the "Software"), to deal | ||
54 | in the Software without restriction, including without limitation the rights | ||
55 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
56 | copies of the Software, and to permit persons to whom the Software is | ||
57 | furnished to do so, subject to the following conditions: | ||
58 | |||
59 | The above copyright notice and this permission notice shall be included in | ||
60 | all copies or substantial portions of the Software. | ||
61 | |||
62 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
63 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
64 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
65 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
66 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
67 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
68 | THE SOFTWARE. | ||
69 | |||
70 | ---------------------------------------------------- | ||
71 | ``` \ No newline at end of file | ||