aboutsummaryrefslogtreecommitdiffhomepage
path: root/plugins/wallabag/README.md
diff options
context:
space:
mode:
authorArthurHoaro <arthur@hoa.ro>2015-12-22 10:20:27 +0100
committerArthurHoaro <arthur@hoa.ro>2015-12-27 15:30:34 +0100
commit938d9cce77ed5098dd69643795cb4014f3688b35 (patch)
treeb0bbdd80b81e6f54009f0c67631e69020e2f4399 /plugins/wallabag/README.md
parent79851b489087f8a3027ecd805255cd13ee6fcf63 (diff)
downloadShaarli-938d9cce77ed5098dd69643795cb4014f3688b35.tar.gz
Shaarli-938d9cce77ed5098dd69643795cb4014f3688b35.tar.zst
Shaarli-938d9cce77ed5098dd69643795cb4014f3688b35.zip
Wallabag plugin improvement
* Fixes a bug where URL weren't properly encoded. * Adds Wallabag V2 support. * Adds a URL function to handle trailing slash. * UT. * README updated.
Diffstat (limited to 'plugins/wallabag/README.md')
-rw-r--r--plugins/wallabag/README.md25
1 files changed, 19 insertions, 6 deletions
diff --git a/plugins/wallabag/README.md b/plugins/wallabag/README.md
index 08e0d44a..5bc35be1 100644
--- a/plugins/wallabag/README.md
+++ b/plugins/wallabag/README.md
@@ -2,7 +2,8 @@
2 2
3For each link in your Shaarli, adds a button to save the target page in your [wallabag](https://www.wallabag.org/). 3For each link in your Shaarli, adds a button to save the target page in your [wallabag](https://www.wallabag.org/).
4 4
5### Installation/configuration 5### Installation
6
6Clone this repository inside your `tpl/plugins/` directory, or download the archive and unpack it there. 7Clone this repository inside your `tpl/plugins/` directory, or download the archive and unpack it there.
7The directory structure should look like: 8The directory structure should look like:
8 9
@@ -11,19 +12,31 @@ The directory structure should look like:
11 └── plugins 12 └── plugins
12    └── wallabag 13    └── wallabag
13    ├── README.md 14    ├── README.md
15 ├── config.php.dist
14    ├── wallabag.html 16    ├── wallabag.html
17    ├── wallabag.php
15    └── wallabag.png 18    └── wallabag.png
16``` 19```
17 20
18To enable the plugin, add `'wallabag'` to your list of enabled plugins in `data/options.php` (`PLUGINS` array) 21To enable the plugin, add `'wallabag'` to your list of enabled plugins in `data/options.php` (`PLUGINS` array).
19. This should look like: 22This should look like:
20 23
21``` 24```
22$GLOBALS['config']['PLUGINS'] = array('qrcode', 'any_other_plugin', 'wallabag') 25$GLOBALS['config']['PLUGINS'] = array('qrcode', 'any_other_plugin', 'wallabag')
23``` 26```
24 27
25Then, set the `WALLABAG_URL` variable in `data/options.php` pointing to your wallabag URL. Example: 28### Configuration
29
30Copy `config.php.dist` into `config.php` and setup your instance.
26 31
32*Wallabag instance URL*
27``` 33```
28$GLOBALS['config']['WALLABAG_URL'] = 'http://demo.wallabag.org' ; //Base URL of your wallabag installation 34$GLOBALS['config']['WALLABAG_URL'] = 'http://v2.wallabag.org' ;
29``` \ No newline at end of file 35```
36
37*Wallabag version*: either `1` (for 1.x) or `2` (for 2.x)
38```
39$GLOBALS['config']['WALLABAG_VERSION'] = 2;
40```
41
42> Note: these settings can also be set in `data/config.php`. \ No newline at end of file