MyShaarli/plugins/wallabag/README.md
2016-06-11 09:30:56 +02:00

37 lines
No EOL
1.2 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

## Save to Wallabag plugin for Shaarli
For each link in your Shaarli, adds a button to save the target page in your [wallabag](https://www.wallabag.org/).
### Installation
Clone this repository inside your `tpl/plugins/` directory, or download the archive and unpack it there.
The directory structure should look like:
```
└── tpl
└── plugins
   └── wallabag
   ├── README.md
   ├── wallabag.html
   ├── wallabag.meta
   ├── wallabag.php
   ├── wallabag.php
   └── WallabagInstance.php
```
To enable the plugin, you can either:
* enable it in the plugins administration page (`?do=pluginadmin`).
* add `wallabag` to your list of enabled plugins in `data/config.json.php` (`general.enabled_plugins` section).
### Configuration
Go to the plugin administration page, and edit the following settings (with the plugin enabled).
**WALLABAG_URL**: *Wallabag instance URL*
Example value: `http://v2.wallabag.org`
**WALLABAG_VERSION**: *Wallabag version*
Value: either `1` (for 1.x) or `2` (for 2.x)
> Note: these settings can also be set in `data/config.json.php`, in the plugins section.