Dateiverwaltung für die WebBox
ulrich
2017-02-25 798463625eef10cc7eda76325d409623f445e00f
readme hinzugefuegt
1 files added
88 ■■■■■ changed files
README.md 88 ●●●●● patch | view | raw | blame | history
README.md
New file
@@ -0,0 +1,88 @@
# Dateiverwaltung
Die Dateiverwaltung ist eine Webanwendung, die eine Bedienoberfläche und Funktionen zur Verwaltung von Dateien auf einem [Tomcat Servlet Container] (http://tomcat.apache.org) bereitstellt.
## Funktionen
Die Dateiverwaltung stellt die folgenden Funktionen bereit
- hier
- Funktionen
- auflisten
Die Bedienoberfläche passt sich an verschiedene Geräteausstattungen an (responsiv).
Weitere Informationen zur Dateiverwaltung finden sich auf der Produktseite (Link noch angeben...).
## 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/) erhältlich ist. In der hier folgenden weiteren Beschreibung wird der lokale Ablageort des Java Development Kits `$JDK` genannt.
Desweiteren werden die folgenden Klassenbibliotheken benötigt
```
Bibliothek            Datei(en)                       Ablageort lokal
----------            ---------                       ---------------
Commons Fileupload .. commons-fileupload-1.3.2.jar .. $JLIB
Commons IO .......... commons-io-2.5.jar ............ $JLIB
Tomcat .............. lib/servlet-api.jar ........... $CATALINA_HOME
XStream ............. xstream-1.4.7.jar ............. $JLIB
Jettison ............ jettison-1.3.3.jar ............ $JLIB
Transit ............. Transit.jar ................... $JLIB
FileSystem .......... FileSystem.jar ................ $JLIB
```
Diese sind an folgenden Orten frei erhältlich:
- [Apache Commons](http://commons.apache.org)
- [Apache Tomcat](http://tomcat.apache.org)
- [XStream](https://github.com/codehaus/xstream)
- [Jettison](https://github.com/codehaus/jettison)
- [Transit](https://uhilger.de/gitblit/summary/Transit.git)
- [FileSystem] (https://uhilger.de/gitblit/summary/FileSystem.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.
Zur Herstellung der WebBox-Verwaltung werden die folgenden Kommandos ausgeführt (Beispiel für Linux):
```
cd $FILE-CMS
mkdir dist
mkdir build
cp -r web/* build
cd build/WEB-INF
mkdir classes
mkdir lib
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/wbx/api/*.java src/java/de/uhilger/wbx/web/*.java
$JDK/bin/jar -cf dist/file-cms.war -C build .
rm -r build
```
Das Webarchiv der Dateiverwaltung liegt anschließend als `$FILE-CMS/dist/file-cms.war` fertig zum Deployment bereit.
### Distributionsalternative
Das Kommando `cp $JLIB/* build/WEB-INF/lib` kann auch weggelassen werden, dann sind die Klassenbibliotheken nicht Teil des Webarchivs der Dateiverwaltung. In diesem Fall muss stattdessen der Inhalt von `$JLIB` nach `$CATALINA_BASE/lib` kopiert werden.
## Abhängigkeiten
Die Dateiverwaltung erfordert die folgenden Bestandteile auf der Instanz von Tomcat, auf der sie ausgeführt werden soll:
```
$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/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` 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:
- [Bootstrap](http://getbootstrap.com)
- [jQuery](http://jquery.com)
- [Mustache](https://github.com/janl/mustache.js)
- [Font Awesome](http://fontawesome.io/)
- [Codemirror](https://codemirror.net)