diff options
author | ArthurHoaro <arthur@hoa.ro> | 2020-10-13 12:07:13 +0200 |
---|---|---|
committer | ArthurHoaro <arthur@hoa.ro> | 2020-10-13 12:07:13 +0200 |
commit | d9f6275ebca035fec8331652c677981056793ccc (patch) | |
tree | 37a64baf4f0eba6b781040605965383d8aded2cc /doc | |
parent | 38672ba0d1c722e5d6d33a58255ceb55e9410e46 (diff) | |
parent | d63ff87a009313141ae684ec447b902562ff6ee7 (diff) | |
download | Shaarli-stable.tar.gz Shaarli-stable.tar.zst Shaarli-stable.zip |
Merge branch 'v0.11' into stablestable
Diffstat (limited to 'doc')
-rw-r--r-- | doc/md/Community-&-Related-software.md | 3 | ||||
-rw-r--r-- | doc/md/Download-and-Installation.md | 8 | ||||
-rw-r--r-- | doc/md/Plugin-System.md | 17 | ||||
-rw-r--r-- | doc/md/Plugins.md | 4 | ||||
-rw-r--r-- | doc/md/Server-configuration.md | 4 | ||||
-rw-r--r-- | doc/md/Shaarli-configuration.md | 19 |
6 files changed, 35 insertions, 20 deletions
diff --git a/doc/md/Community-&-Related-software.md b/doc/md/Community-&-Related-software.md index 67fdd70f..c66d1c70 100644 --- a/doc/md/Community-&-Related-software.md +++ b/doc/md/Community-&-Related-software.md | |||
@@ -22,7 +22,8 @@ See [REST API](REST-API) for a list of official and community clients. | |||
22 | - [shaarli2twitter](https://github.com/ArthurHoaro/shaarli2twitter) by [@ArthurHoaro](https://github.com/ArthurHoaro) - Automatically tweet your shared links from Shaarli | 22 | - [shaarli2twitter](https://github.com/ArthurHoaro/shaarli2twitter) by [@ArthurHoaro](https://github.com/ArthurHoaro) - Automatically tweet your shared links from Shaarli |
23 | - [shaarli2mastodon](https://github.com/kalvn/shaarli2mastodon) by [@kalvn](https://github.com/kalvn) - This Shaarli plugin allows you to automatically publish links you post on your Mastodon timeline. | 23 | - [shaarli2mastodon](https://github.com/kalvn/shaarli2mastodon) by [@kalvn](https://github.com/kalvn) - This Shaarli plugin allows you to automatically publish links you post on your Mastodon timeline. |
24 | - [shaarli-descriptor](https://github.com/immanuelfodor/shaarli-descriptor) by [@immanuelfodor](https://github.com/immanuelfodor) - Customize the default height/number of rows of the Description field when editing a link. | 24 | - [shaarli-descriptor](https://github.com/immanuelfodor/shaarli-descriptor) by [@immanuelfodor](https://github.com/immanuelfodor) - Customize the default height/number of rows of the Description field when editing a link. |
25 | 25 | - [urlextern](https://github.com/trailjeep/shaarli-urlextern) by [@trailjeep](https://github.com/trailjeep) - Shaarli plugin to open external links in a new tab/window. | |
26 | - [favicons](https://github.com/trailjeep/shaarli-favicons) by [@trailjeep](https://github.com/trailjeep) - Shaarli plugin to add favicon/filetype icons to links. | ||
26 | 27 | ||
27 | ### Third-party themes | 28 | ### Third-party themes |
28 | See [Theming](Theming) for a list of community-contributed themes, and an installation guide. | 29 | See [Theming](Theming) for a list of community-contributed themes, and an installation guide. |
diff --git a/doc/md/Download-and-Installation.md b/doc/md/Download-and-Installation.md index 14649e06..ec68762e 100644 --- a/doc/md/Download-and-Installation.md +++ b/doc/md/Download-and-Installation.md | |||
@@ -1,7 +1,7 @@ | |||
1 | To install Shaarli, simply place the files in a directory under your webserver's | 1 | To install Shaarli, simply place the files in a directory under your webserver's |
2 | Document Root (or directly at the document root). | 2 | Document Root (or directly at the document root). |
3 | 3 | ||
4 | Also, please make sure your server is properly [configured](Server-configuration). | 4 | Also, please make sure your server is properly [configured](Server-configuration.md). |
5 | 5 | ||
6 | Multiple releases branches are available: | 6 | Multiple releases branches are available: |
7 | 7 | ||
@@ -24,11 +24,11 @@ Using one of the following methods: | |||
24 | 24 | ||
25 | In most cases, you should download the latest Shaarli release from the [releases](https://github.com/shaarli/Shaarli/releases) page. Download our **shaarli-full** archive to include dependencies. | 25 | In most cases, you should download the latest Shaarli release from the [releases](https://github.com/shaarli/Shaarli/releases) page. Download our **shaarli-full** archive to include dependencies. |
26 | 26 | ||
27 | The current latest released version is `v0.9.7` | 27 | The current latest released version is `v0.10.4` |
28 | 28 | ||
29 | ```bash | 29 | ```bash |
30 | $ wget https://github.com/shaarli/Shaarli/releases/download/v0.9.7/shaarli-v0.9.7-full.zip | 30 | $ wget https://github.com/shaarli/Shaarli/releases/download/v0.10.4/shaarli-v0.10.4-full.zip |
31 | $ unzip shaarli-v0.9.7-full.zip | 31 | $ unzip shaarli-v0.10.4-full.zip |
32 | $ mv Shaarli /path/to/shaarli/ | 32 | $ mv Shaarli /path/to/shaarli/ |
33 | ``` | 33 | ``` |
34 | 34 | ||
diff --git a/doc/md/Plugin-System.md b/doc/md/Plugin-System.md index cbec04c0..9b0d3a7d 100644 --- a/doc/md/Plugin-System.md +++ b/doc/md/Plugin-System.md | |||
@@ -137,6 +137,7 @@ If it's still not working, please [open an issue](https://github.com/shaarli/Sha | |||
137 | | [render_feed](#render_feed) | Allow to do add tags in RSS and ATOM feeds. | | 137 | | [render_feed](#render_feed) | Allow to do add tags in RSS and ATOM feeds. | |
138 | | [save_link](#save_link) | Allow to alter the link being saved in the datastore. | | 138 | | [save_link](#save_link) | Allow to alter the link being saved in the datastore. | |
139 | | [delete_link](#delete_link) | Allow to do an action before a link is deleted from the datastore. | | 139 | | [delete_link](#delete_link) | Allow to do an action before a link is deleted from the datastore. | |
140 | | [save_plugin_parameters](#save_plugin_parameters) | Allow to manipulate plugin parameters before they're saved. | | ||
140 | 141 | ||
141 | 142 | ||
142 | 143 | ||
@@ -471,6 +472,22 @@ Allow to execute any action before the link is actually removed from the datasto | |||
471 | - created | 472 | - created |
472 | - updated | 473 | - updated |
473 | 474 | ||
475 | |||
476 | #### save_plugin_parameters | ||
477 | |||
478 | Triggered when the plugin parameters are saved from the plugin administration page. | ||
479 | |||
480 | Plugins can perform an action every times their settings are updated. | ||
481 | For example it is used to update the CSS file of the `default_colors` plugins. | ||
482 | |||
483 | ##### Data | ||
484 | |||
485 | `$data` input contains the `$_POST` array. | ||
486 | |||
487 | So if the plugin has a parameter called `MYPLUGIN_PARAMETER`, | ||
488 | the array will contain an entry with `MYPLUGIN_PARAMETER` as a key. | ||
489 | |||
490 | |||
474 | ## Guide for template designer | 491 | ## Guide for template designer |
475 | 492 | ||
476 | ### Plugin administration | 493 | ### Plugin administration |
diff --git a/doc/md/Plugins.md b/doc/md/Plugins.md index 954442e2..3e261815 100644 --- a/doc/md/Plugins.md +++ b/doc/md/Plugins.md | |||
@@ -63,8 +63,12 @@ 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 linklist page |
65 | * `archiveorg`: For each link, add an Archive.org icon | 65 | * `archiveorg`: For each link, add an Archive.org icon |
66 | * `default_colors`: Override default theme colors. | ||
67 | * `isso`: Let visitor comment your shaares on permalinks with Isso. | ||
66 | * [`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. | ||
67 | * [`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 | ||
68 | * `qrcode`: For each link, add a QRCode icon. | 72 | * `qrcode`: For each link, add a QRCode icon. |
69 | * [`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 link, add a Wallabag icon to save it in your instance. |
70 | 74 | ||
diff --git a/doc/md/Server-configuration.md b/doc/md/Server-configuration.md index 78083a46..88eed8e6 100644 --- a/doc/md/Server-configuration.md +++ b/doc/md/Server-configuration.md | |||
@@ -17,7 +17,7 @@ Version | Status | Shaarli compatibility | |||
17 | :---:|:---:|:---: | 17 | :---:|:---:|:---: |
18 | 7.2 | Supported | Yes | 18 | 7.2 | Supported | Yes |
19 | 7.1 | Supported | Yes | 19 | 7.1 | Supported | Yes |
20 | 7.0 | Supported | Yes | 20 | 7.0 | EOL: 2018-12-03 | Yes (up to Shaarli 0.10.x) |
21 | 5.6 | EOL: 2018-12-31 | Yes (up to Shaarli 0.10.x) | 21 | 5.6 | EOL: 2018-12-31 | Yes (up to Shaarli 0.10.x) |
22 | 5.5 | EOL: 2016-07-10 | Yes | 22 | 5.5 | EOL: 2016-07-10 | Yes |
23 | 5.4 | EOL: 2015-09-14 | Yes (up to Shaarli 0.8.x) | 23 | 5.4 | EOL: 2015-09-14 | Yes (up to Shaarli 0.8.x) |
@@ -404,6 +404,8 @@ If Shaarli is served behind a proxy (i.e. there is a proxy server between client | |||
404 | - `X-Forwarded-Host` | 404 | - `X-Forwarded-Host` |
405 | - `X-Forwarded-For` | 405 | - `X-Forwarded-For` |
406 | 406 | ||
407 | In you [Shaarli configuration](Shaarli-configuration) `data/config.json.php`, add the public IP of your proxy under `security.trusted_proxies`. | ||
408 | |||
407 | See also [proxy-related](https://github.com/shaarli/Shaarli/issues?utf8=%E2%9C%93&q=label%3Aproxy+) issues. | 409 | See also [proxy-related](https://github.com/shaarli/Shaarli/issues?utf8=%E2%9C%93&q=label%3Aproxy+) issues. |
408 | 410 | ||
409 | ## Robots and crawlers | 411 | ## Robots and crawlers |
diff --git a/doc/md/Shaarli-configuration.md b/doc/md/Shaarli-configuration.md index 920c7e27..664e36dd 100644 --- a/doc/md/Shaarli-configuration.md +++ b/doc/md/Shaarli-configuration.md | |||
@@ -4,7 +4,7 @@ | |||
4 | 4 | ||
5 | Once your Shaarli instance is installed, the file `data/config.json.php` is generated: | 5 | Once your Shaarli instance is installed, the file `data/config.json.php` is generated: |
6 | * it contains all settings in JSON format, and can be edited to customize values | 6 | * it contains all settings in JSON format, and can be edited to customize values |
7 | * it defines which [plugins](Plugin-System) are enabled[](.html) | 7 | * it defines which [plugins](Plugin-System) are enabled |
8 | * its values override those defined in `index.php` | 8 | * its values override those defined in `index.php` |
9 | * it is wrap in a PHP comment to prevent anyone accessing it, regardless of server configuration | 9 | * it is wrap in a PHP comment to prevent anyone accessing it, regardless of server configuration |
10 | 10 | ||
@@ -32,13 +32,13 @@ On a Linux distribution: | |||
32 | - to give it access to Shaarli, either: | 32 | - to give it access to Shaarli, either: |
33 | - unzip Shaarli in the default web server location (usually `/var/www/`) and set the web server user as the owner | 33 | - unzip Shaarli in the default web server location (usually `/var/www/`) and set the web server user as the owner |
34 | - put users in the same group as the web server, and set the appropriate access rights | 34 | - put users in the same group as the web server, and set the appropriate access rights |
35 | - if you have a domain / subdomain to serve Shaarli, [configure the server](Server-configuration) accordingly[](.html) | 35 | - if you have a domain / subdomain to serve Shaarli, [configure the server](Server-configuration) accordingly |
36 | 36 | ||
37 | ## Configuration | 37 | ## Configuration |
38 | 38 | ||
39 | In `data/config.json.php`. | 39 | In `data/config.json.php`. |
40 | 40 | ||
41 | See also [Plugin System](Plugin-System.html). | 41 | See also [Plugin System](Plugin-System). |
42 | 42 | ||
43 | ### Credentials | 43 | ### Credentials |
44 | 44 | ||
@@ -56,6 +56,8 @@ _These settings should not be edited_ | |||
56 | - **timezone**: See [the list of supported timezones](http://php.net/manual/en/timezones.php). | 56 | - **timezone**: See [the list of supported timezones](http://php.net/manual/en/timezones.php). |
57 | - **enabled_plugins**: List of enabled plugins. | 57 | - **enabled_plugins**: List of enabled plugins. |
58 | - **default_note_title**: Default title of a new note. | 58 | - **default_note_title**: Default title of a new note. |
59 | - **retrieve_description** (boolean): If set to true, for every new links Shaarli will try | ||
60 | to retrieve the description and keywords from the HTML meta tags. | ||
59 | 61 | ||
60 | ### Security | 62 | ### Security |
61 | 63 | ||
@@ -120,11 +122,6 @@ Must be an associative array: `translation domain => translation path`. | |||
120 | - **enable_thumbnails**: Enable or disable thumbnail display. | 122 | - **enable_thumbnails**: Enable or disable thumbnail display. |
121 | - **enable_localcache**: Enable or disable local cache. | 123 | - **enable_localcache**: Enable or disable local cache. |
122 | 124 | ||
123 | ### Redirector | ||
124 | |||
125 | - **url**: Redirector URL, such as `anonym.to`. | ||
126 | - **encode_url**: Enable this if the redirector needs encoded URL to work properly. | ||
127 | |||
128 | ## Configuration file example | 125 | ## Configuration file example |
129 | 126 | ||
130 | ```json | 127 | ```json |
@@ -185,8 +182,6 @@ Must be an associative array: `translation domain => translation path`. | |||
185 | "hide_public_links": false, | 182 | "hide_public_links": false, |
186 | "hide_timestamps": false, | 183 | "hide_timestamps": false, |
187 | "open_shaarli": false, | 184 | "open_shaarli": false, |
188 | "redirector": "http://anonym.to/?", | ||
189 | "redirector_encode_url": false | ||
190 | }, | 185 | }, |
191 | "general": { | 186 | "general": { |
192 | "header_link": "?", | 187 | "header_link": "?", |
@@ -218,10 +213,6 @@ Must be an associative array: `translation domain => translation path`. | |||
218 | "enable_thumbnails": true, | 213 | "enable_thumbnails": true, |
219 | "enable_localcache": true | 214 | "enable_localcache": true |
220 | }, | 215 | }, |
221 | "redirector": { | ||
222 | "url": "http://anonym.to/?", | ||
223 | "encode_url": false | ||
224 | }, | ||
225 | "plugins": { | 216 | "plugins": { |
226 | "WALLABAG_URL": "http://demo.wallabag.org", | 217 | "WALLABAG_URL": "http://demo.wallabag.org", |
227 | "WALLABAG_VERSION": "1" | 218 | "WALLABAG_VERSION": "1" |