|
0
|
1 # Plugin Installer for Roundcube
|
|
|
2
|
|
|
3 This installer ensures that plugins end up in the correct directory:
|
|
|
4
|
|
|
5 * `<roundcube-root>/plugins/plugin-name`
|
|
|
6
|
|
|
7 ## Minimum setup
|
|
|
8
|
|
|
9 * create a `composer.json` file in your plugin's repository
|
|
|
10 * add the following contents
|
|
|
11
|
|
|
12 ### sample composer.json for plugins
|
|
|
13
|
|
|
14 {
|
|
|
15 "name": "yourvendor/plugin-name",
|
|
|
16 "license": "the license",
|
|
|
17 "description": "tell the world what your plugin is good at",
|
|
|
18 "type": "roundcube-plugin",
|
|
|
19 "authors": [
|
|
|
20 {
|
|
|
21 "name": "<your-name>",
|
|
|
22 "email": "<your-email>"
|
|
|
23 }
|
|
|
24 ],
|
|
|
25 "repositories": [
|
|
|
26 {
|
|
|
27 "type": "composer",
|
|
|
28 "url": "http://plugins.roundcube.net"
|
|
|
29 }
|
|
|
30 ]
|
|
|
31 "require": {
|
|
|
32 "roundcube/plugin-installer": "*"
|
|
|
33 },
|
|
|
34 "minimum-stability": "dev-master"
|
|
|
35 }
|
|
|
36
|
|
|
37 * Submit your plugin to [plugins.roundcube.net](http://plugins.roundcube.net).
|
|
|
38
|
|
|
39 ## Installation
|
|
|
40
|
|
|
41 * clone Roundcube
|
|
|
42 * `cp composer.json-dist composer.json`
|
|
|
43 * add your plugin in the `require` section of composer.json
|
|
|
44 * `composer.phar install`
|
|
|
45
|
|
|
46 Read the whole story at [plugins.roundcube.net](http://plugins.roundcube.net/about).
|
