1 FUSIONFORGE MEDIAWIKI PLUGIN README
2 -----------------------------------
5 The plugin adds support for Mediawiki to FusionForge. When the plugin
6 is activated for a project, a Mediawiki instance for the project is
7 created, that can be edited by project members.
9 This file describes how to INSTALL and CUSTOMIZE the plugin, and what
10 to do when the Mediawiki instalation is UPGRADEd.
15 If you have installed FusionForge and the plugin via a packaging
16 system (RPM or DEB), the plugin should be ready to run and only needs
17 to be enabled in the plugin manager.
18 If you have manually installed FusionForge, you need to do the
19 following to get it working:
21 1. Download the Mediawiki sources from
22 http://www.mediawiki.org/wiki/MediaWiki
23 or install Mediawiki via a package manager.
25 2. Unpack the sources into a directory that is accessible to
28 3. Put the path to Mediawiki's source directory into the configuration
29 variable "[mediawiki]source_path" by adding the following lines into
30 your FusionForge configuration file (@CONFIG_PATH@/config.ini):
33 src_path = < Mediawiki source path >
37 > php bin/mw-plugin-init.php
39 This will create a number of symbolic links in the FusionForge var
40 directory (/var/lib/fusionforge) required by the plugin. The command
41 has to be run by a user that can write to the FusionForge var
44 5. Adapt and add the contents of the file etc/httpd.d/61plugin-mediawiki to
45 your apache configuration. To do that, the script "setup" might be
46 helpful. Furthermore, adapt and add the following lines to the
49 RedirectMatch 301 ^({sys_urlprefix}plugins/mediawiki/wiki/[-a-zA-Z0-9_]*)/*$ $1/index.php
50 AliasMatch ^{sys_urlprefix}plugins/mediawiki/wiki/[-a-zA-Z0-9_]*/api.php {usr_share_gforge}/www/plugins/mediawiki/api.php
51 AliasMatch ^{sys_urlprefix}plugins/mediawiki/wiki/[-a-zA-Z0-9_]*/index.php {usr_share_gforge}/www/plugins/mediawiki/index.php
52 AliasMatch ^{sys_urlprefix}plugins/mediawiki/wiki/([-a-zA-Z0-9_]*)/images/(.*) {var_lib_gforge}/plugins/mediawiki/projects/$1/images/$2
53 AliasMatch ^{sys_urlprefix}plugins/mediawiki/wiki/([-a-zA-Z0-9_]*)/skins/(.*) /usr/share/gforge/www/plugins/mediawiki/skins/$2
55 6. Add the cronjob in etc/cron.d/mediawiki to the FusionForge
56 crontab. To do that, the script "setup" might be helpful.
58 Customizing the plugin
59 ----------------------
61 The Mediawiki plugin knows all configuration variables described in
62 etc/config.ini. To customize Mediawiki (e.g. enable uploads), change
63 the value of any of the variables in the file
64 @CONFIG_PATH@/config.ini.
66 Furthermore, you can customize all Mediawiki instances within
67 FusionForge by creating and/or modifying the file
68 @CONFIG_PATH@/plugins/mediawiki/LocalSettings.php
69 In this file, you can add extensions or change anything that can be
70 done in Mediawiki's LocalSettings.php.
72 To customize the settings of a specific project, you can additionally
74 @DATA_PATH@/plugin/mediawiki/projects/<project>/ProjectSettings.php
75 with additional customizations.
78 Upgrading the Mediawiki installation
79 ------------------------------------
82 When FusionForge was installed from a package manager, this should be
83 happening automatically. Otherwise, when the Mediawiki installation is
84 upgraded, it is necessary to upgrade all project instances. To do
87 bin/mw-wrapper <project> update.php