Merge pull request #1234 from virtualtam/lint

[github/shaarli/Shaarli.git] / plugins / playvideos / README.md

diff --git a/plugins/playvideos/README.md b/plugins/playvideos/README.md
index ec1ead8d4c8f3e43ec4b667e6bca48a255e7f55b..ab4be22a46b5ad2a222fb84e1bae5ca4af40e745 100644 (file)
--- a/plugins/playvideos/README.md
+++ b/plugins/playvideos/README.md
@@ -1,21 +1,29 @@
 ### ► 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 https://shaarli.readthedocs.io/en/master/Shaarli-configuration/
 
-    $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'"`
+
+In `/etc/apache2/conf-available/shaarli-csp.conf`:
+
+```apache
+<Directory /path/to/shaarli>
+    Header set Content-Security-Policy "script-src 'self' 'unsafe-inline' https://www.youtube.com https://s.ytimg.com 'unsafe-eval'"
+</Directory>
+```
+
+Then run `a2enconf shaarli-csp; service apache2 reload`
 
 ### License
 ```
@@ -68,4 +76,4 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 
 ----------------------------------------------------
-```
\ No newline at end of file
+```