2 <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
3 <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
6 <meta http-equiv=
"X-UA-Compatible" content=
"IE=edge">
7 <meta name=
"viewport" content=
"width=device-width, initial-scale=1.0">
10 <link rel=
"shortcut icon" href=
"../img/favicon.ico">
11 <title>Plugins - Shaarli Documentation
</title>
12 <link href='https://fonts.googleapis.com/css?family=Lato:
400,
700|Roboto+Slab:
400,
700|Inconsolata:
400,
700' rel='stylesheet' type='text/css'
>
14 <link rel=
"stylesheet" href=
"../css/theme.css" type=
"text/css" />
15 <link rel=
"stylesheet" href=
"../css/theme_extra.css" type=
"text/css" />
16 <link rel=
"stylesheet" href=
"../css/highlight.css">
17 <link href=
"../github-markdown.css" rel=
"stylesheet">
21 var mkdocs_page_name = "Plugins";
22 var mkdocs_page_input_path = "Plugins.md";
23 var mkdocs_page_url = "/Plugins/";
26 <script src=
"../js/jquery-2.1.1.min.js"></script>
27 <script src=
"../js/modernizr-2.8.3.min.js"></script>
28 <script type=
"text/javascript" src=
"../js/highlight.pack.js"></script>
32 <body class=
"wy-body-for-nav" role=
"document">
34 <div class=
"wy-grid-for-nav">
37 <nav data-toggle=
"wy-nav-shift" class=
"wy-nav-side stickynav">
38 <div class=
"wy-side-nav-search">
39 <a href=
".." class=
"icon icon-home"> Shaarli Documentation
</a>
41 <form id =
"rtd-search-form" class=
"wy-form" action=
"../search.html" method=
"get">
42 <input type=
"text" name=
"q" placeholder=
"Search docs" />
47 <div class=
"wy-menu wy-menu-vertical" data-spy=
"affix" role=
"navigation" aria-label=
"main navigation">
51 <li class=
"toctree-l1">
53 <a class=
"" href=
"..">Home
</a>
56 <li class=
"toctree-l1">
58 <span class=
"caption-text">Setup
</span>
62 <a class=
"" href=
"../Download-and-Installation/">Download and Installation
</a>
66 <a class=
"" href=
"../Upgrade-and-migration/">Upgrade and migration
</a>
70 <a class=
"" href=
"../Server-requirements/">Server requirements
</a>
74 <a class=
"" href=
"../Server-configuration/">Server configuration
</a>
78 <a class=
"" href=
"../Server-security/">Server security
</a>
82 <a class=
"" href=
"../Shaarli-configuration/">Shaarli configuration
</a>
86 <a class=
"current" href=
"./">Plugins
</a>
89 <li class=
"toctree-l3"><a href=
"#plugin-installation">Plugin installation
</a></li>
92 <li class=
"toctree-l3"><a href=
"#plugin-configuration">Plugin configuration
</a></li>
95 <li class=
"toctree-l3"><a href=
"#plugin-order">Plugin order
</a></li>
98 <li class=
"toctree-l3"><a href=
"#file-mode">File mode
</a></li>
102 <li><a class=
"toctree-l4" href=
"#plugin-usage">Plugin usage
</a></li>
112 <li class=
"toctree-l1">
114 <span class=
"caption-text">Docker
</span>
118 <a class=
"" href=
"../Docker-101/">Docker
101</a>
122 <a class=
"" href=
"../Shaarli-images/">Shaarli images
</a>
126 <a class=
"" href=
"../Reverse-proxy-configuration/">Reverse proxy configuration
</a>
130 <a class=
"" href=
"../Docker-resources/">Docker resources
</a>
135 <li class=
"toctree-l1">
137 <span class=
"caption-text">Usage
</span>
141 <a class=
"" href=
"../Features/">Features
</a>
145 <a class=
"" href=
"../Bookmarklet/">Bookmarklet
</a>
149 <a class=
"" href=
"../Browsing-and-searching/">Browsing and searching
</a>
153 <a class=
"" href=
"../Firefox-share/">Firefox share
</a>
157 <a class=
"" href=
"../RSS-feeds/">RSS feeds
</a>
161 <a class=
"" href=
"../REST-API/">REST API
</a>
166 <li class=
"toctree-l1">
168 <span class=
"caption-text">How To
</span>
172 <a class=
"" href=
"../Backup,-restore,-import-and-export/">Backup, restore, import and export
</a>
176 <a class=
"" href=
"../Various-hacks/">Various hacks
</a>
181 <li class=
"toctree-l1">
183 <a class=
"" href=
"../Troubleshooting/">Troubleshooting
</a>
186 <li class=
"toctree-l1">
188 <span class=
"caption-text">Development
</span>
192 <a class=
"" href=
"../Development-guidelines/">Development guidelines
</a>
196 <a class=
"" href=
"../Continuous-integration-tools/">Continuous integration tools
</a>
200 <a class=
"" href=
"../GnuPG-signature/">GnuPG signature
</a>
204 <a class=
"" href=
"../Coding-guidelines/">Coding guidelines
</a>
208 <a class=
"" href=
"../Directory-structure/">Directory structure
</a>
212 <a class=
"" href=
"../3rd-party-libraries/">3rd party libraries
</a>
216 <a class=
"" href=
"../Plugin-System/">Plugin System
</a>
220 <a class=
"" href=
"../Release-Shaarli/">Release Shaarli
</a>
224 <a class=
"" href=
"../Versioning-and-Branches/">Versioning and Branches
</a>
228 <a class=
"" href=
"../Security/">Security
</a>
232 <a class=
"" href=
"../Static-analysis/">Static analysis
</a>
236 <a class=
"" href=
"../Theming/">Theming
</a>
240 <a class=
"" href=
"../Unit-tests/">Unit tests
</a>
245 <li class=
"toctree-l1">
247 <span class=
"caption-text">About
</span>
251 <a class=
"" href=
"../FAQ/">FAQ
</a>
255 <a class=
"" href=
"../Community-&-Related-software/">Community & Related software
</a>
265 <section data-toggle=
"wy-nav-shift" class=
"wy-nav-content-wrap">
268 <nav class=
"wy-nav-top" role=
"navigation" aria-label=
"top navigation">
269 <i data-toggle=
"wy-nav-top" class=
"fa fa-bars"></i>
270 <a href=
"..">Shaarli Documentation
</a>
274 <div class=
"wy-nav-content">
275 <div class=
"rst-content">
276 <div role=
"navigation" aria-label=
"breadcrumbs navigation">
277 <ul class=
"wy-breadcrumbs">
278 <li><a href=
"..">Docs
</a> »</li>
282 <li>Setup
»</li>
287 <li class=
"wy-breadcrumbs-aside">
289 <a href=
"https://github.com/shaarli/Shaarli/edit/master/docs/Plugins.md"
290 class=
"icon icon-github"> Edit on GitHub
</a>
297 <div class=
"section">
299 <h2 id=
"plugin-installation">Plugin installation
</h2>
300 <p>There is a bunch of plugins shipped with Shaarli, where there is nothing to do to install them.
</p>
301 <p>If you want to install a third party plugin:
</p>
303 <li>Download it.
</li>
304 <li>Put it in the
<code>plugins
</code> directory in Shaarli's installation folder.
</li>
305 <li>Make sure you put it correctly:
</li>
307 <pre><code>| index.php
310 | |---| custom_plugin.php
316 <li>Make sure your webserver can read and write the files in your plugin folder.
</li>
318 <h2 id=
"plugin-configuration">Plugin configuration
</h2>
319 <p>In Shaarli's administration page (
<code>Tools
</code> link), go to
<code>Plugin administration
</code>.
</p>
320 <p>Here you can enable and disable all plugins available, and configure them.
</p>
321 <p><img alt=
"administration screenshot" src=
"https://camo.githubusercontent.com/5da68e191969007492ca0fbeb25f3b2357b748cc/687474703a2f2f692e696d6775722e636f6d2f766837544643712e706e67" /></p>
322 <h2 id=
"plugin-order">Plugin order
</h2>
323 <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>
324 <p>This is important in case plugins are depending on each other. Read plugins README details for more information.
</p>
325 <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>
326 <h2 id=
"file-mode">File mode
</h2>
327 <p>Enabled plugin are stored in your
<code>config.php
</code> parameters file, under the
<code>array
</code>:
</p>
328 <pre><code class=
"php">$GLOBALS['config']['ENABLED_PLUGINS']
331 <p>You can edit them manually here.
333 <pre><code class=
"php">$GLOBALS['config']['ENABLED_PLUGINS'] = array(
341 <h3 id=
"plugin-usage">Plugin usage
</h3>
342 <h4 id=
"official-plugins">Official plugins
</h4>
343 <p>Usage of each plugin is documented in it's README file:
</p>
345 <li><code>addlink-toolbar
</code>: Adds the addlink input on the linklist page
</li>
346 <li><code>archiveorg
</code>: For each link, add an Archive.org icon
</li>
347 <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>
348 <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>
349 <li><code>qrcode
</code>: For each link, add a QRCode icon.
</li>
350 <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>
352 <h4 id=
"third-party-plugins">Third party plugins
</h4>
353 <p>See
<a href=
"https://github.com/shaarli/Shaarli/wiki/Community-%26-Related-software#third-party-plugins">Community
& related software
</a></p>
359 <div class=
"rst-footer-buttons" role=
"navigation" aria-label=
"footer navigation">
361 <a href=
"../Docker-101/" class=
"btn btn-neutral float-right" title=
"Docker 101">Next
<span class=
"icon icon-circle-arrow-right"></span></a>
364 <a href=
"../Shaarli-configuration/" class=
"btn btn-neutral" title=
"Shaarli configuration"><span class=
"icon icon-circle-arrow-left"></span> Previous
</a>
371 <div role=
"contentinfo">
372 <!-- Copyright etc -->
376 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>.
386 <div class=
"rst-versions" role=
"note" style=
"cursor: pointer">
387 <span class=
"rst-current-version" data-toggle=
"rst-current-version">
389 <a href=
"https://github.com/shaarli/Shaarli" class=
"fa fa-github" style=
"float: left; color: #fcfcfc"> GitHub
</a>
392 <span><a href=
"../Shaarli-configuration/" style=
"color: #fcfcfc;">« Previous
</a></span>
395 <span style=
"margin-left: 15px"><a href=
"../Docker-101/" style=
"color: #fcfcfc">Next
»</a></span>
399 <script src=
"../js/theme.js"></script>