]> git.immae.eu Git - github/shaarli/Shaarli.git/blame - plugins/wallabag/README.md
Fixes #411: remove hardcoded plugin icon size
[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
938d9cce 15 ├── config.php.dist
263d1f64 16    ├── wallabag.html
938d9cce 17    ├── wallabag.php
263d1f64
A
18    └── wallabag.png
19```
20
938d9cce
A
21To enable the plugin, add `'wallabag'` to your list of enabled plugins in `data/options.php` (`PLUGINS` array).
22This should look like:
263d1f64
A
23
24```
25$GLOBALS['config']['PLUGINS'] = array('qrcode', 'any_other_plugin', 'wallabag')
26```
27
938d9cce
A
28### Configuration
29
30Copy `config.php.dist` into `config.php` and setup your instance.
263d1f64 31
938d9cce 32*Wallabag instance URL*
263d1f64 33```
938d9cce
A
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`.