]> git.immae.eu Git - github/shaarli/Shaarli.git/blobdiff - plugins/playvideos/README.md
**General rewording, proof-reading, deduplication, shortening, reordering, simplifica...
[github/shaarli/Shaarli.git] / plugins / playvideos / README.md
index ec1ead8d4c8f3e43ec4b667e6bca48a255e7f55b..32a94e88080c31849b01e1acdcaa10677363eda2 100644 (file)
@@ -1,21 +1,28 @@
 ### ► Play Videos plugin for Shaarli
-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...
 
-This uses code from https://zaius.github.io/youtube_playlist/ and is currently only compatible with Youtube videos.
+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...
+
+<!-- TODO screenshot -->
 
-![](https://cdn.mediacru.sh/D_izf0zjAtxy.png)
+This uses code from https://zaius.github.io/youtube_playlist/ and is currently only compatible with Youtube videos.
 
 #### Installation and setup
-Place the files in the `tpl/plugins/playvideos/` directory of your Shaarli.
-This is a default Shaarli plugin, you just have to enable it.
 
-To enable the plugin, add `playvideos` to the `TOOLBAR_PLUGINS` config option in your `index.php` or `data/options.php`. Example:
+This is a default Shaarli plugin, you just have to enable it. See [Shaarli configuration](../../doc/md/Shaarli-configuration.md).
 
-    $GLOBALS['config']['TOOLBAR_PLUGINS'] = array('aplugins', 'anotherone', 'playvideos');
 
 #### Troubleshooting
-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:
-`Header set Content-Security-Policy "script-src 'self' 'unsafe-inline' https://www.youtube.com https://s.ytimg.com 'unsafe-eval'"`
+
+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: 
+
+```apache
+<Directory /path/to/shaarli>
+    # Required for playvideos plugin
+    Header set Content-Security-Policy "script-src 'self' 'unsafe-inline' https://www.youtube.com https://s.ytimg.com 'unsafe-eval'"
+</Directory>
+```
+
+You may place the `Header` directive in the `<Directory...` section of your [webserver configuration](../../doc/md/Server-configuration.md)/virtualhost file, or write the above snippet to `/etc/apache2/conf-available/shaarli-csp.conf`; then run `a2enconf shaarli-csp; service apache2 reload`.
 
 ### License
 ```
@@ -68,4 +75,4 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 
 ----------------------------------------------------
-```
\ No newline at end of file
+```