]> git.immae.eu Git - github/shaarli/Shaarli.git/blame - plugins/wallabag/README.md
PluginManager no longer uses singleton pattern
[github/shaarli/Shaarli.git] / plugins / wallabag / README.md
CommitLineData
263d1f64
A
1## Save to Wallabag plugin for Shaarli
2
3For each link in your Shaarli, adds a button to save the target page in your [wallabag](https://www.wallabag.org/).
4
938d9cce
A
5### Installation
6
263d1f64
A
7Clone this repository inside your `tpl/plugins/` directory, or download the archive and unpack it there.
8The directory structure should look like:
9
10```
11└── tpl
12 └── plugins
13    └── wallabag
14    ├── README.md
15    ├── wallabag.html
51def0d8 16    ├── wallabag.meta
938d9cce 17    ├── wallabag.php
51def0d8
A
18    ├── wallabag.php
19    └── WallabagInstance.php
263d1f64
A
20```
21
51def0d8 22To enable the plugin, you can either:
263d1f64 23
51def0d8
A
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).
263d1f64 26
938d9cce
A
27### Configuration
28
51def0d8 29Go to the plugin administration page, and edit the following settings (with the plugin enabled).
263d1f64 30
51def0d8
A
31**WALLABAG_URL**: *Wallabag instance URL*
32Example value: `http://v2.wallabag.org`
938d9cce 33
51def0d8
A
34**WALLABAG_VERSION**: *Wallabag version*
35Value: either `1` (for 1.x) or `2` (for 2.x)
938d9cce 36
51def0d8 37> Note: these settings can also be set in `data/config.json.php`, in the plugins section.