Open-Letters Newslettersystem - Installation

Übersicht

Das Open-Letters Newslettersystem ist eine webbasierte Software, d.h. die Installation und Nutzung erfolgt auf einem Webserver / Webspace. Es ist möglich, die notwendigen Voraussetzungen auch auf einem lokalen PC oder Laptop zu schaffen, dieses Vorgehen ist jedoch rechtlich (bzgl. der Abmeldung vom Newsletter) wie technisch (Spam-Verdacht) bedenklich.

Die Installation des Open-Letters Newslettersystems gliedert sich, wie bei den meisten PHP-basierten Programmen, in diese Schritte:

  • Upload der Dateien und Verzeichnisse (per FTP) und Setzen der Verzeichnisrechte
  • Datenbank aufsetzen und Inhalte importieren
  • Konfigurationsdatei anpassen

Für diese Software haben wir weitere, optionale, jedoch dringend empfohlene Arbeitsschritte eingefügt:

  • Einspielen von Datenbankupdates
  • Testen des E-Mail-Versandes
  • Absicherung der Admin-Oberfläche
  • Weitere Hilfe, Problemlösung, Anleitungen

a) Download, FTP-Upload, Rechte setzen

Laden Sie das Newslettersystem von unserer Website https://www.open-letters.de herunter. Entpacken Sie die Zip-Datei und laden Sie alle Dateien und Verzeichnisse mit Hilfe eines FTP-Programms auf Ihren Webspace. Ein sehr gutes und kostenloses FTP-Programm ist das Programm FileZilla von https://filezilla-project.org/download.php?show_all=1.

Bearbeiten Sie mit Hilfe Ihres FTP-Programms die folgenden Dateien und Verzeichnisse so, dass der Webserver dort Dateien ablegen kann:

  • das Verzeichnis ./uploaded
  • das Verzeichnis ./log, die Datei ./log/openletters.log und das Unterverzeichnis ./log/htmlpurifier (ab Version 1.2)

In früheren Versionen (vor Open-Letters 1.2) waren zusätzlich die folgenden Schritte erforderlich:

  • die 3 Unterverzeichnisse HTML, CSS und URI des Ordners ./external_scripts/htmlpurifier-4.0.0-lite/library/HTMLPurifier/DefinitionCache/Serializer
  • die Datei log.txt im Verzeichnis config
  • das Verzeichnis ./admin/external_scripts/tinymce/plugins/ajaxfilemanager/session zum Upload von Bildern über den Ajax Filemanager

In FileZilla nehmen Sie diese Änderung vor, indem Sie die betreffende Datei/das betreffende Verzeichnis mit der rechten Maustaste anklicken und alle 3 Haken für "Schreiben" aktivieren.

b) Datenbank-Setup

Öffnen Sie die Oberfläche, die Ihnen Ihr Webspace-Anbieter zur Verwaltung Ihres Webspace und Ihrer Datenbanken zur Verfügung stellt. Legen Sie in dieser Oberfläche eine neue MySQL-Datenbank an und notieren Sie sich die Zugangsdaten zu dieser Datenbank (Internet-Adresse der Datenbank, Benutzername, Passwort, Name der Datenbank).

Öffnen Sie anschließend die Oberfläche, die Ihnen Ihr Webspace-Anbieter zur Verwaltung der Inhalte einer Datenbank zur Verfügung stellt (meist "phpMyAdmin"). Wechseln Sie in den Menüpunkt "Importieren" und laden Sie die Datei newsletter.sql hoch, die Sie im Verzeichnis config des Newslettersystems finden. Klicken Sie auf "Ok": Werden Ihnen keine Fehlermeldungen angezeigt, so ist die Einrichtung der DB abgeschlossen.

Das Open-Letters Newslettersystem kann eine gemeinsame Datenbank mit anderen Programmen nutzen. Ebenso ist es möglich, mehrere Installationen der Newsletter-Software in eine zentrale Datenbank zu legen. Sollte dies bei Ihnen der Fall sein, so lesen Sie bitte in den FAQ die Lösung zum Einsatz von "Prefixes" nach.

c) Einrichtung, zentrale Konfigurations-Datei

Bearbeiten Sie die Datei config.inc.php im Verzeichnis config mit einem Editor, z.B. dem Programm "Geany" von
http://www.geany.org Bitte benutzen Sie dazu kein Text-Verarbeitungsprogramm wie Microsoft Word oder das LibreOffice oder OpenOffice.org!

Wenn diese Datei config.inc.php (noch) nicht existiert, dann kopieren Sie bitte die Datei config.inc.php.example und nennen Sie die Kopie config.inc.php. Bearbeiten Sie in Zukunft nur noch die config.inc.php, das "Original" config.inc.php.example ist nur eine Vorlage und wird nicht für den Betrieb des Newslettersystems benötigt.

Gehen Sie die Konfiguraions-Datei vollständig durch und ändern Sie die jeweils gut dokumentierten Einstellungen nach Ihren Wünschen ab. Ersetzen Sie nach jeder Änderung die config-Datei, die Sie eventuell beriets auf den Webspace hochgeladen haben, durch die von Ihnen angepasste Datei.

d) Aktualisierung der Datenbank

Die im Abschnitt b) eingespielte SQL-Datei wird nicht für jede Version des Open-Letters Newslettersystems ganz neu erstellt. Es kann daher vorkommen, dass der aktuelle Stand Ihrer Datenbank nicht dem aktuellsten Stand des Newslettersystems entspricht. Dies können Sie sehr einfach prüfen und auf den neusten Stand aktualisieren lassen:

Öffnen Sie den Webbrowser und starten Sie damit die im Verzeichnis admin befindliche Datei update.php. Die von Ihnen ausgeführte Internetadresse könnte in etwa so aussehen: http://www.example.com/newsletter/admin/update.php.

Das Newslettersystem wird nun automatisch feststellen, welche Aktualisierungen an der Struktur der Datenbank fehlen und wird diese einspielen. Sie erhalten nach sehr kurzer Zeit einen Bericht über den Verlauf des Updates.

Hinweis 1: Es ist kein Problem, diese Updates "zu oft" auszuführen. Das Update-System kann damit umgehen, dass Sie den "F5"-Knopf im Browser verwenden (neuladen der Seite) oder die update.php mehrfach starten.

Hinweis 2: Wir bieten für das Open-Letters Newslettersystem in unregelmäßigen Abständen neue Versionen mit Fehlerbehebungen oder neuen Funktionen an. Es wird empfohlen, diesen Schritt nach jedem Aktualisieren des Systems vorzunehmen. Der gesamte Update-Prozess wird in einer gesonderten Doku beschrieben.

e) Testing E-Mail-Versand

Ein häufig auftretendes Problem ist die richtige Eingabe (und das Testen) der Zugangsdaten zum SMTP-Server (E-Mail-Versand-Server). Zur Prüfung der Richtigkeit der in config/config.inc.php angegebenen SMTP-Daten finden Sie im Verzeichnis extras das Hilfs-Programm phpMailerSmtpTest.php. Es bietet Ihnen eine Möglichkeit, die hinterlegten SMTP-Daten zu testen und eine Test-Mail versenden zu lassen.

Rufen Sie dieses Programm mit Ihrem Webbrowser auf: Haben Sie das Newslettersystem in Schritt a) auf Ihren Webspace mit der Internetadresse http://www.example.com/ in das Unterverzeichnis newsletter geladen, so erreichen Sie das Hilfsprogramm nun über diese Adresse: http://www.example.com/newsletter/extras/phpMailerSmtpTest.php Das Programm wird nach dem Aufruf im Browser beginnen, sich mit dem angegebenen SMTP-Server zu verbinden und dabei alle üblichen SMTP-Ports und Verschlüsselungen auszuprobieren. Wird dabei erfolgreich eine SMTP-Verbindung aufgebaut, so wird eine Test-E-Mail an die E-Mail-Adresse verschickt, die in der Datei config/config.inc.php als SENDER_ADDRESS hinterlegt ist. Über alle Tests und Erfolge/Fehler wird Ihnen in Ihrem Browser Bericht erstattet.

f) Absicherung der Admin-Oberfläche

Richten Sie danach den Htaccess-Schutz für das Admin-Verzeichnis ein. Dazu müssen Sie die beiden Dateien .htaccess und .htpasswd im Verzeichnis admin anpassen:
Zuerst sollten Sie den Pfad der Datei ./admin/.htpasswd ändern, der in der Datei ./admin/.htaccess angegeben ist. Danach können Sie diese Datei wieder schließen. Darüber hinaus müssen Sie eigene Benutzerdaten (Benutzername und verschlüsseltes Passwort) erzeugen und in die Datei ./admin/.htpasswd eintragen.

Zur Vereinfachung haben wir Ihnen ein PHP-Programm geschrieben, welches die dafür notwendigen Einträge für Sie erzeugt: Rufen Sie die Datei htaccess_help.php im Verzeichnis extras mit Ihrem Browser auf. Haben Sie das Newslettersystem in Schritt a) auf Ihren Webspace mit der Internetadresse http://www.example.com/ in das Unterverzeichnis newsletter geladen, so erreichen Sie das Hilfsprogramm nun über http://www.example.com/newsletter/extras/htaccess_help.php Dieses Programm generiert automatisch den Inhalt der Datei .htaccess, Sie müssen diese Daten nur noch kopieren, in die Datei einfügen und die Datei neu auf den Webserver hochladen. Zur Erzeugung der verschlüsselten Zugangsdaten bietet das Skript Ihnen ein Formular zur Eingabe von Benutzername und Passwort an => die erzeugten Daten fügen Sie bitte in die Datei .htpasswd ein und laden auch diese neu auf den Webspace.

Wichtig: Aus Gründen der Sicherheit Ihres Systems empfehlen wir, dass Sie auch das Verzeichnis config mit einem solchen Schutz versehen: Die in der Datei open-letters.log abgelegten Verlaufs-Informationen sollten gegen den Aufruf aus einem Webbrowser heraus geschützt werden.

Eine Anleitung zur Verzeichnis-Sicherung mit htaccess finden Sie im Buch SelfHtml unter https://wiki.selfhtml.org/wiki/Webserver/htaccess#verzeichnisschutz dort heißt die Datei ".htpasswd" dann ".htusers".

Weitere Hilfe, Problemlösung, Anleitungen

An dieser Stelle sei auf die FAQ verwiesen. Darin sind einige Themen diskutiert, die Ihnen ggf. bei der Einrichtung und beim ersten Testen der Software auffallen. Im benannten Dokument finden Sie zum Beispiel Hilfe zur Einrichtung mehrerer paralleler Installationen der Newsletter-Software (mit "Datenbank-Prefixes") oder evtl. im Browser angezeigte Fehlermeldungen zu Datums- und Uhrzeitfunktionen.