From 913c70d8e73e28ab2cac90fb5d1b079d4b73d6f9 Mon Sep 17 00:00:00 2001 From: trailjeep Date: Sat, 26 Jan 2019 14:06:54 -0500 Subject: Update Community-&-Related-software.md --- doc/md/Community-&-Related-software.md | 1 + 1 file changed, 1 insertion(+) (limited to 'doc/md') diff --git a/doc/md/Community-&-Related-software.md b/doc/md/Community-&-Related-software.md index 67fdd70f..adf748a2 100644 --- a/doc/md/Community-&-Related-software.md +++ b/doc/md/Community-&-Related-software.md @@ -22,6 +22,7 @@ See [REST API](REST-API) for a list of official and community clients. - [shaarli2twitter](https://github.com/ArthurHoaro/shaarli2twitter) by [@ArthurHoaro](https://github.com/ArthurHoaro) - Automatically tweet your shared links from Shaarli - [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. - [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. +- [urlextern](https://github.com/trailjeep/shaarli-urlextern) by [@trailjeep](https://github.com/trailjeep) - Shaarli plugin to open external links in a new tab/window. ### Third-party themes -- cgit v1.2.3 From 4d55e4f0755488e29d18246fd9a7902228112104 Mon Sep 17 00:00:00 2001 From: trailjeep Date: Sat, 26 Jan 2019 15:51:40 -0500 Subject: Update Community-&-Related-software.md --- doc/md/Community-&-Related-software.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/md') diff --git a/doc/md/Community-&-Related-software.md b/doc/md/Community-&-Related-software.md index 67fdd70f..6bdefb90 100644 --- a/doc/md/Community-&-Related-software.md +++ b/doc/md/Community-&-Related-software.md @@ -22,7 +22,7 @@ See [REST API](REST-API) for a list of official and community clients. - [shaarli2twitter](https://github.com/ArthurHoaro/shaarli2twitter) by [@ArthurHoaro](https://github.com/ArthurHoaro) - Automatically tweet your shared links from Shaarli - [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. - [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. - +- [favicons](https://github.com/trailjeep/shaarli-favicons) by [@trailjeep](https://github.com/trailjeep) - Shaarli plugin to add favicon/filetype icons to links. ### Third-party themes See [Theming](Theming) for a list of community-contributed themes, and an installation guide. -- cgit v1.2.3 From 8d1509e8a64cb7d3d026b48f545cd151512d5887 Mon Sep 17 00:00:00 2001 From: nodiscc Date: Thu, 31 Jan 2019 13:21:34 +0000 Subject: doc: fix invalid links Fixes warnings from https://travis-ci.org/shaarli/Shaarli/jobs/486928133 --- doc/md/Shaarli-configuration.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'doc/md') diff --git a/doc/md/Shaarli-configuration.md b/doc/md/Shaarli-configuration.md index 920c7e27..0bb6c9f0 100644 --- a/doc/md/Shaarli-configuration.md +++ b/doc/md/Shaarli-configuration.md @@ -4,7 +4,7 @@ Once your Shaarli instance is installed, the file `data/config.json.php` is generated: * it contains all settings in JSON format, and can be edited to customize values -* it defines which [plugins](Plugin-System) are enabled[](.html) +* it defines which [plugins](Plugin-System) are enabled * its values override those defined in `index.php` * it is wrap in a PHP comment to prevent anyone accessing it, regardless of server configuration @@ -32,13 +32,13 @@ On a Linux distribution: - to give it access to Shaarli, either: - unzip Shaarli in the default web server location (usually `/var/www/`) and set the web server user as the owner - put users in the same group as the web server, and set the appropriate access rights -- if you have a domain / subdomain to serve Shaarli, [configure the server](Server-configuration) accordingly[](.html) +- if you have a domain / subdomain to serve Shaarli, [configure the server](Server-configuration) accordingly ## Configuration In `data/config.json.php`. -See also [Plugin System](Plugin-System.html). +See also [Plugin System](Plugin-System). ### Credentials -- cgit v1.2.3 From 520d29578c57e476ece3bdd20c286d196b7b61b4 Mon Sep 17 00:00:00 2001 From: ArthurHoaro Date: Sat, 9 Feb 2019 13:52:12 +0100 Subject: Remove the redirector setting Fixes #1239 --- doc/md/Shaarli-configuration.md | 11 ----------- 1 file changed, 11 deletions(-) (limited to 'doc/md') diff --git a/doc/md/Shaarli-configuration.md b/doc/md/Shaarli-configuration.md index 920c7e27..8787f59d 100644 --- a/doc/md/Shaarli-configuration.md +++ b/doc/md/Shaarli-configuration.md @@ -120,11 +120,6 @@ Must be an associative array: `translation domain => translation path`. - **enable_thumbnails**: Enable or disable thumbnail display. - **enable_localcache**: Enable or disable local cache. -### Redirector - -- **url**: Redirector URL, such as `anonym.to`. -- **encode_url**: Enable this if the redirector needs encoded URL to work properly. - ## Configuration file example ```json @@ -185,8 +180,6 @@ Must be an associative array: `translation domain => translation path`. "hide_public_links": false, "hide_timestamps": false, "open_shaarli": false, - "redirector": "http://anonym.to/?", - "redirector_encode_url": false }, "general": { "header_link": "?", @@ -218,10 +211,6 @@ Must be an associative array: `translation domain => translation path`. "enable_thumbnails": true, "enable_localcache": true }, - "redirector": { - "url": "http://anonym.to/?", - "encode_url": false - }, "plugins": { "WALLABAG_URL": "http://demo.wallabag.org", "WALLABAG_VERSION": "1" -- cgit v1.2.3 From b49a04f796b9ad8533c53fee541132a4c2214909 Mon Sep 17 00:00:00 2001 From: ArthurHoaro Date: Sat, 9 Feb 2019 16:44:48 +0100 Subject: Rewrite IP ban management This adds a dedicated manager class to handle all ban interactions, which is instantiated and handled by LoginManager. IPs are now stored in the same format as the datastore, through FileUtils. Fixes #1032 #587 --- doc/md/Server-configuration.md | 2 ++ 1 file changed, 2 insertions(+) (limited to 'doc/md') diff --git a/doc/md/Server-configuration.md b/doc/md/Server-configuration.md index 78083a46..0930a489 100644 --- a/doc/md/Server-configuration.md +++ b/doc/md/Server-configuration.md @@ -404,6 +404,8 @@ If Shaarli is served behind a proxy (i.e. there is a proxy server between client - `X-Forwarded-Host` - `X-Forwarded-For` +In you [Shaarli configuration](Shaarli-configuration) `data/config.json.php`, add the public IP of your proxy under `security.trusted_proxies`. + See also [proxy-related](https://github.com/shaarli/Shaarli/issues?utf8=%E2%9C%93&q=label%3Aproxy+) issues. ## Robots and crawlers -- cgit v1.2.3 From 899d041137b949a8ff3e901508f8979b90ee93f5 Mon Sep 17 00:00:00 2001 From: ArthurHoaro Date: Sat, 9 Feb 2019 17:02:30 +0100 Subject: Documentation: drop PHP 7.0 compatibility in Shaarli 11.x related to #1249 --- doc/md/Server-configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/md') diff --git a/doc/md/Server-configuration.md b/doc/md/Server-configuration.md index 78083a46..4753df1d 100644 --- a/doc/md/Server-configuration.md +++ b/doc/md/Server-configuration.md @@ -17,7 +17,7 @@ Version | Status | Shaarli compatibility :---:|:---:|:---: 7.2 | Supported | Yes 7.1 | Supported | Yes -7.0 | Supported | Yes +7.0 | EOL: 2018-12-03 | Yes (up to Shaarli 0.10.x) 5.6 | EOL: 2018-12-31 | Yes (up to Shaarli 0.10.x) 5.5 | EOL: 2016-07-10 | Yes 5.4 | EOL: 2015-09-14 | Yes (up to Shaarli 0.8.x) -- cgit v1.2.3 From 86dcb9048f8b044afd87a95121dc5d3685d28b6a Mon Sep 17 00:00:00 2001 From: VirtualTam Date: Sat, 23 Feb 2019 16:48:10 +0100 Subject: Update badges, changelog and documentation for v0.10.3 Signed-off-by: VirtualTam --- doc/md/Download-and-Installation.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'doc/md') diff --git a/doc/md/Download-and-Installation.md b/doc/md/Download-and-Installation.md index 14649e06..1c4ad947 100644 --- a/doc/md/Download-and-Installation.md +++ b/doc/md/Download-and-Installation.md @@ -24,11 +24,11 @@ Using one of the following methods: 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. -The current latest released version is `v0.9.7` +The current latest released version is `v0.10.3` ```bash -$ wget https://github.com/shaarli/Shaarli/releases/download/v0.9.7/shaarli-v0.9.7-full.zip -$ unzip shaarli-v0.9.7-full.zip +$ wget https://github.com/shaarli/Shaarli/releases/download/v0.10.3/shaarli-v0.10.3-full.zip +$ unzip shaarli-v0.10.3-full.zip $ mv Shaarli /path/to/shaarli/ ``` -- cgit v1.2.3 From e92676ace2d64ba07cf9df65750f85bae173be29 Mon Sep 17 00:00:00 2001 From: VirtualTam Date: Tue, 16 Apr 2019 00:22:15 +0200 Subject: Update README, CHANGELOG and AUTHORS for v0.10.4 Signed-off-by: VirtualTam --- doc/md/Download-and-Installation.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'doc/md') diff --git a/doc/md/Download-and-Installation.md b/doc/md/Download-and-Installation.md index 1c4ad947..8c9e8a32 100644 --- a/doc/md/Download-and-Installation.md +++ b/doc/md/Download-and-Installation.md @@ -24,11 +24,11 @@ Using one of the following methods: 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. -The current latest released version is `v0.10.3` +The current latest released version is `v0.10.4` ```bash -$ wget https://github.com/shaarli/Shaarli/releases/download/v0.10.3/shaarli-v0.10.3-full.zip -$ unzip shaarli-v0.10.3-full.zip +$ wget https://github.com/shaarli/Shaarli/releases/download/v0.10.4/shaarli-v0.10.4-full.zip +$ unzip shaarli-v0.10.4-full.zip $ mv Shaarli /path/to/shaarli/ ``` -- cgit v1.2.3 From 6a4872520cbbc012b5a8358cd50c78844afe8d07 Mon Sep 17 00:00:00 2001 From: ArthurHoaro Date: Sat, 8 Jun 2019 13:59:19 +0200 Subject: Automatically retrieve description for new bookmarks If the option is enabled, it will try to find a meta tag containing the page description and keywords, just like we do for the page title. It will either look for regular meta tag or OpenGraph ones. The option is disabled by default. Note that keywords meta tags is mostly not used. In `configure` template, the variable associated with this setting is `$retrieve_description`. Fixes #1302 --- doc/md/Shaarli-configuration.md | 2 ++ 1 file changed, 2 insertions(+) (limited to 'doc/md') diff --git a/doc/md/Shaarli-configuration.md b/doc/md/Shaarli-configuration.md index a931ab1e..664e36dd 100644 --- a/doc/md/Shaarli-configuration.md +++ b/doc/md/Shaarli-configuration.md @@ -56,6 +56,8 @@ _These settings should not be edited_ - **timezone**: See [the list of supported timezones](http://php.net/manual/en/timezones.php). - **enabled_plugins**: List of enabled plugins. - **default_note_title**: Default title of a new note. +- **retrieve_description** (boolean): If set to true, for every new links Shaarli will try +to retrieve the description and keywords from the HTML meta tags. ### Security -- cgit v1.2.3 From a8fb97a0c37b5008765fa73d30a678418011adc1 Mon Sep 17 00:00:00 2001 From: ArthurHoaro Date: Sat, 13 Jul 2019 11:02:05 +0200 Subject: Default colors plugin - Documentation --- doc/md/Plugin-System.md | 17 +++++++++++++++++ doc/md/Plugins.md | 4 ++++ 2 files changed, 21 insertions(+) (limited to 'doc/md') 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 | [render_feed](#render_feed) | Allow to do add tags in RSS and ATOM feeds. | | [save_link](#save_link) | Allow to alter the link being saved in the datastore. | | [delete_link](#delete_link) | Allow to do an action before a link is deleted from the datastore. | +| [save_plugin_parameters](#save_plugin_parameters) | Allow to manipulate plugin parameters before they're saved. | @@ -471,6 +472,22 @@ Allow to execute any action before the link is actually removed from the datasto - created - updated + +#### save_plugin_parameters + +Triggered when the plugin parameters are saved from the plugin administration page. + +Plugins can perform an action every times their settings are updated. +For example it is used to update the CSS file of the `default_colors` plugins. + +##### Data + +`$data` input contains the `$_POST` array. + +So if the plugin has a parameter called `MYPLUGIN_PARAMETER`, +the array will contain an entry with `MYPLUGIN_PARAMETER` as a key. + + ## Guide for template designer ### 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: * `addlink-toolbar`: Adds the addlink input on the linklist page * `archiveorg`: For each link, add an Archive.org icon + * `default_colors`: Override default theme colors. + * `isso`: Let visitor comment your shaares on permalinks with Isso. * [`markdown`](https://github.com/shaarli/Shaarli/blob/master/plugins/markdown/README.md): Render shaare description with Markdown syntax. + * `piwik`: A plugin that adds Piwik tracking code to Shaarli pages. * [`playvideos`](https://github.com/shaarli/Shaarli/blob/master/plugins/playvideos/README.md): Add a button in the toolbar allowing to watch all videos. + * `pubsubhubbub`: Enable PubSubHubbub feed publishing * `qrcode`: For each link, add a QRCode icon. * [`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. -- cgit v1.2.3 From 58c2701e5401f40f32636e6395add70c3aeb3c11 Mon Sep 17 00:00:00 2001 From: nodiscc Date: Thu, 1 Aug 2019 19:09:05 +0200 Subject: doc: fix broken markdown link fixes https://github.com/shaarli/Shaarli/issues/1330 --- doc/md/Download-and-Installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/md') diff --git a/doc/md/Download-and-Installation.md b/doc/md/Download-and-Installation.md index 8c9e8a32..ec68762e 100644 --- a/doc/md/Download-and-Installation.md +++ b/doc/md/Download-and-Installation.md @@ -1,7 +1,7 @@ To install Shaarli, simply place the files in a directory under your webserver's Document Root (or directly at the document root). -Also, please make sure your server is properly [configured](Server-configuration). +Also, please make sure your server is properly [configured](Server-configuration.md). Multiple releases branches are available: -- cgit v1.2.3