source: Core/trunk/documentation/corinis.xml @ 690

Revision 690, 17.7 KB checked in by niko, 30 hours ago (diff)

remove utf problems

Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!--
3CCM Configuration File
4=======================
5
6Has to be inside the executeroot of the server.
7
8All paths may be set to auto. If this is true, corinis will search for the correct paths.
9The directories must be default to:
10/cmsfiles - the cms file directory (for images)
11/photos - the photolibrary
12/WEB-INF/corinis.xml - the configuration xml
13/WEB-INF/xsl - the xsls
14/WEB-INF/templates - the cms templates
15/WEB-INF/temp - the temp directory
16/WEB-INF/logs - the log directory 
17/WEB-INF/verify.txt - the verify users mail body text
18/WEB-INF/password.txt - the password retrieval mail body text
19
20Additional Software Requirements:
21-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
22The following Software is not really required, but nice-to-have and allows some
23extended features:
24
25ImageMagick - for image manipulation
26sendmail (or wrapper) - for faster sending of mails
27-->
28
29<CORINIS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="corinis.xsd">
30        <!--
31        Database Configuration
32        ======================
33        Insert the Database Driver and configuration parameter. Make sure the
34        Database Driver is in the classpath!
35        the log file will also contain corinis specific errors
36        CONNECTIONS specifies the number of concurrent connections opened at start (may become more)
37       
38        support dbslangs are:
39         * mysql
40         * hsql
41        -->
42        <DATABASE>
43                <!-- for mysql: -->
44                <!--
45                <DRIVER>com.mysql.jdbc.Driver</DRIVER>
46                <JDBC>jdbc:mysql://$dbhost/$db?useUnicode=true&amp;characterEncoding=iso-8859-1</JDBC>
47                <USER>$dbuser</USER>
48                <PASS>$dbpass</PASS>
49                <DBSLANG>mysql</DBSLANG>
50                 -->
51                <!-- for hsql: -->
52                <DRIVER>org.hsqldb.jdbcDriver</DRIVER>
53                <JDBC>auto</JDBC>
54                <USER>sa</USER>
55                <PASS />
56                <DBSLANG>hsql</DBSLANG>
57                <CONNECTIONS>5</CONNECTIONS>
58                <MAXCONNECTIONS>50</MAXCONNECTIONS>
59                <DBTIMEOUT>1000</DBTIMEOUT>
60                <LOG>auto</LOG>
61        </DATABASE>
62
63    <!--
64   2. Localization Options
65   =======================
66   Define local attributes as the date/time format
67
68   Symbols for the datetime format, the format is for input AND output:
69
70         Symbol   Meaning                 Presentation        Example
71         -=-=-=   -=-=-=-                 -=-=-=-=-=-=        -=-=-=-
72         G        era designator          (Text)              AD
73         y        year                    (Number)            1996
74         M        month in year           (Text & Number)     July & 07
75         d        day in month            (Number)            10
76         h        hour in am/pm (1~12)    (Number)            12
77         H        hour in day (0~23)      (Number)            0
78         m        minute in hour          (Number)            30
79         s        second in minute        (Number)            55
80         S        millisecond             (Number)            978
81         E        day in week             (Text)              Tuesday
82         D        day in year             (Number)            189
83         F        day of week in month    (Number)            2 (2nd Wed in July)
84         w        week in year            (Number)            27
85         W        week in month           (Number)            2
86         a        am/pm marker            (Text)              PM
87         k        hour in day (1~24)      (Number)            24
88         K        hour in am/pm (0~11)    (Number)            0
89         z        time zone               (Text)              Pacific Standard Time
90         '        escape for text         (Delimiter)
91         ''       single quote            (Literal)           '
92
93(Text): 4 or more       pattern letters -use full form,
94        < 4             use short or abbreviated form if one exists.
95(Number): the minimum number of digits. Shorter
96        numbers are zero-padded to this amount.
97        Year is handled specially; that is, if
98        the count of 'y' is 2, the Year will be
99        truncated to 2 digits.
100(Text & Number): 3 or over, use text, otherwise
101        use number. Any characters in the pattern
102        that are not in the ranges of ['a'..'z']
103        and ['A'..'Z'] will be treated as quoted text.
104        For instance, characters like ':', '.', ' ', '#'
105        and '@' will appear in the resulting time text
106        even they are not embraced within single quotes.
107        A pattern containing any invalid pattern letter
108        will result in a thrown exception during
109        formatting or parsing.
110
111Examples Using the US Locale:
112
113        Format Pattern                         Result
114 "yyyy.MM.dd G 'at' hh:mm:ss z"    ->>  1996.07.10 AD at 15:08:56 PDT
115 "EEE, MMM d, ''yy"                ->>  Wed, July 10, '96
116 "h:mm a"                          ->>  12:08 PM
117 "hh 'o''clock' a, zzzz"           ->>  12 o'clock PM, Pacific Daylight Time
118 "K:mm a, z"                       ->>  0:00 PM, PST
119 "yyyyy.MMMMM.dd GGG hh:mm aaa"    ->>  1996.July.10 AD 12:08 PM
120
121        LOCALE: set the locale - used for string compares and sorting and the lucene search (de, en, fr, ru, ...)
122        CHARSET: specify the charset used for file reading/writing
123  -->
124        <LOCALIZATION>
125                <CHARSET>iso-8859-1</CHARSET>
126                <LOCALE>de</LOCALE>
127                <DATEFORMAT>MM/dd/yyyy</DATEFORMAT>
128                <TIMEFORMAT>HH:mm</TIMEFORMAT>
129                <DATETIMEFORMAT>MM/dd/yyyy HH:mm</DATETIMEFORMAT>
130        </LOCALIZATION>
131
132        <!--
133        Template Options
134        ================
135        The absolute path to the xsl templates used for parsing
136        -->
137        <XSL>
138                <PATH>auto</PATH>
139                <CACHING>false</CACHING>
140        </XSL>
141
142        <!--
143        Webroot
144        =======
145        The absolute path of your webroot
146        -->
147        <WEBROOT>
148                <PATH>auto</PATH>
149                <URL>auto</URL>
150        </WEBROOT>
151
152        <!-- Set this to the path of the imagemagick executable
153        If you do not have imagemagick installeg you can get it
154        from www.imagemagick.org. If you can not install it
155        or do not want to, comment the following tag. Then
156        the internal function is used.
157        ! NOTE !
158        Imagemagick is optimized for image manipulation, and
159        therefore better than javas internal functions. It is
160        freeware and open source. Using imagemagick also saves
161        a lot of process power and is much quicker than java.
162       
163        Specify the path to the mogrify executable here.
164        You can also specify a manipulate action done before
165        mogrify for the photoalbum
166       
167        The convert program is used by the image manipulator
168        from the multimedia library. It ONLY works, when
169        imagemagick is installed!
170        -->
171        <MEDIACONVERTER>
172                <MOGRIFY>mogrify +profile "*"</MOGRIFY>
173                <CONVERT>convert</CONVERT>
174                <CACHEFOLDER>auto</CACHEFOLDER>
175                <CACHEURL>auto</CACHEURL>
176        </MEDIACONVERTER>
177
178        <!--
179        Defines some variables for the upload of files.
180        The MAXSIZE defines the maximum filesize of an uploaded file.
181        You can use G for gigabyte M for Megabyte or K for kilobyte
182        (nothing defines bytes). Make sure to use upper-case chars only!
183        Make sure the CORE/TEMPPATH is set right, otherwise
184        bigger files wont be stored
185        -->
186        <UPLOAD>
187                <MAXSIZE>1G</MAXSIZE>
188        </UPLOAD>
189
190        <!--
191        Module Config
192        =============
193        Specify the names of the modules to load. Make sure to specify
194        the whole classpath to the module property
195        -->
196        <LOADMODULES>
197                <MODULE>corinis/modules/Core.properties</MODULE>
198                <MODULE>corinis/modules/Alerter.properties</MODULE>
199        </LOADMODULES>
200
201        <MODULES>
202        <!--
203        Core Module
204        TIMEOUT: the timeout (default ms, s - seconds, m - minutes, h - hours, d - days)
205        DEBUG: true: write all information to stdout inkl. full stacktrace, false put all you can into a file
206        TEMPPATH: a temporary path for storing some information
207        MACHINE: a unique namoe for the machine - normally it's ip
208        MACHINES/NAME: Specify the machines that run a corinis application
209                This is required for updates and cachings. It has to either be a dns-name or an ip
210        MASTER: the ip/dns of the master machine: this is where the rmi server is running (make sure it's
211                the same value as under MACHINES/NAME or the system gets confused)
212        CACHEREFRESH: when should the caching be renewed (default ms, s - seconds, m - minutes, h - hours, d - days)
213                this clears all caches and renews the most used ones. File caches (like fulltext search etc.) will also be
214                rebuild when cacherefresh hits - but internal caching will be used as long as possible so a cache rebuild should
215                not be noticed - depending on your architecture you should not set this below one day (normally 5-7d is a good value)
216        CACHEFOLDER: this is the folder where corinis will put cache files (like fulltext search, xmls for forum and cms) to.
217                You can delete all files, they will automatically be rebuild on start. Default: auto (=WEB-INF/cache/)
218                -->
219                <CORE>
220                        <ADMINUSER>admin</ADMINUSER>
221                        <ADMINPWD>admin</ADMINPWD>
222                        <GUESTUSER>guest</GUESTUSER>
223
224                        <!--
225                        Following loglevels are available:
226                                error: print only uncatched errrors
227                                warning: oprint warnings
228                                info: display process information (whats going on)
229                                debug: display each item accessed/touched
230                                coredebug: display all sql and in-process stuff (HUGE logfiles)
231                        -->
232                        <LOGFILE>auto</LOGFILE>
233                        <LOGLEVEL>warning</LOGLEVEL>
234
235                        <!--
236                        Set ENCRYPT to FALSE/TRUE if you want the passwords to be encrypted
237                        ! IMPORTANT !
238                        If you change this AFTER you already created some users, they have to
239                        reenter their passwords (i.e. you have to do that as admin user), otherwise
240                        you will not be able to logon to the system.
241                        If you set it to true, you can use any rsa1 tool to generate the encrypted passwords.
242                        -->
243                        <ENCRYPT>true</ENCRYPT>
244               
245                        <CACHEFOLDER>auto</CACHEFOLDER>
246
247                        <!--
248                                Set debug to true to write to stdout instead of the logfile
249                         -->
250                        <DEBUG>true</DEBUG>
251                        <TEMPPATH>auto</TEMPPATH>
252                        <TIMEOUT>60m</TIMEOUT>
253               
254               
255                        <LIFEDOMAIN>localhost</LIFEDOMAIN>
256                        <MACHINE>127.0.0.1</MACHINE>
257                        <MASTER>127.0.0.1</MASTER>
258                        <MACHINES>
259                                <NAME>127.0.0.1</NAME>
260                        </MACHINES>
261                        <CACHEREFRESH>24h</CACHEREFRESH>
262
263                        <!--
264                        These are file extension that are not allowed in the upload - nowhere
265                        This prevents viruses etc. from being uploaded
266                        -->
267                        <DISALLOWEDEXTENSIONS>
268                                <EXTENSION>jsp</EXTENSION>
269                                <EXTENSION>shtml</EXTENSION>
270                                <EXTENSION>php</EXTENSION>
271                                <EXTENSION>php4</EXTENSION>
272                                <EXTENSION>php5</EXTENSION>
273                                <EXTENSION>cgi</EXTENSION>
274                                <EXTENSION>asp</EXTENSION>
275                                <EXTENSION>pl</EXTENSION>
276                                <EXTENSION>exe</EXTENSION>
277                                <EXTENSION>htaccess</EXTENSION>
278                        </DISALLOWEDEXTENSIONS>
279                </CORE>
280
281                <!--
282                Properties for buildin user attributes
283                -->
284                <USERMANAGER>
285                        <LOCALUSERNAME>
286                                <MINLEN>4</MINLEN>
287                                <CHARSALLOWED>1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz_-()[]</CHARSALLOWED>
288                        </LOCALUSERNAME>
289                        <LOCALUSERAUTH>
290                                <MINLEN>4</MINLEN>
291                        </LOCALUSERAUTH>
292       
293                        <VERIFYUSERS>false</VERIFYUSERS>
294                        <VERIFYREPLYNAME>noreply</VERIFYREPLYNAME>
295                        <VERIFYREPLYEMAIL>noreply@localhost</VERIFYREPLYEMAIL>
296                        <VERIFYREPLYSUBJECT>Verify your registration at localhost</VERIFYREPLYSUBJECT>
297                        <VERIFYREPLYBODY>auto</VERIFYREPLYBODY>
298
299                        <!--
300                        users with a special right will be synced with an external file (one way only)
301                        Type may be:
302                        HTPASSWD
303                        MD5 (user:md5sumofpassword)
304                        PLAINTEXT (user:plaintextpassword)
305                        the sync only happens when new users are created or passwords are changed.
306                        complete sync is only possible when /CORINIS/CORE/ENCRYPT = false
307                        File: auto (WEB-INF/.htpasswd)
308                        -->
309                        <USERSYNC>
310                                <TYPE>htpasswd</TYPE>
311                                <RIGHT>USERMANAGER_SYNC</RIGHT>
312                                <FILE>auto</FILE>
313                        </USERSYNC>
314                </USERMANAGER>
315
316                <!-- Named Guests
317                Allow guest users to login, with a username without a password.
318                If verifyusers is set to TRUE, users must verify their account before
319                being able to log in.
320                The file specified in verifymail is the mail body for verification - $name will be
321                replaced by the username, $verify by the verify string. The mail will be sent
322                as html-mail.
323                Make sure the email has an url similar to:
324                http://www.corinis.com/verify.jsp?Login_username=&username;&Login_verify=&verify;
325                where username and verify will be replaced by the generated values.
326                If you want to use ntlm auth enable the option and make sure that you call the Login.ntlmauth() function before
327                anything else.
328                If you want to authenticate against a domain controller enable it and set domain/domaincontroller
329                The defaultgroup(s) are added to the user if a new one has to be created.
330                If you want to enable basic authenticated set BASICAUTH to true - basic authenticaten
331                disables the use of guest users automaticalle since every not authenticated user gets a user/password
332                windoe (or not if using a domain authenticaton)
333                -->
334                <LOGIN>
335                        <GUESTUSERS>true</GUESTUSERS>
336                        <ALLOWEMAILLOGIN>false</ALLOWEMAILLOGIN>
337       
338                        <SALT>false</SALT>
339                        <BASICAUTH>false</BASICAUTH>
340       
341                        <USENTLM>false</USENTLM>
342       
343                        <USENTDOMAINAUTH>false</USENTDOMAINAUTH>
344                        <DOMAIN>CORINIS</DOMAIN>
345                        <DOMAINCONTROLLER>192.168.1.1</DOMAINCONTROLLER>
346                        <DEFAULTGROUP>ADMIN</DEFAULTGROUP>
347       
348                        <!-- if passwordreplybody is not set -> no way to retrieve the password -->
349                        <PASSWORDRETRIEVAL>true</PASSWORDRETRIEVAL>
350                        <PASSWORDREPLYNAME>noreply</PASSWORDREPLYNAME>
351                        <PASSWORDREPLYEMAIL>noreply@localhost</PASSWORDREPLYEMAIL>
352                        <PASSWORDREPLYSUBJECT>Your new password at localhost</PASSWORDREPLYSUBJECT>
353                        <!-- Use $password; in the body which will be replaced by the user's password -->
354       
355                        <PASSWORDREPLYBODY>auto</PASSWORDREPLYBODY>
356                </LOGIN>
357                <!--
358                Mailcenter Module
359               
360                The attachment dir does not have to be web accessable!
361               
362                If you specify the MAILER entry, the system will use the specified program
363                to send mails (senmail style), if this entry does not exist it will use
364                the smtp server specified.
365               
366                the maillog logs the messages sent through the mailcenter in xml format:
367                <MESSAGE>
368                        <SUBJECT>
369                        <SENDER>
370                        <RECEPIENT>
371                        <CC>
372                        <BODY>
373                </MESSAGE>
374                -->
375                <MAILCENTER>
376                        <!-- <MAILER>/usr/lib/sendmail -i -t</MAILER> -->
377                        <POP>127.0.0.1</POP>
378                        <DOMAIN>localhost</DOMAIN>
379                        <SMTP>localhost</SMTP>
380                        <LOG>auto</LOG>
381                        <ATTACHDIR>auto</ATTACHDIR>
382                </MAILCENTER>
383
384                <!--
385                Cms Module
386               
387                The upload dir has to be web accessable!
388                The uploadwebdir is the web path used when showing the documents!
389                The uploadfiledir is for download files and should therefore be at a not
390                web accessible location
391                The staticpath specifies the path where the static files are located (normally
392                the webroot). It is used for the admin filemanager and when static files from
393                the cms are created.
394                DATAFIELD specifies the content field were uploaded/parseable data is stored
395                (f.e. from a pdf, word or excel file)
396                RIGHTOVERRIDE: Allows to usage of the overriding-right request parameter (Document_right=)
397                SKIPLIFEVIEW: skip all right checking in life system
398                LINKCHECK: the time until the next linkcheck is being done (default ms, s - seconds, m - minutes, h - hours, d - days)
399                SYSTEM: Here you can set what kind of management system you want. Possible values are (you can either use then umber, or the name):
400                        - default (3): use a quality management and life system (3-step system)
401                        - noqm (2): skip the qm, documents go streight from edit to life (2-step system)
402                        - onlylife (1): there is neither a qm, nor a life system. When pressing save it's on the page
403                STATIC/PATH: Where static rendered information (xml/xhtml for cms) will be stored
404                STATIC/RENDERGROUPS: the name of groups for which static renderd pages are served (if a user is more than one group, the highed priority will be used)
405                FILEMANAGERCACHE: a directory where filemanger xml caches are stored (xml file)
406                -->
407                <CMS>
408                        <TEMPLATEPATH>auto</TEMPLATEPATH>
409                        <STATIC enable="true">
410                                <RENDERGROUPS>
411                                        <GROUP priority="1">GUEST</GROUP>
412                                </RENDERGROUPS>
413                                <PATH>auto</PATH>
414                        </STATIC>
415       
416                        <UPLOADDIR>auto</UPLOADDIR>
417                        <UPLOADWEBDIR>auto</UPLOADWEBDIR>
418                        <CACHING>false</CACHING>
419                        <SKIPLIFEVIEW>false</SKIPLIFEVIEW>
420                        <DATAFIELD>data</DATAFIELD>
421                        <RIGHTOVERRIDE>false</RIGHTOVERRIDE>
422                        <LINKCHECK>1h</LINKCHECK>
423                        <!--
424                        The Linkstyle can be any combination of path
425                        with $id replaced by the id and $path replaced
426                        by the absolute path to the document.
427                        Binary files will be automatically converted to their
428                        path
429                        If you want to use the real index.jsp for preview add
430                        &preview=true - this wil cause the cms taglib to use
431                        the edit system (if rights suffice)
432                       
433                        For multilanguage/tree stuff use $top[ID:"path"|ID2:"path2"|"defaultpath"]
434                        ie: $top[0:"en"|121423:"de"|"fr"]
435                       
436                        if you created the index.jsp with the corinis taglib you can use &amp;preview=true
437                        to enable preview mode
438                        -->
439                        <LINKSTYLE>
440                                <PREVIEW>/corinis/modules/Cms/preview.jsp?Document_id=$id</PREVIEW>
441                                <LIFE>/index.jsp?Document_id=$id</LIFE>
442                        </LINKSTYLE>
443
444                        <!--
445                        define the target for files:
446                        INTERNAL: all internally linked documents
447                        EXTERNAL: all external urls
448                        FILES: all files (internal)
449                        -->
450                        <URLTARGET>
451                                <INTERNAL />
452                                <EXTERNAL>_ext</EXTERNAL>
453                                <FILES>_blank</FILES>
454                        </URLTARGET>
455               
456                        <!-- Enable the QM System [default|fullqm] -->
457                        <SYSTEM>default</SYSTEM>
458
459                </CMS>
460
461                <!--
462                Document Manager Module
463               
464                The uploaddir points to where the files will be stored.
465                -->
466                <DOCUMENTMANAGER>
467                        <UPLOADDIR>auto</UPLOADDIR>
468                </DOCUMENTMANAGER>
469
470                <!-- 
471                Forum Module
472                SUBSCRIBEEMAIL: the email address in the sent mail
473                SUBSCRIBEHEADER: the header of the message - you can use $name; $id; $title;
474                SUBSCRIBEBODY: path to a text file to be used as body, use $name; $id; $message; $title; in there
475                if BODY is set to auto the file WEB-INF/forumsubscribe.txt will be loaded
476                -->
477                <FORUM>
478                        <SUBSCRIBEEMAIL>noreply@corinis.com</SUBSCRIBEEMAIL>
479                        <SUBSCRIBENAME>noreply</SUBSCRIBENAME>
480                        <SUBSCRIBESUBJECT>[Corinis Forum] New Forum Message: $title;</SUBSCRIBESUBJECT>
481                        <SUBSCRIBEBODY>auto</SUBSCRIBEBODY>
482                </FORUM>
483
484                <!-- Webalbum Module -->
485                <PHOTOLIBRARY>
486                        <IMAGEFOLDER>auto</IMAGEFOLDER>
487                        <IMAGEWEBURL>auto</IMAGEWEBURL>
488                </PHOTOLIBRARY>
489        </MODULES>
490</CORINIS>
Note: See TracBrowser for help on using the repository browser.