Managing Plugins
From AuthPuppy Wiki
Many functionnalities are brought into authpuppy by plugins.
You may view available plugins at http://plugins.authpuppy.org
You may view the installed plugin on an authpuppy installation at http://your.server/plugin/manage, or by clicking the Manage plugins link from the menu. A list of all available plugins and their releases and updates can also be viewed by clicking the View all available plugins and updates on the plugin management page.
Contents |
Managing installed plugins
The plugin management page can be reached by clicking the Manage plugins link in the menu or by going to http://your.server/plugin/manage. You will see a list of all installed plugins. You may enable or disable them (disabling them will not uninstall them and all configuration options that have been saved before will remain). If a database upgrade is necessary, you may click on the link Upgrade to automatically update the database schema.
If the plugin has configuration options, you may click on its name and you'll access the configuration form.
Installing or updating plugins
- Click on the View all available plugins and updates link on the plugin management page
or
- Navigate to http://your.server/plugin/manage/all.
Plugins can be installed automatically, given some server configurations beforehand or manually.
Warning: because some plugins upgrade may also have database upgrade, it would be a good practice to disable the plugin before updating it, then go to the Manage Plugins page, do the database upgrade and reenable the plugin.
Automatic install
For this procedure to work, the web server process must have write access to some directories of the site, namely: plugins/ and web/ (for publishing web assets)
- Click on the install link next to the plugin release to install.
- See if errors occurred. Most likely it may be a permissions problem or archive format. If you can't solve them, try the manual install procedure.
Manual install
- Click the Download link next to the plugin release to download the plugins archive
- Extract the plugin's directory from the archive. The top directory of the archive should be the <pluginname>Plugin directory. If this is not the case, create the directory and copy the plugin's files into it.
- Copy the <pluginname>Plugin directory in the plugins directory of the authpuppy installation.
- Check if there are web assets to publish for this plugin (csses, javascripts, etc). They would be located in the <plugginname>Plugin/web directory. If so, copy (or link) the content of the <pluginname>Plugin/web directory to a directory named <pluginname>Plugin in the main web directory.
In summary,
| Directory in archive | Directory in authpuppy (AUTHPUPPY_ROOT is the root of authpuppy) |
|---|---|
| apMyPlugin | AUTHPUPPY_ROOT/plugins/apMyPlugin |
| apMyPlugin/web/* | AUTHPUPPY_ROOT/web/apMyPlugin/ |
Post-install operations
- Click on the Manage Plugins link in the menu
or
- Navigate to http://your.server/plugin/manage.
- Perform any database upgrade necessary
- Enable and configure the new installed modules
- Once enabled, new menu items may be made available by the plugin, as well as some new functionnalities for nodes and connections or other plugins' behavior.
