diff options
author | nodiscc <nodiscc@gmail.com> | 2020-05-16 12:54:51 +0200 |
---|---|---|
committer | nodiscc <nodiscc@gmail.com> | 2020-09-12 14:31:45 +0200 |
commit | 91a21c272960889afd4eaa431a3d29b7785b6efc (patch) | |
tree | 26e3ba62319964c5fd48d93fdfe47813d5dc9bf5 /doc/md/Plugins.md | |
parent | 6128ab6a55430a2b705be31ff417c0c552a0db1f (diff) | |
download | Shaarli-91a21c272960889afd4eaa431a3d29b7785b6efc.tar.gz Shaarli-91a21c272960889afd4eaa431a3d29b7785b6efc.tar.zst Shaarli-91a21c272960889afd4eaa431a3d29b7785b6efc.zip |
**General rewording, proof-reading, deduplication, shortening, reordering, simplification, cleanup/formatting/standardization**
- standardize page names, rework documentation structure, update TOC
- use same example paths everywhere
- level 1 titles on all pages
- fix broken links
- .md suffix on all page links (works both from readthedocs and github repository views)
**Server:**
A full and concise installation guide with examples is a frequent request. The documentation should provide such a guide for basic installation needs, while explaining alternative/advanced configuration at the end. Links to reference guides and documentation should be used more frequently to avoid recommending an outdated or excessively complex configuration.
- server: move most server-related info to server-configuration.md, cleanup/shorten
- server: update list of php dependencies/libraries, link to composer.json
- server: installation: support 3 install methods (from release zip, from sources, using docker)
- server: installation: use rsync instead of mv as mv results will change depending of taget directory already existing or not
- server: add example/basic usage of certbot
- server, upgrade, installation: update file permissions setup, use sudo for upgrade operations in webserver document root
- server: apache: add comments to configuration, fix and factorize file permissions setup, set cache-control header, deny access to dotfiles, add missing apache config steps, add http->https redirect example
- server: nginx: refactor nginx configuration, add comments, DO log access to denied/protected files
- server: add links to MDN for x-forwarded-* http headers explanation, cleanup/clarify robots.txt and crawlers section
- server: bump file upload size limit to 100MB we have reports of bookmark exports weighing +40MB - i have a 13MB one here
- server: simplify phpinfo documentation
- server: move backup and restore information to dedicated page
- docker: move all docker docs to Docker.md, simplify/ docker setup, add docker-compose.yml example, replace docker-101 with docker cheatsheet
- troubleshooting: move all troubleshooting documentation to troubleshooting.md
**Usage:**
- index: add getting started section on index page
- features/usage: move all usage-related documentation to usage.md, add links from the main feature list to corresponding usage docs, clarify/reword features list
- shaarli configuration: add note about configuring from web interface
**Removed:**
- remove obsolete/orphan images
- remove obsolete shaarchiver example
- remove outdated "decode datastore content" snippet
**Development:**
- development: move development-related docs (static analysis, CI, unit tests, 3rd party libs, link structure/directory, guidelines, security....) to dev/ directory
- development: Merge several pages to development.md
- **Breaking change?:** remove mentions of 'stable' branch, switch to new branch/release model (master=latest commit, release=latest tag)
- **Breaking change?:** refer to base sharing unit as "Shaare" everywhere (TODO: reflect changes in the code?) doc: update featues list/link to usage.md for details
- development: directory structure: add note about required file permissions
- .travis-ci.yml: add comments
- .htaccess: add comment
Diffstat (limited to 'doc/md/Plugins.md')
-rw-r--r-- | doc/md/Plugins.md | 51 |
1 files changed, 25 insertions, 26 deletions
diff --git a/doc/md/Plugins.md b/doc/md/Plugins.md index 3e261815..49a51f51 100644 --- a/doc/md/Plugins.md +++ b/doc/md/Plugins.md | |||
@@ -1,14 +1,13 @@ | |||
1 | ## Plugin installation | 1 | # Plugins |
2 | 2 | ||
3 | There is a bunch of plugins shipped with Shaarli, where there is nothing to do to install them. | 3 | ## Installation |
4 | 4 | ||
5 | If you want to install a third party plugin: | 5 | For plugins shipped with Shaarli, no installation is required. |
6 | 6 | ||
7 | - Download it. | 7 | If you want to install a third party plugin, download it to the `plugins` directory in Shaarli's installation folder: |
8 | - Put it in the `plugins` directory in Shaarli's installation folder. | ||
9 | - Make sure you put it correctly: | ||
10 | 8 | ||
11 | ``` | 9 | ```bash |
10 | # example directory structure | ||
12 | | index.php | 11 | | index.php |
13 | | plugins/ | 12 | | plugins/ |
14 | |---| custom_plugin/ | 13 | |---| custom_plugin/ |
@@ -17,34 +16,34 @@ If you want to install a third party plugin: | |||
17 | 16 | ||
18 | ``` | 17 | ``` |
19 | 18 | ||
20 | * Make sure your webserver can read and write the files in your plugin folder. | 19 | Make sure your webserver can read and write the files in your plugin folder. |
21 | 20 | ||
22 | ## Plugin configuration | ||
23 | 21 | ||
24 | In Shaarli's administration page (`Tools` link), go to `Plugin administration`. | 22 | ## Configuration |
25 | 23 | ||
26 | Here you can enable and disable all plugins available, and configure them. | 24 | From Shaarli's administration page (`Tools` link), go to `Plugin administration`. Here you can enable and disable all plugins available, and configure them. |
27 | 25 | ||
28 | ![administration screenshot](https://camo.githubusercontent.com/5da68e191969007492ca0fbeb25f3b2357b748cc/687474703a2f2f692e696d6775722e636f6d2f766837544643712e706e67) | 26 | ![administration screenshot](https://camo.githubusercontent.com/5da68e191969007492ca0fbeb25f3b2357b748cc/687474703a2f2f692e696d6775722e636f6d2f766837544643712e706e67) |
29 | 27 | ||
30 | ## Plugin order | 28 | |
29 | ## Order | ||
31 | 30 | ||
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. | 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. |
33 | 32 | ||
34 | This is important in case plugins are depending on each other. Read plugins README details for more information. | 33 | This is important in case plugins depend on each other. Read plugins READMEs for more information. |
35 | 34 | ||
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. | 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. |
37 | 36 | ||
38 | ## File mode | ||
39 | 37 | ||
40 | Enabled plugin are stored in your `config.json.php` parameters file, under the `array`: | 38 | ## Configuration file |
39 | |||
40 | Enabled plugins are stored in your [Configuration file](Shaarli-configuration), under the array: | ||
41 | 41 | ||
42 | ```php | 42 | ```php |
43 | $GLOBALS['config']['ENABLED_PLUGINS'] | 43 | $GLOBALS['config']['ENABLED_PLUGINS'] |
44 | ``` | 44 | ``` |
45 | 45 | ||
46 | You can edit them manually here. | 46 | You can edit them manually here. For example: |
47 | Example: | ||
48 | 47 | ||
49 | ```php | 48 | ```php |
50 | $GLOBALS['config']['ENABLED_PLUGINS'] = array( | 49 | $GLOBALS['config']['ENABLED_PLUGINS'] = array( |
@@ -55,25 +54,25 @@ $GLOBALS['config']['ENABLED_PLUGINS'] = array( | |||
55 | ); | 54 | ); |
56 | ``` | 55 | ``` |
57 | 56 | ||
58 | ### Plugin usage | ||
59 | 57 | ||
60 | #### Official plugins | 58 | ## Usage |
59 | |||
60 | ### Official plugins | ||
61 | 61 | ||
62 | Usage of each plugin is documented in it's README file: | 62 | Usage of each plugin is documented in it's README file: |
63 | 63 | ||
64 | * `addlink-toolbar`: Adds the addlink input on the linklist page | 64 | * `addlink-toolbar`: Adds the addlink input on the Shaares list page |
65 | * `archiveorg`: For each link, add an Archive.org icon | 65 | * `archiveorg`: For each Shaare, add a link to the archived page on Archive.org |
66 | * `default_colors`: Override default theme colors. | 66 | * `default_colors`: Override default theme colors. |
67 | * `isso`: Let visitor comment your shaares on permalinks with Isso. | 67 | * `isso`: Let visitor comment your shaares on permalinks with Isso. |
68 | * [`markdown`](https://github.com/shaarli/Shaarli/blob/master/plugins/markdown/README.md): Render shaare description with Markdown syntax. | 68 | * [`markdown`](https://github.com/shaarli/Shaarli/blob/master/plugins/markdown/README.md): Render shaare description with Markdown syntax. |
69 | * `piwik`: A plugin that adds Piwik tracking code to Shaarli pages. | 69 | * `piwik`: A plugin that adds Piwik tracking code to Shaarli pages. |
70 | * [`playvideos`](https://github.com/shaarli/Shaarli/blob/master/plugins/playvideos/README.md): Add a button in the toolbar allowing to watch all videos. | 70 | * [`playvideos`](https://github.com/shaarli/Shaarli/blob/master/plugins/playvideos/README.md): Add a button in the toolbar allowing to watch all videos. |
71 | * `pubsubhubbub`: Enable PubSubHubbub feed publishing | 71 | * `pubsubhubbub`: Enable PubSubHubbub feed publishing |
72 | * `qrcode`: For each link, add a QRCode icon. | 72 | * `qrcode`: For each Shaare, add a QRCode icon. |
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. | 73 | * [`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. |
74 | |||
75 | 74 | ||
76 | 75 | ||
77 | #### Third party plugins | 76 | ### Third party plugins |
78 | 77 | ||
79 | See [Community & related software](https://shaarli.readthedocs.io/en/master/Community-&-Related-software/) | 78 | See [Community & related software](https://shaarli.readthedocs.io/en/master/Community-and-Related-software/) |