projects / github / shaarli / Shaarli.git / blame
| Commit | Line | Data |
|---|---|---|
| 5409ade2 A |
1 | ## Plugin installation |
| 2 | ||
| 3 | There is a bunch of plugins shipped with Shaarli, where there is nothing to do to install them. | |
| 4 | ||
| 5 | If you want to install a third party plugin: | |
| 6 | ||
| 43ad7c8e V |
7 | - Download it. |
| 8 | - Put it in the `plugins` directory in Shaarli's installation folder. | |
| 9 | - Make sure you put it correctly: | |
| 5409ade2 A |
10 | |
| 11 | ``` | |
| 12 | | index.php | |
| 13 | | plugins/ | |
| 14 | |---| custom_plugin/ | |
| 15 | | |---| custom_plugin.php | |
| 16 | | |---| ... | |
| 17 | ||
| 18 | ``` | |
| 19 | ||
| 20 | * Make sure your webserver can read and write the files in your plugin folder. | |
| 21 | ||
| 22 | ## Plugin configuration | |
| 23 | ||
| 24 | In Shaarli's administration page (`Tools` link), go to `Plugin administration`. | |
| 25 | ||
| 26 | Here you can enable and disable all plugins available, and configure them. | |
| 27 | ||
| 53ed6d7d | 28 |  |
| 5409ade2 A |
29 | |
| 30 | ## Plugin order | |
| 31 | ||
| 32 | 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. | |
| 33 | ||
| 34 | This is important in case plugins are depending on each other. Read plugins README details for more information. | |
| 35 | ||
| 36 | **Use case**: The (non existent) plugin `shaares_footer` adds a footer to every shaare in Markdown syntax. It needs to be processed *before* (higher in the list) the Markdown plugin. Otherwise its syntax won't be translated in HTML. | |
| 37 | ||
| 38 | ## File mode | |
| 39 | ||
| 48679a15 | 40 | Enabled plugin are stored in your `config.json.php` parameters file, under the `array`: |
| 5409ade2 A |
41 | |
| 42 | ```php | |
| 53ed6d7d | 43 | $GLOBALS['config']['ENABLED_PLUGINS'] |
| 5409ade2 A |
44 | ``` |
| 45 | ||
| 46 | You can edit them manually here. | |
| 47 | Example: | |
| 48 | ||
| 49 | ```php | |
| 53ed6d7d | 50 | $GLOBALS['config']['ENABLED_PLUGINS'] = array( |
| 48679a15 | 51 | 'qrcode', |
| 5409ade2 A |
52 | 'archiveorg', |
| 53 | 'wallabag', | |
| 54 | 'markdown', | |
| 55 | ); | |
| 56 | ``` | |
| 57 | ||
| 58 | ### Plugin usage | |
| 59 | ||
| 08dcd8ea A |
60 | #### Official plugins |
| 61 | ||
| 5409ade2 A |
62 | Usage of each plugin is documented in it's README file: |
| 63 | ||
| 64 | * `addlink-toolbar`: Adds the addlink input on the linklist page | |
| 65 | * `archiveorg`: For each link, add an Archive.org icon | |
| a8fb97a0 A |
66 | * `default_colors`: Override default theme colors. |
| 67 | * `isso`: Let visitor comment your shaares on permalinks with Isso. | |
| 53ed6d7d | 68 | * [`markdown`](https://github.com/shaarli/Shaarli/blob/master/plugins/markdown/README.md): Render shaare description with Markdown syntax. |
| a8fb97a0 | 69 | * `piwik`: A plugin that adds Piwik tracking code to Shaarli pages. |
| 53ed6d7d | 70 | * [`playvideos`](https://github.com/shaarli/Shaarli/blob/master/plugins/playvideos/README.md): Add a button in the toolbar allowing to watch all videos. |
| a8fb97a0 | 71 | * `pubsubhubbub`: Enable PubSubHubbub feed publishing |
| 5409ade2 | 72 | * `qrcode`: For each link, add a QRCode icon. |
| 53ed6d7d | 73 | * [`wallabag`](https://github.com/shaarli/Shaarli/blob/master/plugins/wallabag/README.md): For each link, add a Wallabag icon to save it in your instance. |
| 08dcd8ea A |
74 | |
| 75 | ||
| 76 | ||
| 77 | #### Third party plugins | |
| 78 | ||
| cc8f572b | 79 | See [Community & related software](https://shaarli.readthedocs.io/en/master/Community-&-Related-software/) |