From c02f76900882d57ebbaa3d94d87a0ce68a33df3b Mon Sep 17 00:00:00 2001 From: ulrich <undisclosed> Date: Fri, 10 Aug 2018 05:36:14 +0000 Subject: [PATCH] Doku ergaenzt --- README.md | 27 +++++++++++++++++++++++---- 1 files changed, 23 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6c8dcad..56e1da4 100644 --- a/README.md +++ b/README.md @@ -18,11 +18,22 @@ ### 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 erhält den Ablageort von Dateien über den JNDI-Eintrag + +```` +<Environment + name="wbxFileBase" + type="java.lang.String" + value="/pfad/zu/den/daten" + override="false" +/> +```` + +Wenn die Angabe `wbxFileBase` wie oben als JNDI-Parameter angegeben wird, kann sie beispielsweise in der Datei `$CATALINA_BASE/context.xml` hinterlegt 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`. +Ist die Angabe `wbxFileBase` nicht zu finden oder 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 @@ -76,7 +87,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 +105,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 +118,13 @@ - [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. ## 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. -- Gitblit v1.9.3