Back to Openproject

Wikis

docs/system-admin-guide/wikis/README.md

17.6.02.2 KB
Original Source

Wikis

Under Administration → Wikis you can configure the wiki providers that OpenProject uses when linking to or creating wiki pages from work packages.

OpenProject supports two types of wiki providers:

  • Internal wiki: the built-in OpenProject Wiki as a wiki provider.
  • External wikis: third-party wiki systems, such as XWiki.

Wiki providers are configured globally and are available to all projects. Each provider may expose one or more wikis, depending on configuration.

Internal wiki

The Internal wiki setting enables the built-in OpenProject wiki as a wiki provider for the wiki integration used in work packages.

[!NOTE] As of OpenProject 17.6, this setting does not affect the regular OpenProject Wiki module. Projects can continue to use their project wiki as usual when the Wiki module is enabled under Project settings → Modules. This WILL CHANGE in the upcoming releases. We therefore advise to only disable the internal provider, if you are not planning to use internal wikis at all.

When the internal wiki provider is enabled:

  • The OpenProject wiki is available as a wiki provider when linking to or creating wiki pages from a work package.
  • Each project's existing wiki can be selected through this integration.

When the internal wiki provider is disabled:

  • The OpenProject wiki is no longer available as a wiki provider for work packages.
  • Existing project wikis remain available through the project's Wiki module, provided that module is enabled.

Permissions for pages accessed through the internal wiki provider are determined by the user's role in the corresponding project.

External wikis

Under Wiki providers you can configure external wiki providers. External wiki providers manage their own user permissions, so each OpenProject user must be connected to a corresponding user account on the external wiki instance.

To learn how to link a wiki page to a work package or create a new one, refer to this user guide.