Woogle4MediaWiki/Admin manual

From TeamWeaverWiki

Jump to: navigation, search
(→Instrumentation addon)
 
Line 22: Line 22:
* Extract the content of the Woogle distribution ZIP-file to <code>[Your MediaWiki directory]/extensions/Woogle</code>
* Extract the content of the Woogle distribution ZIP-file to <code>[Your MediaWiki directory]/extensions/Woogle</code>
* Grant write permissions for the executing user on <code>[Your MediaWiki directory]/extensions/Woogle/logs</code> and on <code>[Your MediaWiki directory]/extensions/Woogle/addons/Native/index</code>, if you are using the Native addon
* Grant write permissions for the executing user on <code>[Your MediaWiki directory]/extensions/Woogle/logs</code> and on <code>[Your MediaWiki directory]/extensions/Woogle/addons/Native/index</code>, if you are using the Native addon
 +
** If you use the latest SVN HEAD Version (instead of 1.0-RC2), also grant write permissions to <code>[Your MediaWiki directory]/extensions/Woogle/resources/tpl/compiled</code>
* At the end of the file <code>[Your MediaWiki directory]/LocalSettings.php</code> add the following line: <code>require_once("$IP/extensions/Woogle/Woogle.php");</code>
* At the end of the file <code>[Your MediaWiki directory]/LocalSettings.php</code> add the following line: <code>require_once("$IP/extensions/Woogle/Woogle.php");</code>
* Proceed with configuration
* Proceed with configuration
Line 32: Line 33:
The default values plus description of all parameters can be found in <code>[Your MediaWiki directory]/extensions/Woogle/includes/WoogleConfig.php</code>. Do not modify any values there. Alternatively, you can see all configuration values on the special page <code>[MediaWiki URL]/index.php/Special:WoogleConfig</code> (e.g. [[Special:WoogleConfig]]).
The default values plus description of all parameters can be found in <code>[Your MediaWiki directory]/extensions/Woogle/includes/WoogleConfig.php</code>. Do not modify any values there. Alternatively, you can see all configuration values on the special page <code>[MediaWiki URL]/index.php/Special:WoogleConfig</code> (e.g. [[Special:WoogleConfig]]).
-
Open the file <code>[Your MediaWiki directory]/extensions/Woogle/WoogleConfig.php</code> and scroll down to the <code>WoogleConfig</code> class to configure Woogle. You can call <code>[MediaWiki URL]/Special:WoogleConfig</code> (which requires a WikiSysop user) in your browser to see configured values at runtime.
+
Open the file <code>[Your MediaWiki directory]/extensions/Woogle/includes/WoogleConfig.php</code> and scroll down to the <code>WoogleConfig</code> class to configure Woogle. You can call <code>[MediaWiki URL]/Special:WoogleConfig</code> (which requires a WikiSysop user) in your browser to see configured values at runtime.
Example snippet for LocalSettings.php with most important settings:
Example snippet for LocalSettings.php with most important settings:
Line 66: Line 67:
WoogleConfig::set('remoteAuthKey', 'secret');  // key for querying, only required if the backend is set to securityEnabled = true;
WoogleConfig::set('remoteAuthKey', 'secret');  // key for querying, only required if the backend is set to securityEnabled = true;
WoogleConfig::set('indexGroups', array('group1', 'group2'));
WoogleConfig::set('indexGroups', array('group1', 'group2'));
-
WoogleConfig::set('indexRepository', '123'); // numeric id for indexing (repoId) - as configured in the backend repo_config.xml
+
WoogleConfig::set('indexRepository', 123); // numeric id for indexing (repoId) - as configured in the backend repo_config.xml
WoogleConfig::set('remotePushIndexAuthKey', 'secret2'); // key for indexing - as configured in the backend repo_config.xml
WoogleConfig::set('remotePushIndexAuthKey', 'secret2'); // key for indexing - as configured in the backend repo_config.xml
</pre>
</pre>
Line 134: Line 135:
Instrumentation mode can be enabled by setting <code>$config['instrumentation']</code> in <code>extensions\Woogle\addons\Instrumentation\Instrumentation.php</code> to "true". Further settings can be changed there as well.
Instrumentation mode can be enabled by setting <code>$config['instrumentation']</code> in <code>extensions\Woogle\addons\Instrumentation\Instrumentation.php</code> to "true". Further settings can be changed there as well.
 +
 +
See [[Woogle4MediaWiki/Instrumentation addon]] for detailed information.

Current revision as of 11:03, 6 August 2011

This page was last modified on 6 August 2011, at 11:03.