]>
Commit | Line | Data |
---|---|---|
1 | # Plugins | |
2 | ||
3 | ## Installation | |
4 | ||
5 | For plugins shipped with Shaarli, no installation is required. | |
6 | ||
7 | If you want to install a third party plugin, download it to the `plugins` directory in Shaarli's installation folder: | |
8 | ||
9 | ```bash | |
10 | # example directory structure | |
11 | | index.php | |
12 | | plugins/ | |
13 | |---| custom_plugin/ | |
14 | | |---| custom_plugin.php | |
15 | | |---| ... | |
16 | ||
17 | ``` | |
18 | ||
19 | Make sure your webserver can read and write the files in your plugin folder. | |
20 | ||
21 | ||
22 | ## Configuration | |
23 | ||
24 | From Shaarli's administration page (`Tools` link), go to `Plugin administration`. Here you can enable and disable all plugins available, and configure them. | |
25 | ||
26 | ![administration screenshot](https://camo.githubusercontent.com/5da68e191969007492ca0fbeb25f3b2357b748cc/687474703a2f2f692e696d6775722e636f6d2f766837544643712e706e67) | |
27 | ||
28 | ||
29 | ## Order | |
30 | ||
31 | 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. | |
32 | ||
33 | This is important in case plugins depend on each other. Read plugins READMEs for more information. | |
34 | ||
35 | **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. | |
36 | ||
37 | ||
38 | ## Configuration file | |
39 | ||
40 | Enabled plugins are stored in your [Configuration file](Shaarli-configuration). | |
41 | ||
42 | ## Usage | |
43 | ||
44 | ### Official plugins | |
45 | ||
46 | Usage of each plugin is documented in it's README file: | |
47 | ||
48 | * `addlink-toolbar`: Adds the addlink input on the Shaares list page | |
49 | * `archiveorg`: For each Shaare, add a link to the archived page on Archive.org | |
50 | * `default_colors`: Override default theme colors. | |
51 | * `isso`: Let visitor comment your shaares on permalinks with Isso. | |
52 | * [`markdown`](https://github.com/shaarli/Shaarli/blob/master/plugins/markdown/README.md): Render shaare description with Markdown syntax. | |
53 | * `piwik`: A plugin that adds Piwik tracking code to Shaarli pages. | |
54 | * [`playvideos`](https://github.com/shaarli/Shaarli/blob/master/plugins/playvideos/README.md): Add a button in the toolbar allowing to watch all videos. | |
55 | * `pubsubhubbub`: Enable PubSubHubbub feed publishing | |
56 | * `qrcode`: For each Shaare, add a QRCode icon. | |
57 | * [`wallabag`](https://github.com/shaarli/Shaarli/blob/master/plugins/wallabag/README.md): For each Shaare, add a Wallabag icon to save it in your instance. | |
58 | ||
59 | ||
60 | ### Third party plugins | |
61 | ||
62 | See [Community & related software](https://shaarli.readthedocs.io/en/master/Community-and-Related-software/) |