2017-01-26 18:52:54 +01:00
<!DOCTYPE html>
<!-- [if IE 8]><html class="no - js lt - ie9" lang="en" > <![endif] -->
<!-- [if gt IE 8]><! --> < html class = "no-js" lang = "en" > <!-- <![endif] -->
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< link rel = "shortcut icon" href = "../img/favicon.ico" >
< title > Plugins - Shaarli Documentation< / title >
< link href = 'https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel = 'stylesheet' type = 'text/css' >
< link rel = "stylesheet" href = "../css/theme.css" type = "text/css" / >
< link rel = "stylesheet" href = "../css/theme_extra.css" type = "text/css" / >
< link rel = "stylesheet" href = "../css/highlight.css" >
< link href = "../github-markdown.css" rel = "stylesheet" >
< script >
// Current page data
var mkdocs_page_name = "Plugins";
var mkdocs_page_input_path = "Plugins.md";
var mkdocs_page_url = "/Plugins/";
< / script >
< script src = "../js/jquery-2.1.1.min.js" > < / script >
< script src = "../js/modernizr-2.8.3.min.js" > < / script >
< script type = "text/javascript" src = "../js/highlight.pack.js" > < / script >
< / head >
< body class = "wy-body-for-nav" role = "document" >
< div class = "wy-grid-for-nav" >
< nav data-toggle = "wy-nav-shift" class = "wy-nav-side stickynav" >
< div class = "wy-side-nav-search" >
< a href = ".." class = "icon icon-home" > Shaarli Documentation< / a >
< div role = "search" >
< form id = "rtd-search-form" class = "wy-form" action = "../search.html" method = "get" >
< input type = "text" name = "q" placeholder = "Search docs" / >
< / form >
< / div >
< / div >
< div class = "wy-menu wy-menu-vertical" data-spy = "affix" role = "navigation" aria-label = "main navigation" >
< ul class = "current" >
< li class = "toctree-l1" >
< a class = "" href = ".." > Home< / a >
< / li >
< li class = "toctree-l1" >
< span class = "caption-text" > Setup< / span >
< ul class = "subnav" >
< li class = "" >
< a class = "" href = "../Download-and-Installation/" > Download and Installation< / a >
< / li >
< li class = "" >
< a class = "" href = "../Upgrade-and-migration/" > Upgrade and migration< / a >
< / li >
< li class = "" >
< a class = "" href = "../Server-requirements/" > Server requirements< / a >
< / li >
< li class = "" >
< a class = "" href = "../Server-configuration/" > Server configuration< / a >
< / li >
< li class = "" >
< a class = "" href = "../Server-security/" > Server security< / a >
< / li >
< li class = "" >
< a class = "" href = "../Shaarli-configuration/" > Shaarli configuration< / a >
< / li >
< li class = " current" >
< a class = "current" href = "./" > Plugins< / a >
< ul class = "subnav" >
< li class = "toctree-l3" > < a href = "#plugin-installation" > Plugin installation< / a > < / li >
< li class = "toctree-l3" > < a href = "#plugin-configuration" > Plugin configuration< / a > < / li >
< li class = "toctree-l3" > < a href = "#plugin-order" > Plugin order< / a > < / li >
< li class = "toctree-l3" > < a href = "#file-mode" > File mode< / a > < / li >
< ul >
< li > < a class = "toctree-l4" href = "#plugin-usage" > Plugin usage< / a > < / li >
< / ul >
< / ul >
< / li >
< / ul >
< / li >
< li class = "toctree-l1" >
< span class = "caption-text" > Docker< / span >
< ul class = "subnav" >
< li class = "" >
2017-07-29 15:29:54 +02:00
< a class = "" href = "../docker/docker-101/" > Docker 101< / a >
2017-01-26 18:52:54 +01:00
< / li >
< li class = "" >
2017-07-29 15:29:54 +02:00
< a class = "" href = "../docker/shaarli-images/" > Shaarli images< / a >
2017-01-26 18:52:54 +01:00
< / li >
< li class = "" >
2017-07-29 15:29:54 +02:00
< a class = "" href = "../docker/reverse-proxy-configuration/" > Reverse proxy configuration< / a >
2017-01-26 18:52:54 +01:00
< / li >
< li class = "" >
2017-07-29 15:29:54 +02:00
< a class = "" href = "../docker/resources/" > Docker resources< / a >
2017-01-26 18:52:54 +01:00
< / li >
< / ul >
< / li >
< li class = "toctree-l1" >
< span class = "caption-text" > Usage< / span >
< ul class = "subnav" >
< li class = "" >
< a class = "" href = "../Features/" > Features< / a >
< / li >
< li class = "" >
< a class = "" href = "../Bookmarklet/" > Bookmarklet< / a >
< / li >
< li class = "" >
< a class = "" href = "../Browsing-and-searching/" > Browsing and searching< / a >
< / li >
< li class = "" >
< a class = "" href = "../Firefox-share/" > Firefox share< / a >
< / li >
< li class = "" >
< a class = "" href = "../RSS-feeds/" > RSS feeds< / a >
< / li >
< li class = "" >
< a class = "" href = "../REST-API/" > REST API< / a >
< / li >
< / ul >
< / li >
< li class = "toctree-l1" >
< span class = "caption-text" > How To< / span >
< ul class = "subnav" >
< li class = "" >
< a class = "" href = "../Backup,-restore,-import-and-export/" > Backup, restore, import and export< / a >
< / li >
< li class = "" >
2017-06-18 06:32:30 +02:00
< a class = "" href = "../Various-hacks/" > Various hacks< / a >
2017-01-26 18:52:54 +01:00
< / li >
< / ul >
< / li >
< li class = "toctree-l1" >
< a class = "" href = "../Troubleshooting/" > Troubleshooting< / a >
< / li >
< li class = "toctree-l1" >
< span class = "caption-text" > Development< / span >
< ul class = "subnav" >
< li class = "" >
< a class = "" href = "../Development-guidelines/" > Development guidelines< / a >
< / li >
< li class = "" >
< a class = "" href = "../Continuous-integration-tools/" > Continuous integration tools< / a >
< / li >
< li class = "" >
< a class = "" href = "../GnuPG-signature/" > GnuPG signature< / a >
< / li >
< li class = "" >
< a class = "" href = "../Coding-guidelines/" > Coding guidelines< / a >
< / li >
< li class = "" >
< a class = "" href = "../Directory-structure/" > Directory structure< / a >
< / li >
< li class = "" >
< a class = "" href = "../3rd-party-libraries/" > 3rd party libraries< / a >
< / li >
< li class = "" >
< a class = "" href = "../Plugin-System/" > Plugin System< / a >
< / li >
< li class = "" >
< a class = "" href = "../Release-Shaarli/" > Release Shaarli< / a >
< / li >
< li class = "" >
< a class = "" href = "../Versioning-and-Branches/" > Versioning and Branches< / a >
< / li >
< li class = "" >
< a class = "" href = "../Security/" > Security< / a >
< / li >
< li class = "" >
< a class = "" href = "../Static-analysis/" > Static analysis< / a >
< / li >
< li class = "" >
< a class = "" href = "../Theming/" > Theming< / a >
< / li >
< li class = "" >
< a class = "" href = "../Unit-tests/" > Unit tests< / a >
< / li >
< / ul >
< / li >
< li class = "toctree-l1" >
< span class = "caption-text" > About< / span >
< ul class = "subnav" >
< li class = "" >
< a class = "" href = "../FAQ/" > FAQ< / a >
< / li >
< li class = "" >
< a class = "" href = "../Community-&-Related-software/" > Community & Related software< / a >
< / li >
< / ul >
< / li >
< / ul >
< / div >
< / nav >
< section data-toggle = "wy-nav-shift" class = "wy-nav-content-wrap" >
< nav class = "wy-nav-top" role = "navigation" aria-label = "top navigation" >
< i data-toggle = "wy-nav-top" class = "fa fa-bars" > < / i >
< a href = ".." > Shaarli Documentation< / a >
< / nav >
< div class = "wy-nav-content" >
< div class = "rst-content" >
< div role = "navigation" aria-label = "breadcrumbs navigation" >
< ul class = "wy-breadcrumbs" >
< li > < a href = ".." > Docs< / a > » < / li >
< li > Setup » < / li >
< li > Plugins< / li >
< li class = "wy-breadcrumbs-aside" >
< a href = "https://github.com/shaarli/Shaarli/edit/master/docs/Plugins.md"
class="icon icon-github"> Edit on GitHub< / a >
< / li >
< / ul >
< hr / >
< / div >
< div role = "main" >
< div class = "section" >
< h2 id = "plugin-installation" > Plugin installation< / h2 >
< p > There is a bunch of plugins shipped with Shaarli, where there is nothing to do to install them.< / p >
< p > If you want to install a third party plugin:< / p >
< ul >
< li > Download it.< / li >
< li > Put it in the < code > plugins< / code > directory in Shaarli's installation folder.< / li >
< li > Make sure you put it correctly:< / li >
< / ul >
< pre > < code > | index.php
| plugins/
|---| custom_plugin/
| |---| custom_plugin.php
| |---| ...
< / code > < / pre >
< ul >
< li > Make sure your webserver can read and write the files in your plugin folder.< / li >
< / ul >
< h2 id = "plugin-configuration" > Plugin configuration< / h2 >
< p > In Shaarli's administration page (< code > Tools< / code > link), go to < code > Plugin administration< / code > .< / p >
< p > Here you can enable and disable all plugins available, and configure them.< / p >
< p > < img alt = "administration screenshot" src = "https://camo.githubusercontent.com/5da68e191969007492ca0fbeb25f3b2357b748cc/687474703a2f2f692e696d6775722e636f6d2f766837544643712e706e67" / > < / p >
< h2 id = "plugin-order" > Plugin order< / h2 >
< p > In the plugin administration page, you can move enabled plugins to the top or bottom of the list. The first plugins in the list will be processed first.< / p >
< p > This is important in case plugins are depending on each other. Read plugins README details for more information.< / p >
< p > < strong > Use case< / strong > : The (non existent) plugin < code > shaares_footer< / code > adds a footer to every shaare in Markdown syntax. It needs to be processed < em > before< / em > (higher in the list) the Markdown plugin. Otherwise its syntax won't be translated in HTML.< / p >
< h2 id = "file-mode" > File mode< / h2 >
< p > Enabled plugin are stored in your < code > config.php< / code > parameters file, under the < code > array< / code > :< / p >
< pre > < code class = "php" > $GLOBALS['config']['ENABLED_PLUGINS']
< / code > < / pre >
< p > You can edit them manually here.
Example:< / p >
< pre > < code class = "php" > $GLOBALS['config']['ENABLED_PLUGINS'] = array(
'qrcode',
'archiveorg',
'wallabag',
'markdown',
);
< / code > < / pre >
< h3 id = "plugin-usage" > Plugin usage< / h3 >
< h4 id = "official-plugins" > Official plugins< / h4 >
< p > Usage of each plugin is documented in it's README file:< / p >
< ul >
< li > < code > addlink-toolbar< / code > : Adds the addlink input on the linklist page< / li >
< li > < code > archiveorg< / code > : For each link, add an Archive.org icon< / li >
< li > < a href = "https://github.com/shaarli/Shaarli/blob/master/plugins/markdown/README.md" > < code > markdown< / code > < / a > : Render shaare description with Markdown syntax.< / li >
< li > < a href = "https://github.com/shaarli/Shaarli/blob/master/plugins/playvideos/README.md" > < code > playvideos< / code > < / a > : Add a button in the toolbar allowing to watch all videos.< / li >
< li > < code > qrcode< / code > : For each link, add a QRCode icon.< / li >
< li > < a href = "https://github.com/shaarli/Shaarli/blob/master/plugins/wallabag/README.md" > < code > wallabag< / code > < / a > : For each link, add a Wallabag icon to save it in your instance.< / li >
< / ul >
< h4 id = "third-party-plugins" > Third party plugins< / h4 >
< p > See < a href = "https://github.com/shaarli/Shaarli/wiki/Community-%26-Related-software#third-party-plugins" > Community & related software< / a > < / p >
< / div >
< / div >
< footer >
< div class = "rst-footer-buttons" role = "navigation" aria-label = "footer navigation" >
2017-07-29 15:29:54 +02:00
< a href = "../docker/docker-101/" class = "btn btn-neutral float-right" title = "Docker 101" > Next < span class = "icon icon-circle-arrow-right" > < / span > < / a >
2017-01-26 18:52:54 +01:00
< a href = "../Shaarli-configuration/" class = "btn btn-neutral" title = "Shaarli configuration" > < span class = "icon icon-circle-arrow-left" > < / span > Previous< / a >
< / div >
< hr / >
< div role = "contentinfo" >
<!-- Copyright etc -->
< / div >
Built with < a href = "http://www.mkdocs.org" > MkDocs< / a > using a < a href = "https://github.com/snide/sphinx_rtd_theme" > theme< / a > provided by < a href = "https://readthedocs.org" > Read the Docs< / a > .
< / footer >
< / div >
< / div >
< / section >
< / div >
< div class = "rst-versions" role = "note" style = "cursor: pointer" >
< span class = "rst-current-version" data-toggle = "rst-current-version" >
< a href = "https://github.com/shaarli/Shaarli" class = "fa fa-github" style = "float: left; color: #fcfcfc" > GitHub< / a >
< span > < a href = "../Shaarli-configuration/" style = "color: #fcfcfc;" > « Previous< / a > < / span >
2017-07-29 15:29:54 +02:00
< span style = "margin-left: 15px" > < a href = "../docker/docker-101/" style = "color: #fcfcfc" > Next » < / a > < / span >
2017-01-26 18:52:54 +01:00
< / span >
< / div >
< script src = "../js/theme.js" > < / script >
< / body >
< / html >
