1. Wiki Software 1.0

Dieses Dokument beschreibt die Installation einer fiktiven Wiki Software 1.0.



Hinweise zur Installation

  • Die Installationsanleitung sollte vollständig gelesen und der Reihenfolge nach abgearbeitet werden.
  • Beim Editieren von Konfigurationsdateien mit einem Texteditor müssen die Dateien in UTF-8 Kodierung ohne BOM (Byte Order Mark) gespeichert werden.
  • Der Platzhalter steht stellvertretend für den Pfad, wo Sie die heruntergeladene Erweiterung entpackt haben.
  • Der Platzhalter steht stellvertretend für den Pfad zum Mediawiki-Webverzeichnis, z.B. http://localhost/mediawiki.
  • Der Platzhalter steht stellvertretend für den Pfad zur Mediawiki-Installation, z.B. C:\xampp\htdocs\mediawiki (Windows) oder /var/www/mediawiki (Linux).
  • Der Platzhalter steht stellvertretend für den Pfad zum Webserver-Rootverzeichnis, z.B. C:\xampp\htdocs (Windows) oder /var/www (Linux).

Ist das MediaWiki direkt in installiert, so sind und identisch.

Voraussetzungen

MediaWiki

Für die Installation wird ein bereits installiertes und fertig konfiguriertes MediaWiki der Version 1.15.x, 1.16.x oder 1.17.x vorausgesetzt. Dieses muss (bei gestartetem Web- und Datenbankserver) im Browser unter erreichbar sein.

Sprachen

Es werden die Sprachen de, de-formal und en unterstützt.

Browser

Zur Benutzung des Wikis wird Firefox ab Version 3.6+ oder Internet Explorer ab Version 7+ empfohlen. Andere Browser, sollten funktionieren, sind bislang aber nicht ausreichend getestet worden.

Server

  • Webserver (Apache 2, IIS 7+ sollte funktionieren ist aber nicht ausreichend getestet worden)
  • PHP Versionen 5.2.0, 5.2.6, 5.2.9, 5.3.0 und 5.3.2 wurden erfolgreich getestet.
  • PHP Version 5.3.1 hat einen Bug, weswegen MediaWiki nicht funktioniert. Dies betrifft z. B. auch Xampp 1.7.3.
  • MySQL ab Version 5.x
    Folgende Zugangsdaten zum Datenbankserver müssen bekannt sein:
    • Host/IP-Adresse und Port
    • Username und Passwort für den Root-User (Create/Drop-Statements) und den Wiki-User
      (wurde ggf. während der Installation von MediaWiki angelegt)
      Bei einer Installation mit Xampp ist als Benutzername "root" mit leerem Passwort voreingestellt.
    • Name der benutzten Datenbank
    • Das Tabellen-Präfix in der benutzten Datenbank

Installation

Komponenten von Wiki Software 1.0

Das enthält die folgenden Verzeichnisse und Dateien:

  • wiki-core
  • wiki-mw
  • wiki-skin
  • webservices
  • installcheck.php

Kopieren Sie die entpackten Elemente direkt in das Verzeichnis .

Desweiteren muss der Ordner /skins/common/ nach /wiki-skin/ kopiert werden, so dass im Ordner wiki-skin nun die Ordner "wiki", "common", "helpdesk" und "monobook" vorhanden sind.

Für folgende Verzeichnisse müssen Schreibrechte für den Webserver gesetzt werden:

(Unter Linux z.B. chmod -R a+w )

  • /images
  • /wiki-core/data
  • /wiki-core/config
  • /wiki-mw/config

Überprüfen der Voraussetzungen

Um weitere Voraussetzungen für die Installation überprüfen zu können, rufen Sie /installcheck.php über den Browser auf. Angezeigt werden die weiteren Voraussetzungen und Informationen zur Installation sowie auftretende Fehler (z.B. bei fehlender Berechtigung).

Wenn hier alles in Ordnung (grünes "OK") ist, kann zum Setup von Wiki Software 1.0 übergegangen werden.

Setup von Wiki Software 1.0

Öffnen Sie die Datei /LocalSettings.php in einem Texteditor und fügen Sie ganz unten folgende Zeilen hinzu:

$wgUseAjax = true;
$wgDefaultSkin = 'wiki';
$wgStylePath = $wgScriptPath.'/wiki-skin';
$wgStyleDirectory = $IP.'/wiki-skin';
require_once( dirname(__FILE__).'/wiki-core/index.php' );
BsCore::getInstance('MW')->setup();
// MediaWiki extensions
require_once( WsConfig::get('MW::AdapterPath').DS.'ext-dist/Lockdown/Lockdown.php' );
require_once( WsConfig::get('MW::AdapterPath').DS.'ext-dist/Quiz/Quiz.php' );
require_once( WsConfig::get('MW::AdapterPath').DS.'ext-dist/Poem/Poem.php' );
require_once( WsConfig::get('MW::AdapterPath').DS.'ext-dist/CategoryTree/CategoryTree.php' );
require_once( WsConfig::get('MW::AdapterPath').DS.'ext-dist/ImageMap/ImageMap.php' );
require_once( WsConfig::get('MW::AdapterPath').DS.'ext-dist/SyntaxHighlight_GeSHi/SyntaxHighlight_GeSHi.php' );
require_once( WsConfig::get('MW::AdapterPath').DS.'ext-dist/ParserFunctions/ParserFunctions.php' );
require_once( WsConfig::get('MW::AdapterPath').DS.'ext-dist/InputBox/InputBox.php' );
require_once( WsConfig::get('MW::AdapterPath').DS.'ext-dist/Nuke/Nuke.php' );
require_once( WsConfig::get('MW::AdapterPath').DS.'ext-dist/DynamicPageList/DynamicPageList.php' );
require_once( WsConfig::get('MW::AdapterPath').DS.'ext-dist/Cite/Cite.php' );
require_once( WsConfig::get('MW::AdapterPath').DS.'ext-dist/RSS/RSS.php' );

Konfiguration von Wiki Software 1.0

Rufen Sie mit dem Browser die Adresse /wiki-core/setup auf. Klicken Sie auf "Start configuration" und tragen Sie in der hierauf erscheinenden Eingabemaske (s. Screenshot) die benötigten Parameter ein.


Host: Tragen Sie hier den Hostnamen der MediaWiki-Installation ein. Die Vorgabe ist localhost.

User/Password: Es muss auf jeden Fall ein Datenbankbenutzer angegeben werden, der in der Datenbank Tabellen anlegen darf. Dies ist bei einer Standardinstallation von MediaWiki nicht unbedingt der Fall! Zu Testzwecken können Sie hier den MySQL-root-User verwenden.

Database: Tragen Sie hier den Datenbanknamen ein, den Sie bei der MediaWiki-Installation benutzt haben.

Prefix: Die Wiki-Tabellen erhalten automatisch das Präfix ws_. Sie können ein zusätzliches Präfix angeben oder dieses Feld leer lassen.

Port: Tragen Sie hier den Port des MySQL-Servers ein. Die Vorgabe ist 3306.

Socket: Den Eintrag "Socket:" lassen Sie bitte leer.

Core::BlueSpiceScriptPath: Hier wird der Pfad der wiki-core-Installation ab dem -Verzeichnis eingetragen. Orientieren Sie sich an den folgenden Beispielen:

Examples Path to wiki-core Core::wikiScriptPath
Linux /var/www/mediawiki/wiki-core /mediawiki/wiki-core
Windows C:\xampp\htdocs\mediawiki\wiki-core /mediawiki/wiki-core
Linux /var/www/wiki-core /wiki-core
Windows C:\xampp\htdocs\wiki-core /wiki-core

Core::UseMinify: Wählen Sie dieses Feld nicht aus.

War die Konfiguration erfolgreich, so wird nach dem Klick auf Submit configuration als Bestätigung Configuration successfully finished vom Browser zurück gemeldet.

Ausführen von update.php

Wiki Software 1.0 benötigt zusätzliche Datenbanktabellen, welche in diesem Schritt automatisiert in die Datenbank eingespielt werden. Verwenden Sie im Folgenden wieder die im vorherigen Schritt angegebene User-Passwort-Kombination.

  • Unter MediaWiki 1.15.x muss die Datei /AdminSettings.php vorhanden sein. Sollte diese Datei noch nicht angelegt sein, kopieren Sie die Datei /AdminSettings.sample nach /AdminSettings.php.
  • Unter MediaWiki 1.16.x und 1.17.x befinden sich die betreffenden Variablen in /LocalSettings.php!
  • Editieren Sie die jeweilige Datei dann mit einem Texteditor, um die benötigten Zugangsdaten einzutragen. Zwei Zeilen sind hierbei von Interesse:
$wgDBadminuser = 'wikiuser';
$wgDBadminpassword = 'your-password';
  • Führen Sie in einer Kommandozeile die Datei update.php aus.

Linux:

php /maintenance/update.php

Windows (die PHP.EXE befindet sich z.B. unter C:\xampp\php - wechseln Sie also zunächst in das PHP Verzeichnis):

php \maintenance\update.php

Die Tabellen werden nun für Sie angelegt, was am Ende der Ausgabe mit folgenden Zeilen bestätigt wird:

(...)
Creating whoisonline table...ok
(...) 
Creating bs_saferedit table...ok
(...)
Done.


Wiki Software 1.0 for MediaWiki kann jetzt bereits unter im Browser aufgerufen werden.

Webservices

Wenn Sie Wiki Software 1.0 Basic installieren wollten, sind Sie jetzt fertig. Für Wiki Software 1.0 Fully Featured müssen Sie die folgenden Schritte durchführen:

Die Wiki Software 1.0-Erweiterungen "Erweiterte Suche" und "PDF-Export" sind als Java-Webservices realisiert. Diese müssen auf einem Applikationsserver wie Tomcat, Glassfish, Jboss oder Jetty bereitgestellt werden. Für die folgende Beschreibung gehen wir von einer laufenden Tomcat-Installation bei $CATALINA_HOME aus.

Erweiterte Suche

Die Tomcat Anbindung muss mit URIEncoding="UTF-8" konfiguriert werden:

Verändern Sie zum Konfigurieren die Datei $CATALINA_HOME\conf\server.xml (Windows) oder $CATALINA_HOME/conf/server.xml (Linux):


Erstellen Sie ein Verzeichnis für den Suchindex und kopieren Sie das Verzeichnis conf von /webservices/ wie folgt:

Unter Windows:

mkdir C:\xampp\wiki_data\solr\conf
copy \webservices\conf C:\xampp\wiki_data\solr\conf

Unter Linux:

mkdir -p /opt/wiki_data/solr/
chown -R tomcat55 /opt/wiki_data/solr/ # vorausgesetzt tomcat55 ist ein Tomcat Benutzer
cp -r \webservices/conf /opt/wiki_data/solr/

Der Pfad zu der Solr Konfiguration (conf Verzeichnis enthält solrconfig.xml) muss in Tomcat über die Variable solr.solr.home gesetzt werden:

Unter Windows fügen Sie die folgenden Zeilen am Anfang der Datei $CATALINA_HOME\bin\catalina.bat ein:

set JAVA_OPTS=%JAVA_OPTS% -Dsolr.solr.home=C:\xampp\wiki_data\solr

Unter Linux (Debian) fügen Sie die folgenden Zeilen am Ende der Datei /etc/default/tomcat5.5 ein:

JAVA_OPTS="$JAVA_OPTS -Dsolr.solr.home=/opt/wiki_data/solr"

Starten Sie Tomcat neu.

Kopieren Sie solr1.4.war aus dem entpackten Archiv nach $CATALINA_HOME\webapps\ (Windows) $CATALINA_HOME/webapps/ (Linux):

Vergewissern Sie sich, dass die Datei /wiki-mw/config/extension-settings.php folgende Zeilen enthält:

BsExtensionManager::registerExtension('ExtendedSearch', 
    RUNLEVEL::FULL|RUNLEVEL::REMOTE, ACTION::ALL);

Führen Sie in einer Kommandozeile erneut die Datei update.php aus.

Linux:

php /maintenance/update.php

Windows:

php \maintenance\update.php

Konfigurieren Sie die Erweiterte Suche und den Webservice über Ihren Browser:

Wiki(linke Navigation) -> Admin -> Einstellungen -> Wiki -> Wiki- Basis-Einstellungen -> Erweiterte Suche:

  • Host bzw. IP-Adresse (SolrHost): default = 127.0.0.1
  • Pfad in Url des Application-Servers (SolrPath): default = /solr1.4
  • Port-Nummer (SolrPort): (vergleichen Sie den Anschluss-Port in Ihrer server.xml)

PDF-Export

Kopieren Sie bn2pdf-light.war nach $CATALINA_HOME\webapps\ (Windows) $CATALINA_HOME/webapps/ (Linux).

Vergewissern Sie sich, dass /wiki-mw/config/extension-settings.php die folgenden Zeilen enthält:

WsExtensionManager::registerExtension('UniversalExport',
    RUNLEVEL::FULL, ACTION::ALL);
WsExtensionManager::registerExtension('UEModulePDF',
    RUNLEVEL::FULL, ACTION::ALL);

Aktivieren Sie den Universal Export in Ihrem Browser und konfigurieren Sie den neuen Webservice:

Wiki (linke Navigation) -> Admin -> Einstellungen -> Abschnitt Universal Export

Abschluss

Wenn alle Installations- und Konfigurationsschritte chronologisch durchgeführt wurden, ist Ihr neues Wiki Software 1.0 for MediaWiki nun einsatzbereit.Viel Spaß!

Anhänge

Diskussionen