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 ```bash
  11 └── tpl
  12     └── plugins
  13         └── wallabag
  14             ├── README.md
  15             ├── wallabag.html
  16             ├── wallabag.meta
  17             ├── wallabag.php
  18             ├── wallabag.php
  19             └── WallabagInstance.php
  20 ```
  21
  22 To enable the plugin, you can either:
  23
  24   * enable it in the plugins administration page (`?do=pluginadmin`).
  25   * add `wallabag` to your list of enabled plugins in `data/config.json.php` (`general.enabled_plugins` section).
  26
  27 ### Configuration
  28
  29 Go to the plugin administration page, and edit the following settings (with the plugin enabled).
  30
  31 **WALLABAG_URL**: *Wallabag instance URL*
  32 Example value: `http://v2.wallabag.org`
  33
  34 **WALLABAG_VERSION**: *Wallabag version*
  35 Value: either `1` (for 1.x) or `2` (for 2.x)
  36
  37 > Note: these settings can also be set in `data/config.json.php`, in the plugins section.