DokuWiki Installer

:

This page assists in the first time installation and configuration of Dokuwiki. More info on this installer is available on it's own documentation page.

DokuWiki uses ordinary files for the storage of wiki pages and other information associated with those pages (e.g. images, search indexes, old revisions, etc). In order to operate successfully DokuWiki must have write access to the directories that hold those files. This installer is not capable of setting up directory permissions. That normally needs to be done directly on a command shell or if you are using hosting, through FTP or your hosting control panel (e.g. cPanel).

This installer will setup your DokuWiki configuration for ACL, which in turn allows administrator login and access to DokuWiki's admin menu for installing plugins, managing users, managing access to wiki pages and alteration of configuration settings. It isn't required for DokuWiki to operate, however it will make Dokuwiki easier to administer.

Experienced users or users with special setup requirements should use these links for details concerning installation instructions and configuration settings.

For security reasons this script will only work with a new and unmodified Dokuwiki installation. You should either re-extract the files from the downloaded package or consult the complete Dokuwiki installation instructions

driven by DokuWiki powered by PHP
Interactions between the SOAP API and plugins [Mantis Bug Tracker Wiki]

User Tools

Site Tools


mantisbt:soap_and_plugins

Interactions between the SOAP API and plugins

RFC: this page is a request for comments, nothing is set in stone

Current status

The SOAP API currently does not accept any contributions from plugins, the plugins contributes fields or methods. The main reason is that the plugins do not have meaningful hooks which they can use to contribute safely to the SOAP API.

Constraints

SOAP API clients are usually sensitive to changes in the format of the data they receive, so the mechanism for plugins contributing additional fields to the SOAP output must either be backwards compatible or a one-time change which can accomodate multiple plugins.

Possible mechanisms

Wrapping plugin fields as custom fields

The SOAP API already has support for custom fields, which describe fields in terms of data types and validation . Plugins can declare for the SOAP API and other possible APIs the type of fields they expose. These fields can then be processed by SOAP API clients and submitted back.

Declaring custom methods

The SOAP API can register capabilities on behalf of the plugins. A base installation of MantisBT 1.2.6 with no plugins will have the capabilities [Core = 1.2.6 ] . Including version 1.0 of the TimeTracking plugin will mean that the capabilities are [Core = 1.2.6, TimeTracking = 1.0]. We will also provide means for the plugins to declare custom methods which will then be invoked by the SOAP clients.

A client is expected to know what methods and fields are exposed by a certain capability. While the Core capability will be documented by the WSDL, the plugin-declared capabilities - dynamic by nature - will not be exposed using WSDL and their correct usage will be enforced by the plugins.

mantisbt/soap_and_plugins.txt · Last modified: 2013/08/30 12:43 by dregad