diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/cli.markdown | 26 | ||||
-rw-r--r-- | doc/config.markdown | 13 | ||||
-rw-r--r-- | doc/index.markdown | 1 | ||||
-rw-r--r-- | doc/plugin-directory.markdown | 15 |
4 files changed, 52 insertions, 3 deletions
diff --git a/doc/cli.markdown b/doc/cli.markdown index 20e3566a..96bffe2d 100644 --- a/doc/cli.markdown +++ b/doc/cli.markdown @@ -41,6 +41,10 @@ Available commands: locale:sync Synchronize all translations based on the fr_FR locale notification notification:overdue-tasks Send notifications for overdue tasks + plugin + plugin:install Install a plugin from a remote Zip archive + plugin:uninstall Remove a plugin + plugin:upgrade Update all installed plugins projects projects:daily-stats Calculate daily statistics for all projects trigger @@ -170,3 +174,25 @@ You will be prompted for a password and confirmation. Characters are not printed ```bash ./kanboard user:reset-2fa my_user ``` + +### Install a plugin + +```bash +./kanboard plugin:install https://github.com/kanboard/plugin-github-auth/releases/download/v1.0.1/GithubAuth-1.0.1.zip +``` + +Note: Installed files will have the same permissions as the current user + +### Remove a plugin + +```bash +./kanboard plugin:uninstall Budget +``` + +### Upgrade all plugins + +```bash +./kanboard plugin:upgrade +* Updating plugin: Budget Planning +* Plugin up to date: Github Authentication +``` diff --git a/doc/config.markdown b/doc/config.markdown index 0e3c3198..0325358d 100644 --- a/doc/config.markdown +++ b/doc/config.markdown @@ -15,14 +15,21 @@ define('LOG_DRIVER', 'file'); // Other drivers are: syslog, stdout, stderr or fi The log driver must be defined if you enable the debug mode. The debug mode logs all SQL queries and the time taken to generate pages. -Plugins folder --------------- +Plugins +------- + +Plugin folder: ```php -// Plugin directory define('PLUGINS_DIR', 'data/plugins'); ``` +Enable/disable plugin installation from the user interface: + +```php +define('PLUGIN_INSTALLER', true); // Default is true +``` + Folder for uploaded files ------------------------- diff --git a/doc/index.markdown b/doc/index.markdown index 5fc576d8..ee982dbb 100644 --- a/doc/index.markdown +++ b/doc/index.markdown @@ -110,6 +110,7 @@ Technical details - [Environment variables](env.markdown) - [Email configuration](email-configuration.markdown) - [URL rewriting](nice-urls.markdown) +- [Plugin Directory](plugin-directory.markdown) ### Database diff --git a/doc/plugin-directory.markdown b/doc/plugin-directory.markdown new file mode 100644 index 00000000..385e3360 --- /dev/null +++ b/doc/plugin-directory.markdown @@ -0,0 +1,15 @@ +Plugin Directory Configuration +============================== + +To install, update and remove plugins from the user interface, you must have those requirements: + +- The plugin directory must be writeable by the web server user +- The Zip extension must be available on your server +- The config parameter `PLUGIN_INSTALLER` must be set at `true` + +To disable this feature, change the value of `PLUGIN_INSTALLER` to `false` in your config file. +You can also change the permissions of the plugin folder on the filesystem. + +Only administrators are allowed to install plugins from the user interface. + +By default, only plugin listed on Kanboard's website are available. |