plugins/wallabag/README.md

   1 ## Save to Wallabag plugin for Shaarli
   2
   3 For each link in your Shaarli, adds a button to save the target page in your [wallabag](https://www.wallabag.org/).
   4
   5 ### Installation
   6
   7 Clone this repository inside your `tpl/plugins/` directory, or download the archive and unpack it there.
   8 The directory structure should look like:
   9
  10 ```
  11 └── tpl
  12     └── plugins
  13         └── wallabag
  14             ├── README.md
  15             ├── config.php.dist
  16             ├── wallabag.html
  17             ├── wallabag.php
  18             └── wallabag.png
  19 ```
  20
  21 To enable the plugin, add `'wallabag'` to your list of enabled plugins in `data/options.php` (`PLUGINS` array).
  22 This should look like:
  23
  24 ```
  25 $GLOBALS['config']['PLUGINS'] = array('qrcode', 'any_other_plugin', 'wallabag')
  26 ```
  27
  28 ### Configuration
  29
  30 Copy `config.php.dist` into `config.php` and setup your instance.
  31
  32 *Wallabag instance URL*
  33 ```
  34 $GLOBALS['config']['WALLABAG_URL'] = 'http://v2.wallabag.org' ;
  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`.