From ac72fe96abe90bee2d3ca5c1e2cab2cc5e9c1e39 Mon Sep 17 00:00:00 2001 From: ulrich <undisclosed> Date: Mon, 05 Mar 2018 06:53:07 +0000 Subject: [PATCH] WEB-INF und META-INF ausgeblendet --- README.md | 24 +++++++++++++++++++----- 1 files changed, 19 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 3dde990..f5b3f1c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Dateiverwaltung -Die Dateiverwaltung stellt eine Bedienoberfläche zur Bearbeitung und Verwaltung von Dateien für die [WebBox](/dev/Software/WebBox/WebBox) bereit. +Eine Bedienoberfläche zur Bearbeitung und Verwaltung von Dateien für die [WebBox](/dev/Software/WebBox/WebBox). ## Funktionen @@ -16,6 +16,14 @@ Die Bedienoberfläche passt sich an verschiedene Geräteausstattungen an (responsiv). Weitere Informationen zur Dateiverwaltung finden sich auf der [Produktseite](/dev/Software/filecms/Dateiverwaltung). +### 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. + +#### 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`. + ## Webanwendung herstellen Zum Herstellen der Webanwendung wird ein Java Development Kit (JDK) benötigt, wie es z.B. von [Azul](http://azul.com) oder dem [OpenJDK-Projekt](http://openjdk.java.net/) frei erhältlich ist. In der hier folgenden weiteren Beschreibung wird der lokale Ablageort des Java Development Kits `$JDK` genannt. @@ -30,8 +38,9 @@ Tomcat .............. lib/servlet-api.jar ........... $CATALINA_HOME XStream ............. xstream-1.4.7.jar ............. $JLIB Jettison ............ jettison-1.3.3.jar ............ $JLIB +Thumbnailator ....... thumbnailator.jar ............. $CATALINA_BASE +wbx-lib ............. wbx-lib.jar ................... $CATALINA_BASE Transit ............. Transit.jar ................... $JLIB -FileSystem .......... FileSystem.jar ................ $JLIB ``` Diese sind an folgenden Orten frei erhältlich: @@ -39,8 +48,9 @@ - [Apache Tomcat](http://tomcat.apache.org) - [XStream](https://github.com/codehaus/xstream) - [Jettison](https://github.com/codehaus/jettison) +- [Thumbnailator](https://github.com/coobird/thumbnailator) - [Transit](/gitblit/docs/Transit.git) -- [FileSystem] (/gitblit/docs/FileSystem.git) +- [wbx-lib](/gitblit/docs/wbx-lib.git) Nach Beschaffung des JDK und der oben angegebenen Klassenbibliotheken wird der Quellcode aus diesem Git-Repository an einen frei wählbaren lokalen Ablageort [heruntergeladen](http://uhilger.de/gitblit/zip/?r=file-cms.git&h=master&format=zip) und entpackt. In der hier folgenden weiteren Beschreibung wird das so entstandene Verzeichnis `file-cms-master` einschließlich des absoluten Pfades dorthin `$FILE-CMS` genannt. Ferner wird angenommen, dass die oben aufgeführten Klassenbibliotheken lokal an Orten abgelegt sind, deren Pfade mit den Platzhaltern `$JLIB` und `$CATALINA_HOME` gemeint sind. Anstelle der Platzhalter in den folgenden Kommandos muss also der absolute Pfad des lokalen Ablageortes eingesetzt werden. @@ -57,7 +67,7 @@ cd ../.. cp $JLIB/* build/WEB-INF/lib -$JDK/bin/javac -classpath $JLIB/commons-fileupload-1.3.2.jar:$JLIB/commons-io-2.5.jar:$JLIB/jettison-1.3.3.jar:$JLIB/Transit.jar:$JLIB/FileSystem.jar:$JLIB/xstream-1.4.7.jar:$CATALINA_HOME/lib/servlet-api.jar -d ./build/WEB-INF/classes src/java/de/uhilger/filecms/api/*.java src/java/de/uhilger/filecms/web/*.java src/java/de/uhilger/filecms/pub/*.java +$JDK/bin/javac -classpath $JLIB/commons-fileupload-1.3.2.jar:$JLIB/commons-io-2.5.jar:$JLIB/jettison-1.3.3.jar:$JLIB/Transit.jar:$JLIB/xstream-1.4.7.jar:$CATALINA_HOME/lib/servlet-api:$CATALINA_BASE/lib/thumbnailator.jar:$CATALINA_BASE/lib/wbx-lib.jar.jar -d ./build/WEB-INF/classes src/java/de/uhilger/filecms/api/*.java src/java/de/uhilger/filecms/web/*.java src/java/de/uhilger/filecms/pub/*.java cp src/java/logging.properties build/WEB-INF/classes $JDK/bin/jar -cf dist/file-cms.war -C build . @@ -65,6 +75,8 @@ ``` 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. ### Distributionsalternative @@ -76,11 +88,12 @@ ``` $CATALINA_BASE/webapps/jslib/bootstrap ............ mindestens in Version 4.0 alpha 6 -$CATALINA_BASE/webapps/jslib/jquery ............... mindestens in Version 1.11.1 +$CATALINA_BASE/webapps/jslib/jquery ............... mindestens in Version 3.2.1 $CATALINA_BASE/webapps/jslib/mustache ............. mindestens in Version 2.3.0 $CATALINA_BASE/webapps/jslib/font-awesome ......... mindestens in Version 4.4.0 $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` 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: @@ -91,6 +104,7 @@ - [Font Awesome](http://fontawesome.io/) - [Codemirror](https://codemirror.net) - [TinyMCE](https://tinymce.com) +- [Fancybox](http://fancyapps.com/fancybox/3/) ## Lizenz -- Gitblit v1.9.3