Home

Welcome to the vestacp-plugin-manager wiki!

Some plugin examples:

• Vestoid Theme
• VestaCP Web Apps
• Single Mail List

Plugin structure

• /vestacp.json - Information about the plugin.
• /bin/ - All files in this directory will be linked to vesta "/usr/local/vesta/bin".
• /web/ - A symbolic link will be created to this directory with the plugin name inside "/usr/local/vesta/web/plugin/".
• /web/functions.php - Allows the plugin to perform actions before the layout is loaded.
• /hook/ - Hooks to the plugin life cycle.

The only required file for the plugin is vestacp.json.
If the plugin does not have a web interface it will not need the "web" directory, or if it does not have a CLI interface it will not need the "bin".

Hooks for the plugin lifecycle

• /hook/post_install - Run after the plugin installation and before create the symlinks.
• /hook/post_enable - Run when plugin status change to enabled.
• /hook/pre_disable - Run when plugin status change to disabled.
• /hook/pre_update - Run before starting an update.
• /hook/post_update - Run after completing the update.
• /hook/pre_uninstall - Run after delete the symlinks and before delete plugin files.

vestacp.json

{
  "name": "plugin-name",
  "description": "Plugin description",
  "version": "0.0.1",
  "min-vesta": "0.9.8",
  "repository": "https://github.com/jhmaverick/plugin-name",
  "homepage": "https://github.com/jhmaverick/plugin-name#readme",
  "author": {
    "name": "João Henrique",
    "email": "joao_henriquee@outlook.com",
    "homepage": "https://github.com/jhmaverick/"
  }
}

• name: The plugin name. Will be used in the plugin directory and the plugin identification. Only include lowercase alphanumeric, dashes, and underscores characters.
• repository: The plugin repository. Used to download updates in v-update-plugin.
• min-vesta: Minimum vesta version.