1. Home
  2. OmniCenter Reference
  3. MediaWiki Integration

MediaWiki Integration

OmniCenter can link to your own documentation archive stored on a separate MediaWiki server. OmniCenter uses the native MediaWiki API to connect to the server and can even manage user accounts for you, acting as a gateway to your documentation content from directly within OmniCenter.

To enable MediaWiki connectivity in OmniCenter, turn on “External KB integration” on the System Preferences page (Administration → System → Preferences).

 

The API URL field should be set to the path to your MediaWiki API installation.

OmniCenter will create accounts on the wiki when user accounts are created in OmniCenter or permissions are changed. In order to accomplish this, along with editing the pages within OmniCenter, you must provide a username and password for OmniCenter to use as a “master API user.” This user must be granted permissions to edit and create pages, add and modify user permissions, as well as the “writeapi” permission, which is not on by default. See the MediaWiki User Rights documentation for details on how to configure this on your MediaWiki installation.

Security Recommendation

For optimum security, Netreo recommends using HTTPS for the API connection, and iptables or other firewall software to limit access to the wiki and allow only OmniCenter to connect.

MediaWiki Settings Requirements
It is highly recommended that you set your $wgScriptPath to ‘/wiki’ as specified below. OmniCenter does not support script paths longer than a single directory (i.e., ‘/something/path/to/wiki’ is not supported).

Developed and Tested on MediaWiki version 1.25.2

The following parameters need to be set in LocalSettings.php on the MediaWiki server.

Basic Integration

$wgEnableAPI = true;
$wgEnableWriteAPI = true;
$wgEnableUploads = true;
$wgHashedUploadDirectory = false;

Export Features
If you wish to allow OmniCenter to export all Wiki content into PDF format, the following additional settings are required.

$wgExportFromNamespaces = true;
$wpExportTemplates = true;
$wgExportAllowAll = true;
$wgExportMaxLinkDepth = 0;
$wgExportAllowListContributors = true;
$wgExportMaxHistory = 1;

Linking Content to OmniCenter
OmniCenter will look for articles on the wiki formatted as Entity::Name. For example, Device::Router1 or Site::Netreo_HQ. The complete list of supported entities is below.

OmniCenter Entity to Link Page Name Format
Device Device::DeviceName
Category OCcategory::CategoryName
Site Site::SiteName
Strategic Group StrategicGroup::GroupName
Web Application Synthetic Check Application::AppName
Email Application Synthetic Check Email::EmailCheckName
Interface Tag Tag::TagName

User Permissions
OmniCenter will create accounts on the wiki when user accounts are created in OmniCenter or permissions are changed. If the OmniCenter user has admin rights, they will also have admin rights to the Wiki.

Security Recommendation

While these users would theoretically be able to log into the Wiki directly, OmniCenter creates a random password for the user that is not shared, so direct access for these users is impractical.

OmniCenter Permissions Wiki Permissions
User Read only access, can comment on pages (discussion).
Power User Read only access, can comment on pages (discussion).
Admin Can edit pages directly on wiki, can comment, can rollback, can view change history.
Super Admin Can edit pages directly on wiki, can comment, can rollback, can view change history.
Updated on April 2, 2019

Was this article helpful?

Need Support?
Can’t find the answer you’re looking for? Don’t worry we’re here to help!
Contact Support

Leave a Reply