This website is a simple HTML static webpage to serve Kanboard.
- Update the
plugins.json
file- This file is now sorted alphabetically
- Your plugin submission should be positioned in the file in alphabetical order by plugin name
- This file is used in the Kanboard interface Plugins Directory
- Template:
"MyPlugin": { "author": "Plugin Developer Name", "compatible_version": ">=1.2.20", "description": "My plugin description", "download": "https://github.com/PluginDeveloperName/MyPlugin/releases/download/v1.0/MyPlugin-1.0.zip", "has_hooks": false, "has_overrides": false, "has_schema": false, "homepage": "https://github.com/PluginDeveloperName/MyPlugin", "is_type": "plugin", "last_updated": "2022-11-10", "license": "MIT", "readme": "https://github.com/PluginDeveloperName/MyPlugin/blob/master/README.md", "remote_install": true, "title": "MyPlugin", "version": "1.0.0" }
- This file is now sorted alphabetically
- Update the
plugins.html
file- This file is used in the Kanboard website Plugins Directory
- Template:
<dt><a href="https://github.com/pluginURL">Plugin Name</a></dt> <dd> <p>Enter your plugin description here</p> <p><em>By Your Name</em></p> </dd>
- Send a Pull Request of your changes
- Once merged, this will automatically update the above file(s) with your changes
Mandatory
compatible_version
- This is the latest stable version tested with your plugin
download
- Do not use the GitHub archive URL for the download link
- Once unzipped, the directory structure is not the same as the one mentioned above. GitHub usually appends the branch name to the folder. As a result, Kanboard won't be able to load the plugin.
- Make your own archive or set the
remote_install
field tofalse
. - If you release a new version of your plugin, always cross-check the version numbers of your archive filename and the url
- Do not use the GitHub archive URL for the download link
remote_install
- Allows people to install the plugin from the Kanboard user interface
- The last property should NOT have a comma at the end of the line (before the curly bracket)
- The last plugin in the list should NOT have a comma at the end of the section (after the curly bracket)
Optional
has_schema
true
orfalse
- Specify whether your plugin has any database changes
- Boolean type
has_overrides
true
orfalse
- Specify whether your plugin has any template overrides
- Boolean type
has_hooks
true
orfalse
- Specify whether your plugin has used any hooks
- Boolean type
is_type
plugin
oraction
ortheme
ormulti
orconnector
- Specify whether your plugin is:
Value Type Description plugin
Normal A plugin with no automatic actions action
Action A plugin for actions only theme
Normal A plugin for theming and styling of the interface connector
Normal A plugin connecting to third party services - may contain actions multi
Normal A plugin containing all or any combination of the above functions - String type
last_updated
2022-11-15
- Specify which date your plugin was last updated for general release
- ISO-8601 date type
MyPlugin-1.0.0.zip <= Zip archive filename stating release version
└── MyPlugin <= Plugin name
├── Assets <= Javascript/CSS files
│ └── cs
│ └── js
├── Controller
├── LICENSE <= Plugin license
├── Helper
├── Locale
│ └── fr_FR
│ └── en_US
| ├── ...
├── Model
├── Plugin.php <= Plugin registration file
├── README.md
├── Schema <= Database migrations
├── Template <= Template files
│ ├── ...
├── Test <= Unit tests
│ └── ...
- The archive will be extracted by Kanboard into the
plugins
folder asplugins/MyPlugin
. - Your plugin archive must contains a folder with the plugin name (no branch name or version numbers, just the plugin name)