Installation / Download

Das Tool benötigt nur geringe technische Voraussetzungen. In der Regel genügt ein herkömmliches Webhosting-Paket, das man bereits für wenige Euro pro Monat bei einem Web-Provider mieten kann.

 

Ihr braucht… Konkret:
einen WWW-Speicherplatz, auf dem das Tool und Daten wie Grafiken usw. abgelegt werden Mindestens 400 Megabytes Speicherkapazität
Unterstützung für die Programmiersprache PHP und htaccess-Dateien PHP 7.0 oder neuer, Apache Webserver
eine Datenbank, in der die eingetragenen Artikel und Beiträge abgelegt werden MySQL-Datenbank ab 5.6 oder neuer
eine E-Mail-Adresse, über die das Tool Systemnachrichten wie Zugangsdaten oder Bestätigungen an die verschiedenen Nutzergruppen verschicken kann. E-Mail-Account, auf den per SMTP oder über PHP-Sockets zugegriffen werden kann
Zusätzlich… Konkret:
sollten die Zugriffe über eine verschlüsselte Verbindung (https) möglich sein. SSL-Zertifikat über den Provider

 

Folgende Informationen solltet ihr euch zur Installation schon parat legen

  • SFTP-Zugangsdaten (Servername, Nutzername und Passwort) für euren Webserver bzw. das Unterverzeichnis, in das das Tool installiert werden soll
  • Datenbank: Zugangsdaten, um in der Datenbank lesen und schreiben zu können (Servername, Datenbankname, Nutzername, Passwort)
  • E-Mail: Die E-Mail-Adresse, über die das System Nachrichten verschicken soll; falls als Versandart SMTP zum Einsatz kommt, benötigt ihr hierfür Servername, Nutzername und Passwort.

 

Die Installation in einzelnen Schritten

  1. Neuinstallation: Ladet das Tool als ZIP-Paket von unserem Server herunter, entpackt es auf eurem Rechner und spielt es per SFTP auf Euren Server. Aufgrund der Größe des Pakets und abhängig von eurer Internetleitung kann das 20-60 Minuten dauern.
  2. Anpassen der .htaccess: In dieser Datei könnt ihr unter anderem Einstellungen zur automatischen Weiterleitung auf eine verschlüsselte Verbindung vornehmen. Auch könnte es sein, dass euer Provider über diese Datei die Auswahl der PHP-Version hierüber ermöglicht. Wir empfehlen euch die Nutzung von PHP 7.0 oder neuer.
  3. Dann ruft ihr die Adresse des Speicherorts auf, gefolgt von einem /install (also z.B. www.unserewebsite.de/install. Der Installer führt euch durch den Einrichtungsprozess: Ihr müsst die Daten für den System-Mail-Zugang, und die Datenbank eintragen. Bitte beachten, dass der Installer zum Erstellen von Konfigurationsdateien Schreibrechte für das ePartool-Verzeichnis benötigt. Weitere Informationen finden sich hierzu in der README-Datei.
  4. Weitere Einstellungen findet Ihr dann im Adminbereich des Tools: Hier könnt ihr von Kopf- bis Fußbereich alle sichtbaren Inhalte, Suchbegriffe für Suchmaschinen und weitere Admins/Redakteur_innen eintragen.

 

Update einer bestehenden Installation (ab 4.5.0)

Ab ePartool 4.5.0 ist ein deutlich einfacherer Upgradepfad zwischen den Versionen möglich. Neben dem Installer-Paket existiert nun auch ein Upgrade-Paket. (Die aktuelle Version 4.8.2 kann hier heruntergeladen werden.) Dieses muss lediglich heruntergeladen, entpackt und über die bestehende Installation geschrieben werden. Allerdings ist es empfehlenswert, vorher die Dateien und Datenbank als Backup zu sichern.

Zum Upgrade von 4.7.0 auf 4.8.0 ist ein manuelles Datenbankupdate notwendig. Die entsprechenden MySQL-Befehle lauten:

ALTER TABLE `email_recipient`
DROP FOREIGN KEY `email_recipient_email_id_ibfk`,
ADD FOREIGN KEY (`email_id`) REFERENCES `email` (`id`) ON DELETE CASCADE ON UPDATE RESTRICT;

ALTER TABLE `email_attachment`
DROP FOREIGN KEY `email_attachment_email_id_ibfk`,
ADD FOREIGN KEY (`email_id`) REFERENCES `email` (`id`) ON DELETE CASCADE ON UPDATE RESTRICT;

ALTER TABLE `proj` ADD `teaser_enabled` int(1) NOT NULL DEFAULT '1';

Zum Upgrade von 4.5.x und 4.6.0 auf 4.7.0 war überdies ein manuelle Datenbankupdate notwendig. Die entsprechenden MySQL-Befehle lauten:

ALTER TABLE `cnslt` ADD `anonymous_contribution` tinyint(1) NULL;
UPDATE `cnslt` SET `anonymous_contribution` = 0;
ALTER TABLE `cnslt` CHANGE `anonymous_contribution` `anonymous_contribution` tinyint(1) NOT NULL;
ALTER TABLE `cnslt` ADD `anonymous_contribution_finish_info` text NULL;

Hier die empfohlene Schritt-für-Schritt-Vorgehensweise:

  1. Erstellt ein Backup von application/configs/*.local.ini
  2. Erstellet ein Backup von www/media
  3. (Bei Upgrade auf 4.7.0: MySQL-Befehle von oben ausführen)
  4. Die Dateien des Updatepakets über die bestehende Installation schreiben.
  5. Sicherheitshalber die gesicherten Config- und Mediadateien überprüfen und sie ggf. zurückkopieren (das sollte aber eigentlich nicht notwendig sein).

Zwischen Version 4.5.x und 4.6.0 hat sich die Datenbankstruktur des ePartool nicht verändert, daher ist keine weitere Ausführung eines Update-Skriptes o.ä. notwendig.


 

Grundkonfiguration

Wenn ihr das Tool zum ersten Mal in Betrieb nehmt, solltet ihr Euch die Zeit nehmen, bestimmte Dinge einzurichten.

Dazu gehören:

  • Logo im Kopfbereich (Header): Hier könnt ihr das Logo eurer Organisation oder Gruppe statt des ePartool-Logos einfügen. Tipp: Nutzt als Grafik ein PNG, SVG oder GIF mit Transparenzen, um keine hässliche Box um das Logo herum zu haben.
  • Fußbereich (Footer): Auch hier habt ihr bis zu vier Spalten Platz für Träger- und Projektlogos oder Kontaktadressen
  • Beschreibung von „Mitwirkung“: Auf der Titelseite gibt es die Möglichkeit, den Einsatz eures Tools mit einer kurzen Erklärung zu versehen.
  • Grundsätzliche Seiten: Impressum, Datenschutz, Kontakt, Hilfetexte. Bitte in diesem Zusammenhang auch die Information zur GPL-Lizenz beachten.
  • Das sogenannte „Favicon“, das als Lesezeichen im Browser erscheint, könnt ihr ersetzen. Dazu muss die Grafik im Installationsordner ausgetauscht werden.
  • Für Fortgeschrittene: Im Backend gibt es die Möglichkeit die sogenannten Meta-Beschreibungen der ganzen Site zu beschreiben. Auch könnt ihr hier ein Standard-Bild hinterlegen, das beim Teilen in sozialen Netzen verwendet werden soll (og:image).
  • Für Profis: Cronjobs ermöglichen dem Tool regelmäßig Aktionen auszuführen.
  • Für Profis: Das Design und die Grundfarben können in den CSS-Beschreibungen angepasst werden.

 

Parallelbetrieb mehrerer Projekte mit einer Datenbank

Das Tool erlaubt es, mehrere Installationen mit nur einer Datenbank zu managen. Dieser Parallelbetrieb bedeutet, dass ihr das Tool in verschiedenen Versionen und je nach Bedarf unterschiedlichen oder gemeinsamen Beteiligungsrunden nutzen könnt, während die Nutzerverwaltung zentral abgewickelt wird.

Hierfür benötigt ihr zweistellige Kürzel, die die Datenbank als Unterscheider im System verwendet. Derzeit können Beteiligungsrunden gemeinsam oder getrennt sichtbar geschaltet werden; die Infoartikel zu den Beteiligungsrunden sind ebenfalls gemeinsam oder nach Bedarf separat einstellbar. Nicht unterscheidbar sind die Nutzerbeiträge und Reaktionen & Wirkungen zu einer gemeinsamen Beteiligungsrunde.

Wichtig: Alle hochgeladenen Dokumente, die von mehreren Installationen verwendet werden sollen, müssen in allen betroffenen Installationen hochgeladen werden, da sie nicht in der Datenbank, sondern in einem Serverordner liegen. Das betrifft Grafiken, PDFs, aber nicht die Userbeiträge oder Artikeltexte.

Voraussetzung: „Projekte“
Eine Installation des ePartool innerhalb einer Datenbank wird als „Projekt“ bezeichnet. Das Anlegen eines Projekts ist während des Installationsvorgangs komfortabel über den Installationswizard möglich.

Projekt nachträglich anlegen/ändern
Um eine Installation nachträglich als neues Projekt in der Datenbank zu registrieren, sind folgende Schritte notwendig:

  1. Projekte werden mit zweistelligem alphanumerischem Code verwaltet. Die Grundinstallation läuft in der Regel als Projekt „xx“. Für ein neues Projekt muss also ein neuer zweistelliger Code festgelegt werden. Dieser Code wird später für Nutzer_innen an keiner Stelle sichtbar. Im Backend erscheint lediglich der zum Projektcode zusätzlich frei vergebene Projektname.
  2. Das SQL-Skript data/create-project-<project_language>.sql öffnen und in der ersten Zeile den Projektcode festlegen. In Zeile 8 kann dann der Projektname vergeben werden, der aus beliebigen Buchstaben und Ziffern bestehen kann (inkl. Leerzeichen und Klammern). Auf Sonderzeichen, insbesondere Backslash (\), einfache (‚) und doppelte („) Anführungszeichen sollte dabei aber verzichtet werden.
  3. Das veränderte SQL-Skript auf die Datenbank anwenden.
  4. Der Projektcode muss in application/configs/config.local.ini in der Direktive „project“ ebenfalls noch angepasst werden (Standardwert des Installers lautet project = „xx“).

Entfernen von Projekten
Derzeit ist kein Weg vorgesehen, um ein einzelnes Projekt wieder aus der Datenbank zu entfernen.

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.