Firefox PHP

<b>(small) german phorum-documentation</b>

<b>(small) german phorum-documentation</b>
December 28, 2001 12:31PM
<HTML>Here is a (really) small phorum-documentation I've written for a book which will be released in the near future.
Probably it is being revised and changed before going into the book so I will be able to post a better version when the book is coming out.

Please feel free to make corrections, changes or adds:
###
* Einleitung
- Beschreibung von Phorum, Funktionalitäten usw.
* Installationsanleitung
- für den Admin, wie man ein lauffähiges Phorum hinbekommt
* Konfigurationsanleitung für den Admin
* (kleine) Useranleitung

1. Einleitung:

Phorum ist ein PHP- und Datenbank-basiertes Forensystem,
welches vom Konzept her auf Schnelligkeit und gute
Anpassbarkeit baut.
Derzeit werden an Datenbanken MySQL und PostgreSQL unterstützt.
Der größte Vorteil der Nutzung von Datenbanken ist eben,
daß es nahezu unbegrenzt skalierbar ist und auch noch bei
großen Datenmengen in einem Forum ohne Geschwindigkeits-
einbußen nutzbar ist.
Es sind Foren mit mehr als 60.000 Beiträgen bekannt die ohne
jegliche Probleme laufen und nutzbar sind.

Andererseits können auch viele verschiedene Foren auf einem
Forensystem laufen, wie auch das Beispiel MyPhorum.de zeigt.
Dort laufen zur Zeit mehr als 2000 Foren mit mehr als 600
MB-Daten, ca. 2500 Postings/Tag usw. ohne Probleme auf einem
Phorum.

Dies zeigt schon die sehr gute Skalierbarkeit von Phorum.

Weitere besondere Features von Phorum sind dann z.B. :

- sowohl Baumansicht, als auch flache Ansicht des Forums
ist nutzbar (vordefiniert und auch vom User wählbar).
- Userlogins mit Signaturen usw.
- Foren können auf "Öffentlich" (ohne Logins) "Öffentlich mit optionalem Login",
"Login zum Posten nötig", "Login zum Lesen von Nachrichten nötig"
(und dann natürlich auch zum Posten) gestellt werden
- Moderatoren (werden beim Posten hervorgehoben und können direkt im
Forum Nachrichten löschen oder editieren)
- EMailbenachrichtigung über Antworten auf eigene Postings
- Themen mit neuen Postings "rutschen" nach oben, werden also
nicht in Vergessenheit geraten
- Suchfunktion über ein oder alle Foren
- Schutz vor Spammern durch Prüfroutine für Doppelposts,
definierbarer Schimpfwortfilter, IP-Sperren, EMail-Sperren (alles forumsspezifisch)
- XHTML-Kompatibilität
- das komplette Aussehen ist forumsspezifisch änderbar,
durch header/footer-Dateien, CSS-Dateien und Farbanpassungen über den Admin
- komfortabler Adminbereich wo die Forumseinstellungen vorgenommen werden können
- Browserbasierte Installation (dazu später mehr)


2. Installation

Voraussetzungen:
Ich nehme hier als Voraussetzungen an, daß auf dem Server PHP>=4 und MySQL 3.23.x installiert sind.

Derzeit funktioniert Phorum auch mit PHP3 jedoch werden spätere Versionen aufgrund
einiger Einschränkungen nicht mehr PHP3 unterstützen.

Auf einem angemieteten Webspace erhält man in der Regel seine
MySQL-Zugangsdaten vom Betreiber des Servers.
Dabei benötigt man den MySQL-Hostnamen (meist localhost wenn
MySQL auf demselben Server läuft), den Namen der MySQL-Datenbank
die schon eingerichtet sein muß, den MySQL-Usernamen und das
MySQL-Passwort.

Zuerst entpackt man die Phorum-Distribution auf seinem lokalen Rechner.
Danach hat man dann ein Verzeichnis (z.B. phorum3) unter dem Phorum wieder
alle seine Dateien abgelegt hat.
Dieses Verzeichnis kann umbenannt werden und sollte dann, so wie es ist,
per FTP auf den Webserver gebracht werden.

Wichtig! Sobald das Phorum-Verzeichnis auf dem Webserver ist, sollte man
den settings-Ordner (im Beispiel phorum3/admin/settings/) und alles darin
mittels des Unix und FTP-Befehls chmod beschreibbar machen
(z.B. chmod a+rwx <name> oder chmod 777 <name>).
Ja, diese Berechtigungen sind reicht weit gefaßt und jeder kann gern mit
geringeren Berechtigungen experimentieren aber mit dieser Berechtigung
sollte es auf ALLEN Systemen laufen.

Danach ruft man direkt im Browser den Admin von Phorum auf und dort sollte
das Install-Skript erscheinen. (im Beispiel ist der Admin unter
[deineDomain.de] zu finden)

Das Install-Skript stellt einige Fragen (in englisch ist es dort jeweils):

Datenbanktyp
============
MySQL oder PostgreSQL - was halt installiert ist

Datenbankdaten
==============
Datenbankhost: der Rechnername auf dem die MySQL-(oder PgSQL)-DB
installiert ist (meist localhost)
Datenbankname: der Name der DB, den man vom Hoster bekomme hat
DB-Username: der Username für den Zugriff auf die DB
DB-Passwort: das Passwort für den Zugriff auf die DB
Name der Phorum-Haupttabelle: diesen kann man in der Regel so lassen
wie er vorgegeben ist (forums) außer man hat vor mehrere Phorum(s)
auf einer Datenbank laufen zu lassen.

Admin-User
==========
Diese Daten sind für den Admin-User notwendig.
Dieser hat Zugriff auf alle Foren innerhalb des
Forensystems.
Abgefragt werden hier Username und Passwort des
Admins.

Weitere Daten
=============
Hier wird einmal die URL des Forums abgefragt (notwendig z.B.
für die EMailbenachrichtigungen) und die EMail-Adresse
des Admins, damit dessen Profil ergänzt werden kann.

... und wenn es bis hier keine Probleme gab dann sollte das Forum
damit betriebsbereit sein.

3. Konfiguration/Erläuterung des Adminbereiches

Der Administrationsbereich ist in 3 Teile unterteilt:
Phorum-Setup (3.1)
Forum-Maintenance (3.2)
System-Maintenance (3.3)

Diese werden im folgenden erläutert.

3.1 Phorum-Setup
Dieser Bereich enthält alle Optionen für das Phorum-System als
ganzes. Voreinstellungen für neue Foren, allgemeine Einstellungen usw.

3.1.1 Attachment-Settings
Allow Attachments - sind überhaupt Attachments im Phorum-System möglich?
Directory - hier muß der Serverpfad, also der komplette Filesystempfad
zu dem Verzeichnis, wo Attachments abgelegt werden sollen, angegeben
werden
Size Limit - hier muß eine Maximalgröße für Attachments eingegeben werden,
diese kann aber nicht größer sein, als die Maximalgröße für Uploads in PHP
(siehe php.ini)
File Types - hier müssen die erlaubten Dateitypen angegeben werden, welche
als Uploads möglich sein sollen (als semikolonseparierter Text)
Maximum # Attachments - User können mehrere Attachments zu einem Posting
hinzufügen, hier kann die Maximalanzahl dafür festgelegt werden

3.1.2 Database Settings
Hier kommen die Verbindungsinformationen für die Datenbank hin.
Diese Daten bekommt man in der Regel von seinem Provider/Hoster.

Server Name - der Hostname des Datenbankservers, bei lokalen Servern
in der Regel localhost
Database Name - Name der Datenbank, wo Phorum seine Tabellen
ablegen soll, diese Datenbank muß schon existieren
User Name: Benutzername für den Verbindungsaufbau zur Datenbank,
sollte auch schon existieren
Password: Passwort für den oben genannten Benutzernamen

3.1.3 File/Path Settings
Hier muß ich gleich sagen ... hier muß in der Regel nichts
geändert werden.
Die wichtigsten Daten sind:
Forum URL - die URL unter der das Forum zu erreichen ist ...
diese ist z.B. für die Mailbenachrichtigungen wichtig.
File Extension - Endungen der Dateien, Achtung die Dateien
müssen aber von Hand umbenannt werden, diese Einstellung hier
ist nur, damit Phorum die Dateien dann auch findet.

Die restlichen Einstellungen hier betreffen nur die Namen der einzelen
Forumsseiten.

3.1.4 HTML Settings
Hier sind alle Voreinstellungen für die Farben des Forums zu finden.
Diese wirken sich nicht auf die laufenden Foren aus, wenn dort eigene
Farbdefinitionen gemacht werden.
Siehe für die Beschreibung und weiteres 3.2.x (Forum Properties)

3.1.5 Global Settings
Globale Einstellungen des Forums, einige wieder nur als Default
Default Messages per Page - Anzahl der Nachrichten pro Forumsseite
Default EMail - voreingestelle Moderator-EMailadresse
PhorumMail Code - ein String der für die Nutzung mit PhorumMail,
zur Mailinglistenintegration genutzt wird. PhorumMail
ist nicht Teil dieser Dokumentation
Cookies - ob Cookies im Phorum genutzt werden sollen
Sorting - ob Foren in der Übersicht sortiert werden sollen oder nicht,
wenn ja, dann werden diese dort alphabetisch sortiert
Default Language - Sprachdatei, die für neue Foren genutzt werden soll
TimeZone Offset - wenn der Server in einer anderen Zeitzone läuft als
die Mehrzahl der Besucher, dann kann man hier ein "Offset", also eine
Abweichung von der dort laufenden Zeit, eingeben (in Stunden)

3.1.6 Plugins

Hier können Plugins aktiviert, deaktiviert und konfiguriert werden.
Im Moment sind nur ein paar wenige Plugins unter [hackers.phorum.org]
veröffentlicht. Phorum3-claws wird ein paar mehr Plugins enthalten.
Vielleicht findet sich noch jemand, der ein paar mehr schreibt ;-).

3.2 Forum Maintenance

Manage Forums/Folders - dort hat man eine Auswahl der eingerichteten Foren
kann einige Einstellungen oder Aktionen für diese vornehmen (3.2.1)
New Folder - zum Einrichten eines neuen Ordners, dieser kann mehrere Foren
beinhalten, so daß man auch eine gewisse Struktur anlegen kann (3.2.2)
New Forum - zum Einrichten eines neuen Forums (3.2.3)
UserAdmin - zum Bearbeiten aller angemeldeten User im System

3.2.1 Manage Forums/Folders
Hier kann man direkt zu einem Forum navigieren und hat bei
diesem dann die folgenden Optionen zur Auswahl:

Easy Admin - in einer Struktur ähnlich dem Forum kann man dann Nachrichten
löschen (delete), bearbeiten (edit) oder verstecken (hide)
Unapproved Messages - alle unbestätigten Nachrichten werden hier angezeigt
und werden dann nach Bestätigung im Forum angezeigt
(bei moderierten Foren)
Quick Edit - eine Nachricht direkt nach ihrer ID bearbeiten
Quick Delete - eine Nachricht direkt nach ihrer ID löschen
Quick Approve - eine Nachricht direkt nach ihrer ID bestätigen
Delete By Date - Nachrichten nach Datum löschen
es gibt sowohl die Möglichkeit ältere, neuere oder genau von
einem Datum die Nachrichten zu löschen.
Das Datum muß im Forum YYYY-MM-DD eingegeben werden
Reset Sequence - in Versionen > 3.2 ohne Funktion
Hide - Forum verstecken, das Forum wird nicht mehr in Übersichen angezeigt,
ist aber weiter voll aufrufbar
Edit Properties - siehe 3.2.3
Drop Forum - Forum wird gelöscht (nach JS-Abfrage), die Daten in dem Forum
sind dann unwiederbringlich gelöscht!

3.2.2 / 3.2.3 New Forum / New Folder
hier nun alle Optionen zum Anlegen eines neuen Forums einmal erläutert

Name - der Name des neuen Forums
Description - eine Beschreibung des neuen Forums, erscheint in der Übersicht
Config Suffix - ein Suffix für forumsspezifische Dateien, damit können dann
einige Dateien (header.php, footer.php, censor.php, bad_words.php ...)
forumsspezifisch genutzt werden, z.B. header_<config_suffix>.php
Folder - in welchem Foren-Ordner das Forum angelegt werden soll
Table Name - der Name der Forumstabelle (in der Datenbank), dieser darf keine
Sonder- oder Leerzeichen enthalten, sondern nur alphanumerische Zeichen
Man kann auch eine schon existierende Tabelle angeben (und anklicken, daß sie existiert),
dann versucht Phorum nicht, die Tabelle anzulegen, checkt aber ob die angegebene
Tabelle existiert
Security - hier kann angegeben werden, wie die Berechtigungen im Forum notwendig sind,
es gibt Public (kein Login nötig und auch nicht möglich), Login is Optional (Login möglich aber nicht nötig), Login To Post (Login möglich und zum Posten auch nötig), Login Required (Login zusätzlich auch zum Lesen nötig)
Email Moderator: sollen neue Posts an den Moderator geschickt werden? No (keine Nachricht), All Messages before posted (alle Nachrichten werden zu dem Moderator/den Moderatoren geschickt und müssen erst durch diese bestätigt werden bevor sie im Forum erscheinen), All Messages after posted (alle Nachrichten werden an den Moderator geschickt, werden aber schon bestätigt und sind im Forum lesbar)

Htmleinstellungen, hier gilt, wenn sie freigelassen wird, dann wird der Defaultwert genutzt und wenn die Defaulteinstellungen geändert werden, dann gelten diese Änderungen auch
für dieses Forum

Body Color - Hintergrundfarbe der gesamten Seite
Link Color - Farbe für nicht besuchte oder aktive Links
Visited Link Color - Farbe für besuchte Links
Active Link Color - Farbe für gerade aktiven Link
Table Width - Breite der HTML-Tabelle des Forums
Table Header Color - Hintergrundfarbe für die Spaltenüberschriften des Forums (Betreff, Autor usw.)
Table Header Font Color - Textfarbe für die Spaltenüberschriften des Forums
Main- und Alt-Color werden abwechselnd in der Übersicht genutzt, so kann man
abwechselnde Farben erstellen
Main Table Body Color - Hintergrundfarbe für Übersichtszeilen
Main Table Body Font Color - Textfarbe für Übersichtszeilen
Alt. Table Body Color - s.o.
Alt. Table Body Font color - s.o.
Navigation Background Color - Hintergrundfarbe der Navigationszeilen
Navigation Font Color - Textfarbe in den Navigationszeilen

(die folgenden Einstellungen gelten nur für Foren, nicht für Folder/Verzeichnisse)

Funktionen

Duplicate Posts - soll auf doppelte Posts gecheckt werden (passiert in der Regel, wenn
jemand nicht das Absenden des Postings abwartet, sondern mehrmals auf den "Post" Button
klickt), funktioniert mit Timeout 2 Minuten, danach kann ein ebensolches Posting
wieder gepostet werden
Messages Per Page - Anzahl der Postings auf einer Seite
Thread Type - Ansichtstyp
Float to Top - Themen mit neuen Antworten rutschen nach oben
Multiple Levels - übliche Baumansicht
Single Level - alle Antworten zu einem Thema erscheinen in einer Ebene
Thread Display - Darstellung der Antworten in der Übersicht
Collapsed - Themenansicht, nur die obersten Themen sind in der Übersicht sichtbar
Expanded - Baumansicht, Themen und Antworten sind in der Übersicht sichtbar
Read Messages - Darstellungen der einzelnen Antworten
Entire Thread At Once - alle Antworten werden auf einer Seite dargestellt
One at a Time - jede Antwort wird einzeln angezeigt
Show Users IP/Host - soll die (anonymisierte) IP des Posters im Forum sichtbar sein?
Allow EMail-Notification for anonymous Posters - soll die Checkbox für Mailbenachrichtungen auch für nicht eingeloggte Poster nutzbar sein?
HTML - welche HTML-Funktionen sollen im Forum aktiv sein (Kombinationen möglich)
Allow All - komplettes HTML
Bold, Italic, Underline - <b><i><u>-Tags sind nutzbar
Fonts - alle <font ...>-Tags sind nutzbar
Lists - <ul><ol><li>-Elemente sind nutzbar
Images - <img ..>-Tags sind nutzbar
Anchors - <a href...> also normale Links sind nutzbar

Attachments

Allow attachments - sollen Attachments in diesem Forum nutzbar sein?
Attachment Size Limit - maximal mögliche Größe für Attachments
Allowed File Types - die erlaubten Dateitypen für Attachments
Maximum # of Attachments - maximal erlaubte Anzahl von Attachments für ein Posting

Mailinglistenintegration
Email All Posts To - alle Postings im Forum an diese Adresse schicken
Return Email Address - Absenderadresse für Postings an die oben genannte Adresse
Email Subject Tag - der für Mailinglisten übliche Eintrag im Subject der EMail,
z.B. [name]

3.2.4 UserAdmin
Hier kannst Du User anlegen, löschen oder bearbeiten.
Add User - User anlegen
delete - User löschen (JS-Abfrage kommt vorher)
edit - User bearbeiten

3.3 System Maintenance

3.3.1 Check For New Version
eine kleine Seite mit den Infos der aktuell bei
phorum.org verfügbaren Phorum-Version wird angezeigt

3.3.2 Rebuild INF File
die Konfigurationsdateien für die Foren werden neu
geschrieben, notwendig z.B. nach einem Update

3.3.3 Stop Phorum
das Forensystem wird "angehalten", Zugriffe auf das Forum
werden nur mit einer Meldung, daß das Forum im Moment
gewartet wird, quittiert
###</HTML>

Dear Thomas
I am using version 3.2.11 and I have a question regarding "Moderation". What must I enter in the form "Moderator Host"?
I do not find an explanation for that anywhere.
Hope you can help me.
Thanks in advance.
Heinz
Re: (small) german phorum-documentation
November 10, 2004 04:55PM
don't know. its not there in recent versions and phorum-3.2.x is an ancient version nowadays. I don't even have a running install of that version anywhere.

Sorry, you do not have permission to post/reply in this forum.