From 5b4d03923d33998372e339cfe21b7b87f22af290 Mon Sep 17 00:00:00 2001 From: ulrich Date: Fri, 15 Jan 2021 18:54:15 +0000 Subject: [PATCH] Text bearbeiten und speichern, weiter in arbeit --- README.md | 47 +++++++++++++++++++++++++++++++++++++++++------ 1 files changed, 41 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 6c8dcad..4e955e9 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Dateiverwaltung -Eine Bedienoberfläche zur Bearbeitung und Verwaltung von Dateien für die [WebBox](/data/ulrich/prg/webbox). +Eine Webanwendung zur Bearbeitung und Verwaltung von Dateien für die [WebBox](/data/ulrich/prg/webbox). ## Funktionen @@ -14,15 +14,16 @@ - Hochladen per Drag and Drop direkt in Ordner - Listen- und Kachelansicht -Die Bedienoberfläche passt sich an verschiedene Geräteausstattungen an (responsiv). Weitere Informationen zur Dateiverwaltung finden sich auf der [Produktseite](/data/ulrich/prg/file-cms). +Die Bedienoberfläche passt sich an verschiedene Geräteausstattungen an (responsiv). ### Konfiguration -Die Dateiverwaltung arbeitet mit relativen Pfadangaben und erhält den Ablageort von Dateien über die Angabe `de.uhilger.filecms.web.Initialiser.FILE_BASE` des Servlet-Kontext. Diese Angabe wird beim Start der Dateiverwaltung gebildet und kann im Deployment Descritor der Dateiverwaltung (Datei `WEB-INF/web.xml`) mit dem Context-Parameter `datenAblage` festgelegt werden. +Die Dateiverwaltung bezieht den Ablageort von Dateien über die Systemvariable `wbx.data`. Diese Angabe muss beim Start des Java-Prozesses als Parameter gesetzt sein wie in `java -Dwbx.data=/pfad/zu/den/daten [weitere Parameter]`. #### Automatische Ermittlung des Ablageortes -Ist die Angabe `datenAblage` im Deployment Descriptor der Dateiverwaltung leer, wird der Ablageort `../../../daten` ausgehend von `$CATALINA_BASE/webapps` verwendet. Wenn also z.B. das webapps-Verzeichnis in `/usr/local/tomcat/webapps` liegt, dann wird das Datenverzeichnis der Dateiablage in `/usr/daten` vermutet. Liegt es stattdessen in `/media/extmirror/srv/wbx/sys/base/webapps` dann lautet der Datenpfad `/media/extmirror/srv/wbx/daten`. +Ist die Angabe `wbxFileBase` nicht zu finden oder leer, wird der Ablageort `../../../daten` ausgehend von `$CATALINA_BASE/webapps` verwendet. + ## Webanwendung herstellen @@ -76,7 +77,7 @@ Das Webarchiv der Dateiverwaltung liegt anschließend als `$FILE-CMS/dist/file-cms.war` fertig zum Deployment bereit. -Die im obigen Build-Skript bereits mit `$CATALINA_BASE` gekennzeichneten Klassenbibliotheken werden nicht als Teil des Webarchivs der Dateiverwaltung gebaut und im Verzeichnis `$CATALINA_BASE/lib` der WebBox erwartet. +Die im obigen Build-Skript bereits mit `$CATALINA_BASE` gekennzeichneten Klassenbibliotheken werden nicht als Teil des Webarchivs der Dateiverwaltung gebaut und im Verzeichnis `$CATALINA_BASE/lib` der WebBox erwartet. ### Distributionsalternative @@ -94,6 +95,8 @@ $CATALINA_BASE/webapps/jslib/codemirror ........... mindestens in Version 5.24.2 $CATALINA_BASE/webapps/jslib/tinymce .............. mindestens in Version 4.3.4 $CATALINA_BASE/webapps/jslib/fancybox ............. mindestens in Version 3 +$CATALINA_BASE/webapps/jslib/moment ............... mindestens in Version 2.8.1 +$CATALINA_BASE/webapps/jslib/numeral .............. mindestens in Version 2.0.6 ``` `$CATALINA_BASE` meint das in der der Datei [RUNNING.txt](http://tomcat.apache.org/tomcat-8.5-doc/RUNNING.txt) der Tomcat-Dokumentation so bezeichnete Verzeichnis. Nachfolgend die Quellen, von denen die obigen Abhängigkeiten bezogen werden können: @@ -105,7 +108,39 @@ - [Codemirror](https://codemirror.net) - [TinyMCE](https://tinymce.com) - [Fancybox](http://fancyapps.com/fancybox/3/) +- [Moment](http://momentjs.com/) +- [Numeral](http://numeraljs.com/) + +## Ausfuehren + +Zum Ausfuehren wird die Datei `file-cms.war` in den Ordner `$CATALINA_BASE/webapps` von Tomcat gelegt. Der Aufruf erfolgt anschliessend mit dem URL `https://example.com/file-cms/ui`. Nutzer muessen die Rolle `ownFileAdmin` besitzen um die Webanwendung verwenden zu koennen. + +Die Ausfuehrung gelingt in der hier beschriebenen Konfiguration auch ohne die WebBox auf einem Tomcat, wie er ab Werk ausgestattet ist. Die folgenden Einstellungen muessen in diesem Fall von Hand an Tomcat vorgenommen werden: + +- SingleSignOn Valve in `$CATALINA_BASE/conf/server.xml` einschalten +- Environment-Variable fuer den Ablageort in `$CATALINA_BASE/conf/context.xml` anlegen (Angabe fuer `wbxFileBase` wie weiter oben erwaehnt) +- `data.xml` und `home.xml` in `$CATALINA_BASE/conf/Catalina/localhost` anlegen wie in folgendem Beispiel + +``` +<?xml version="1.0" encoding="UTF-8"?> +<Context path="/data" docBase="/pfad/zum/ablageort"> +</Context> +``` + +Das `file-cms` legt beim ersten Start die Verzeichnisse www und home in dem Verzeichnis an, das mit `wbxFileBase` angegeben wurde (siehe weiter oben). Wenn beispielsweise der Ablageort `/media/rdata/cms` als `wbxFileBase` angegeben wurde ist der Eintrag fuer `docBase` in `data.xml` `/media/rdata/cms/www` und in `home.xml` `/media/rdata/cms/home`. ## Lizenz -Die Dateiverwaltung wird zu den Bedingungen der [GNU Affero General Public License](/gitblit/doc/file-cms.git/master/web!agpl.txt) bereitgestellt. Die von der Dateiverwaltung verwendeten Komponenten unterliegen zum Teil anderen Lizenzen. Deren Nutzungsbedingungen sind an den Quellen der Komponenten angegeben. \ No newline at end of file +Die Dateiverwaltung wird zu den Bedingungen der [GNU Affero General Public License](/gitblit/doc/file-cms.git/master/web!agpl.txt) bereitgestellt. Die von der Dateiverwaltung verwendeten Komponenten unterliegen zum Teil anderen Lizenzen. Deren Nutzungsbedingungen sind an den Quellen der Komponenten angegeben. + +## ui2 Prototyp + +Unter `file-cms/ui2` entsteht eine neue Bedienoberfläche basierend auf `app-vorlage` und `app-menu` + +### Änderungen gegenüber der Bedienoberfläche des file-cms + +- kein Bootstrap mehr +- kein jQuery mehr (allerdings benötigt Fancybox jQuery -> evtl. in separate .html-Datei auslagern) +- kein FontAwesome mehr, die wenigen benötigtgten Piktogramme sind mit Hilfe von Fontello aus FontAwesome entnommen und in das file-cms-Projekt kopiert (nur wenige KB) +- noch mehr zur Bedienung über berührungsempfindliche sowie kleinere Bildschirme geeignet + -- Gitblit v1.9.3