Giter Site home page Giter Site logo

plugin-installer's Introduction

Plugin Installer for Roundcube

This installer ensures that plugins and skins end up in the correct directory:

  • Plugins - <roundcube-root>/plugins/plugin-name
  • Skins - <roundcube-root>/skins/skin-name

Minimum setup

  • create a composer.json file in your plugin's repository
  • add the following contents

sample composer.json for plugins

{
    "name": "<your-vendor-name>/<plugin-name>",
    "type": "roundcube-plugin",
    "license": "GPL-3.0+",
    "require": {
        "roundcube/plugin-installer": ">=0.3.0"
    }
}

sample composer.json for skins

{
    "name": "<your-vendor-name>/<skin-name>",
    "type": "roundcube-skin",
    "license": "GPL-3.0+",
    "require": {
        "roundcube/plugin-installer": ">=0.3.0"
    }
}

Roundcube specific composer.json params

For both plugins and skins you can, optionally, add the following section to your composer.json file. All properties are optional and provided below with example values. persistent-files defines a list of files which should be maintained across updates. By default only config.inc.php is maintained. The array should contain paths relative to the root of your plugin.

"extra": {
    "roundcube": {
        "min-version": "1.4.0",
        "sql-dir": "./SQL",
        "post-install-script": "./bin/install.sh",
        "post-update-script": "./bin/update.sh",
        "persistent-files": ["config.inc.php", "skins/elastic/_custom.less"]
    }
}

Configuration

This installer will ask if you want to enable each plugin or skin as it is installed. To always enable all plugins or skins add enable-plugin/enable-skin to the config section in the composer.json in the root of your Roundcube directory. When uninstalling packages Composer will not remove the folder. To remove the folder set uninstall-remove-folder in your config.

"config": {
    "roundcube": {
        "enable-plugin": true,
        "enable-skin": true,
        "uninstall-remove-folder": true
    }
}

Repository

Submit your plugin or skin to Packagist.

Installation

  • clone Roundcube
  • cp composer.json-dist composer.json
  • add your plugin in the require section of composer.json
  • composer.phar install

Read the whole story at plugins.roundcube.net.

plugin-installer's People

Contributors

thomascube avatar johndoh avatar alecpl avatar till avatar takika avatar jeromelebleu avatar dsoares avatar mazzanet avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.