glFusion Wiki

Site Tools


glfusion:plugins:dokuwikiplugin:start

DokuWiki Integration to glFusion CMS

DokuWiki is developed by Andreas Gohr and the DokuWiki Community - http://www.dokuwiki.org. Copyright 2004-2017 © Andreas Gohr andi [at] splitbrain [dot] org1) and the DokuWiki Community

DokuWiki is a standards compliant, simple to use Wiki, mainly aimed at creating documentation of any kind. It is targeted at developer teams, workgroups and small companies. It has a simple but powerful syntax which makes sure the datafiles remain readable outside the Wiki and eases the creation of structured texts. All data is stored in plain text files – no database is required.

The DokuWiki Integration Plugin for glFusion provides an integration of DokuWiki with your glFusion v1.6.0+ website.

This plugin will provide the following features:

  • Integrated user authentication - All glFusion users will be mapped to DokuWiki and all user administration is handled by glFusion.
  • DokuWiki's contents will be searched using glFusion's Search and Advanced Search.
  • Administrative capabilities are handled via glFusion groups / features - DokuWiki Admin group has full administrative capabilities.
  • glFusion groups can be used to assign permissions in DokuWiki.
  • Integration with glFusion's What's New block.
  • Support for a [wiki:] auto tag.
  • Support for all glFusion auto tags.
  • Automatic detection of the users language setting so DokuWiki will use the same language.
  • Full integration with glFusion's look & feel.
  • Integration with the Tag Plugin

System Requirements

DokuWiki has the following system requirements:

  • PHP 5.3.3 and higher.
  • PHP's GD extension for use with libGD 2 (a graphics library) is recommended but not needed
  • DokuWiki should work in PHP's Safe Mode, depending on your hosts configuration you may need to use the safemodehack option
  • DokuWiki is designed to run with PHP's Option register_globals set to off.

This integration is based on glFusion v1.6.0 and will not work with previous version of glFusion.

DokuWiki requires that your site be configured with UTF-8 encoding. If you site is not already setup for UTF-8, you may want to consider converting. Installing DokuWiki on a non-UTF-8 site will work, but some characters may get corrupted or not display properly.
For those running on Windows IIS, if you have IIS password installed to mimic .htaccess password behavior you will have issues with DokuWiki. In order to get around this delete all .htaccess files in /public_html/dokuwiki/. Do not delete the .htaccess files unless you have a problem, this is a rare set of circumstances.

Installation

The DokuWiki Plugin uses the glFusion automated plugin installer. Simply upload the distribution using the glFusion plugin installer located in the Plugin Administration page.

Manual Installation

Some users have reported issues when using the automatic plugin installer. Due to the size of the DokuWiki plugin (number of files in the distribution), some web servers may timeout before the plugin installer is able to copy all the files to their proper location. In this case, you will need to perform a manual installation.

Once you have the files loaded onto your web server, you will need to rename or copy the following .dist files to their corresponding .php file:

  • public_html/conf/acl.auth.php.dist to acl.auth.php
  • public_html/conf/local.php.dist to local.php

Once you have renamed the distribution files (new installs only, upgrades do not need to copy these files), you can now tell glFusion to install the plugin. Go to the Plugin Administration screen and select the install icon from the plugin list.

DokuWiki must have write permissions to the public_html/dokuwiki/data/ directory and all directories below it. The plugin installer will check these permissions, please ensure they are writable by your web server.

Upgrading DokuWiki

To upgrade an existing DokuWiki installation, simply upload the latest version through the Plugin Administration page. All your wiki pages will be left as they are.

Upgrading from versions prior to v4.2.0

If you are upgrading from a version older than v4.2.0, you will need to navigate to the DokuWiki Administrative Interface, Configuration and update the following 2 fields:

superuser
Add @dokuwiki_admin to the list - so it will look like @Root,@dokuwiki_admin
manager
Add @dokuwiki_admin,@dokuwiki_manager to the list - so it will look like @Root,@dokuwiki_admin,@dokuwiki_manager

Configuring DokuWiki

The DokuWiki Integration Plugin allows you to tailor some of the glFusion integration features by modifying the configuration. The configuration settings are available in glFusion's online configuration manager :: Command & Control → Configuration → DokuWiki

Enable What's New Block Support
If this is set to True, DokuWiki will be integrated into the glFusion What's New block. Set to 0 to disable integration.
Number of days to include
Set this to the number of days that will be included in the What's New block.
Maximum length of what's new entry
Set this to the maximum number of characters wide you will allow listings in the What's New block. Truncated items will have a … appended to the end.
Login Required to view wiki
Set this to True to require a user to be logged into the site before granting access to DokuWiki. Set to 0 to allow non-logged in users access.
Restrict Access to this group
If you want only allow access to DokuWiki for a specific group, place that group name in the entry field. Leave the entry blank to allow all groups access to DokuWiki.
Disable glFusion Search Integration
Set this to True to disable search integration with glFusion's main search feature. Set to False to allow DokuWiki results to be displayed in glFusion's main search.
Blocks to display
When viewing the wiki, which glFusion blocks should be displayed - i.e.; Left and Right blocks, no blocks, or right only
Directory where wiki resides
If you would like to rename the directory where DokuWiki resides inside glFusion's public_html/ directory, change the name here. For example, many folks would prefer to have the public facing directory be named wiki/ instead of dokuwiki/. Once you change the name, You Must Manually Copy the DokuWiki Files to the New Directory.
Don't forget to copy the DokuWiki files to the new directory if you change the public_html directory above.

DokuWiki / glFusion Groups

DokuWiki Admin
Has full access to all DokuWiki configuration options, including access control lists and full edit capabilities on all wiki pages. Any user in this group will have full administrative rights to the DokuWiki configuration and all pages.
DokuWiki Manager
Limited access to the Revert Manager - a tool to help combat wikispam. Generally you can assign this group to users who help monitor your wiki for spam posts and they will be enabled to run the Revert Manager to automatically remove any spam entries.

DokuWiki Configuration

There are a few protected DokuWiki configuration options that cannot be edited:

  • User Manager is disabled by the plugin - user management is done in glFusion
  • The following Configuration Management fields cannot be edited
    • Use access control lists
    • Autogenerate passwords
    • Authentication backend
    • Password encryption method
    • Superuser

All other DokuWiki configuration settings can be customized to meet your specific needs. For full details on each configuration option, please see wiki:config.

DokuWiki Templates

The dokuwiki skin is the default skin included with DokuWiki but it has been customized by removing much of the header information that is provided by glFusion.

glFusion Groups and DokuWiki Permissions

After a successful installation, there are two default permissions:

  • glFusion Root members will be DokuWiki administrators
  • You can assign users to the DokuWiki Admin group to grant administrative access
  • ALL users will have read access

To grant additional permissions, you can map glFusion groups to DokuWiki permissions. To map these permissions, go into the Admins Only → DokuWiki → Access Control List Management. From here, you will see the group ALL has Read permissions. You can add a new group by entering its name in the text box and selecting the permissions.

DokuWiki does not support spaces in the Group names. So these items are stripped from the glFusion groups. For example, the glFusion group Logged-in Users will become Logged-in_Users.

glFusion Integration

The DokuWiki plugin allows you to integrate certain parts of DokuWiki in with your glFusion site.

What's New Block

You can enable / disable having DokuWiki display new / edited files in glFusion's What's New Block in the DokuWiki Configuration section (Command & Control → Configuration → DokuWiki). Set Enable What's New to true to allow new / updated wiki pages to display, set to False to disable What's New Integration.

You can also specify how the timeframe for the What's New entries. Set Number of days to include to the number of days you wish to use.

You can also trim (truncate) the page names displayed in the What's New block (to prevent wrapping) by setting the Maximum length of what's new entry option to the number of characters to use. Note: For newer, UIKIT based themes, you can set this number to a very high value (i.e.; 99) as the theme will automatically truncate the text to fit the available space.

Auto Tag

This plugin creates a new auto tag: [wiki:] To utilize this tag in your glFusion articles or forums, the syntax is:

[wiki:documentid optional link text]

The document id can be found in the URL (the document id for this article is dokuwikiplugin:start).

glFusion Auto Tags

The DokuWiki plugin supports all glFusion auto tags in the page content. This allows you to easily reference other content from your glFusion site in the wiki documents.

Using DokuWiki

For all usage questions and documentation on how to utilize DokuWiki, please refer to the DokuWiki Web Site.

DokuWiki Plugin ChangeLog

glfusion/plugins/dokuwikiplugin/start.txt · Last modified: 2017/05/02 15:18 by Mark

Page Tools