EisPortal - WebPortal fuer EisFair Pakete =========================================== Version 0.0.1 Last Change $Id$ 1. EisPortal - Was ist das? =========================== EisPortal ist die zentrale Umgebung eines einheitlichen Webfrontends für den Easy Internet Server EisFair. Dabei stellt EisPortal lediglich die Umgebung zur Verfügung, welche erst durch die Installation von EisPortal-Modulen mit Funktionaliät gefüllt wird. Diese Module integrieren sich nahtlos in EisPortal. EisPortal ermöglicht die Verwaltung von Benutzerrechten sowohl global als auch für jedes einzelne Modul. Diese Administration ist sowohl durch das normale Setup-Tool, als auch direkt im Browser möglich. 2. Voraussetzungen ================== Für die Benutzung von EisPortal werden die folgenden installierten Pakete benötigt: - Base (base) 1.2.2 - Apache2 (apache2) 1.0.8 - PHP5 (apache2_php5) 1.0.11 - PEAR (php5_ccpp) 0.0.2 - MySQL (mysql) 1.2.13 3. Installation =============== Die Installation wird lediglich dann abgebrochen, wenn die Base-Version zu alt ist oder wenn die anderen Pakete nicht vorhanden sind. Bei älteren Versionen der anderen Pakete erscheint ein Hinweis, dass die installierte Version älter als die gewünschte Version ist. Bisher sind keine Probleme mit älteren Versionen bekannt. Sollten hier Probleme auftauchen, diese bitte an unter genauer Angabe der verwendeten Versionen und einer Fehlerbeschreibung mailen. Vielen Dank. 3.1 Übergangslösung für PEAR-Packages ===================================== Momentan werden die PEAR-Packages mangels Möglichkeit noch nicht automatisch installiert. Bis das möglich ist, bitte die benötigten Packages von der Kommandozeile installieren. Dazu folgendes eingeben, nachdem das Paket php5_ccpp installiert wurde: eis# pear install -a HTML_Template_IT eis# pear install -a Auth Damit werden die benötigten PEAR-Pakete zusammen mit einigen Sub-Paketen installiert. Das Binary sollte durch die normalen PATH-Settings gefunden werden. Bei eventuellen Problemen ist es unter /usr/local/bin/ zu finden. Desweiteren ist darauf zu achten, dass die PEAR-Pakete auch gefunden werden. Dazu muss in den PHP-Settings unter PHP_INCLUDE_PATH="/usr/share/php5" eingetragen werden. Achja, die PHP-Settings befinden sich unter - Service administration -- Apache2 Webserver --- Configuration ---- Module configuration (e.g. PHP) 4. Die EisPortal Menüpunkte =========================== 4.1 EisPortal Hauptmenü ======================= 1. View Documentaion Zeigt diesen Text an. 2. Edit configuration Hier wird die Hauptkonfiguration für EisPortal bearbeitet. Genaueres dazu unter "4.1.1 Edit configuration" 3. Advanced configuration file handling Unter diesem Menüpunkt befinden sich die üblichen Eis-Möglichkeiten, die Konfiguration zu sichern, zu vergleichen etc. pp. 4. Administrative tools Dieser Menüpunkt führt zu einem Untermenü, in welchem die Administration von EisPortal bzgl. Benutzern und deren Rechten durchgeführt wird. Ausserdem sind hier diverse Datenbanktools verfügbar. Siehe dazu "4.1.2 Menü Administrative tools". 5. Modul configuration Unter diesem Menüpunkt erscheinen alle installierten EisPortal-Module. Somit können von hier aus die Module konfiguriert werden. Nach der Installation von EisPortal ist dieser Eintrag natürlich noch leer. 4.1.1 Edit configuration ======================== Im Folgenden werden die Möglichkeiten der EisPortal-Konfiguration vorgestellt. Die jeweilige Standardeinstellung ist als dabei direkt in der Überschrift zu sehen. START_EISPORTAL='no' Mit diesem Parameter wird eingestellt, ob EisPortal via Browser verfügbar sein soll oder nicht. Bei Einstellung "no" wird im Browser keinerlei Eingabefeld o. ä. dargestellt. EISPORTAL_INSTALL_PATH="APACHE2_DOCUMENT_ROOT" ACHTUNG: Wert nicht verändern, Funktionalität ist noch nicht vollständig!!! Hier wird der Pfad angegeben, unter dem der EISPORTAL_INSTALL_FOLDER angelegt wird. Gueltige Werte: vom Webserver erreichbarer Pfad EISPORTAL_INSTALL_FOLDER='eisportal' ACHTUNG: Wert nicht verändern, Funktionalität ist noch nicht vollständig!!! Das hier angegebene Verzeichnis wird im EISPORTAL_INSTALL_PATH angelegt. In dieses Verzeichnis wird EisPortal installiert. Gueltige Werte: jeder gültige Verzeichnisname EISPORTAL_URL='192.168.0.202' Ueber diesen Parameter wird der URL eingestellt, ueber den das Portal zu erreichen sein soll. Das kann in der Form "domain.deines.servers" oder auch direkt durch die Angabe der IP erfolgen. Das Verzeichnis "eisportal" wird automatisch hinzugefuegt. Gueltige Werte: Jeder URL oder jede IP bis zum EisPortal-Verzeichnis EISPORTAL_LANG='de' Ueber diesen Parameter wird die dargestellte Sprache eingestellt. Zur Zeit wird de = deutsch und en = englisch unterstützt. Wer sich die Mühe machen möchte ein weiteres Sprachfile zu erstellen, der möge sich bitte bei mir melden! Das ist prinzipiell kein Problem und auf jeden Fall eine Bereicherung des Projekts. Gueltige Werte: de, en EISPORTAL_TEMPLATE='html' In dieser Variablen wird das zu verwendende Template für die 'Optik' des Portals im Webbrowser eingetragen. Momentan gibt es nur das html-Template aber das wird sich noch ändern. Gueltige Werte: html EISPORTAL_NAVI_LOCATION='top' Hier wird die Position des Navigationsmenues angegeben. Dabei steht 'top' für horizontal am oberen Rand und 'left' für vertikal am linken Rand. Gueltige Werte: top, left EISPORTAL_NAVI_STYLE='1' Hier wird das Aussehen der Links für installierte Module eingestellt. Dabei bedeutet '0', dass nur Textlinks, '1', dass Textlinks und Images und '2', dass nur Imagelinks angezeigt werden. Einstellung '2' macht sich bezahlt, wenn EISPORTAL_NAVI_LOCATION auf 'left' gestellt wurde. Gueltige Werte: 0, 1, 2 EISPORTAL_DB_HOST='localhost' Hier wird der FQDN, der Full Qualified Domain Name zur Datenbank eingetragen. Wenn die DB auf der gleichen Maschine läuft, kann dies auch 'localhost' sein. Gueltige Werte: vollständige URL zur Datenbank EISPORTAL_DB_ADMIN_USER='' Dieser User wird in MySQL als Datenbank-Nutzer angelegt. Ueber diesen User werden sämtliche Zugriffe auf die DB getätigt, das heisst, dass nur ein Nutzer in der DB angelegt wird und die Datenbankzugriffe unter diesem Namen erfolgen. Die Namen 'eisportal', 'eis' und 'root' sind nicht erlaubt. Gueltige Werte: Jeder String _ohne_ Leerzeichen EISPORTAL_DB_ADMIN_PASS='' Das Passwort des Datenbankusers. 'eisportal' als Passwort ist nicht erlaubt. Gueltige Werte: Alle druckbaren Zeichen EISPORTAL_DB_NAME='eisportal' Hier wird der Name der Datenbank angegeben, die für EisPortal erzeugt werden soll. Dieser Wert muss im Normalfall nicht verändert werden. Gueltige Werte: Jeder String _ohne_ Leerzeichen EISPORTAL_DB_BACKUP_LOCATION='/data/backup/' Hier wird der Pfad angegeben, unter dem die Datenbank-Backups für EisPortal erzeugt werden. Backups werden _nicht_ automatisch erzeugt, solange die Backup-Funktion nicht aufgerufen oder diese via cron-Job angestoßen wird. Gueltige Werte: Jeder gültige Pfad abgeschlossen mit '/' EISPORTAL_REMOTEHOST_CONNECTED='no' Über diesen Schalter wird die Verbindung zwischen verschiedenen Eis- Rechnern aktiviert. Dabei können im Extremfall EisPortal, Datenbank und eine diese Sachen nutzende Anwendung auf drei verschiedenen Maschinen laufen, bspw.: Rechner 1: EisFax Rechner 2: EisPortal Rechner 3: MySQL Damit diese Funktionalität gewährleistet ist, werden durch das Setzen von EISPORTAL_REMOTEHOST_CONNECTED='yes' die entsprechenden Setupmöglichkeiten eingeblendet. In development - in Entwicklung: EISPORTAL_REMOTEHOST_N='1' EISPORTAL_REMOTEHOST_1_NAME='' EISPORTAL_REMOTEHOST_1_ACTIVE='no' EISPORTAL_REMOTEHOST_1_HOST='' 4.1.2 Menü "Administrative tools" =============================== 1. List users Dieser Menüpunkt listet alle für EisPortal angelegten Benutzer mit deren globalen Rechten auf. Globale Rechte bedeuten dabei, dass lediglich sichtbar ist, welche allgemeinen Rechte ein User hat. Folgende Rechte sind möglich: - no rights - Der User hat im Browser auf kein Modul Zugriff. Mit dieser Einstellung kann ein User vorübergehend deaktiviert werden, ohne seine Rechte für jedes Modul einzeln löschen zu müssen - User - Der User hat prinzipiellen Modulzugriff im Browser. Ob und mit welchen weitergehenden Rechten er aber auf ein einzelnes Modul zugreifen kann, wird für jedes Modul separat eingestellt. - Portal-Admin - Der Portal-Admin hat alle Rechte um EisPortal und dessen User zu administrieren. Er kann User incl. deren Rechten anlegen, modifizieren und natürlich auch löschen. Dieser Menüpunkt ist auch via Browser als Portal-Admin verfügbar. 2. Add user Mit diesem Menüpunkt wird ein neuer User angelegt. Dabei wird ein Benutzername, der Realname sowie ein Passwort erfragt. Diese Felder müssen ausgefüllt werden. Benutzername und Passwort müssen sich unterscheiden. Im Anschluss daran werden die Rechte dieses neuen Users für die zu diesem Zeitpunkt installierten Module erfragt. Diese Rechte lehnen sich an die globalen Rechte an. Folgende Rechte sind möglich: - no rights - Der User hat im Browser auf dieses Modul keinen Zugriff, genauer gesagt, er sieht es gar nicht erst. Mit dieser Einstellung kann ein User für die Nutzung eines Moduls gesperrt werden. - User - Der User hat Zugriff auf dieses Modul. Dies ist die Einstellung für die normale Benutzung. - Modul-Admin - Ein Modul-Admin hat das Recht, administrative Aufgaben dieses Moduls wahrzunehmen. Er kann _nicht_ User incl. deren Rechten anlegen, modifizieren oder löschen. Welche Aufgabe eines Moduls administrativer Natur ist, hängt vom jeweiligen Modul ab. Das heisst, dass es in der Verantwortung eines Moduls liegt, was ein Modul-Admin machen kann/darf/soll. Dieser Menüpunkt ist auch via Browser als Portal-Admin verfügbar. 3. Remove user Unter diesem Menüpunkt wird ein Benutzername erfragt und dieser User nach einer Sicherheitsabfrage aus der EisPortal-Benutzerdatenbank gelöscht. Dieser Menüpunkt ist auch via Browser als Portal-Admin verfügbar. 4. Change user's details, password and rights Hier werden die Daten eines Benutzers bearbeitet. Dabei können alle Daten bis auf den Benutzernamen geändert werden. Der Ablauf ist dabei identisch mit "2. Add user". Dieser Menüpunkt ist auch via Browser als Portal-Admin verfügbar. 5. Backup EisPortal database Dieser Menüpunkt legt ein Backup der EisPortal Datenbank an. Dieser Dump wird unter dem in der Konfiguration eingestellten Pfad mit dem Namen "eisportal_db_____" abgespeichert. Darin enthalten sind _alle_ Tabellen, welche sich zu diesem Zeitpunkt in der EisPortal-Datenbank befinden. Das beinhaltet auch die Tabellen der Module etc. pp. 6. Restore EisPortal database Mit diesem Menüpunkt kann ein Backup der EisPortal-DB eingespielt werden. Dazu muss der vollständige Pfad zur Backupdatei angegeben werden. Bsp.: /data/backup/eisportal_db_2006_07_23_10_23 7. Remove admin user Hier wird ein DB-Admin-User gelöscht. Dieser User ist nicht zu verwechseln mit einem Modul- oder Portal-Admin! Der DB-Admin-User ist der "User", der die eigentlichen Datenbankzugriffe macht, ganz gleich, wer gerade EisPortal benutzt. Dieser Menüpunkt wird nur benötigt, wenn sich (aus welchen Gründen auch immer) der in der Konfiguration eingestellte Portal-Admin ändert. Da es nicht feststellbar ist, ob dieser DB-User auch noch anderweitig benötigt wird, gibt es diese Möglichkeit, den User "von Hand" zu löschen. to be continued... Copyright (c) 2005-2006 Yves Schumann