root/coldbox/trunk/ApplicationTemplate/config/coldbox.xml.cfm @ 1839

Revision 1839, 13.4 kB (checked in by lmajano, 5 years ago)

More updates to Application Template

Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<Config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3        xsi:noNamespaceSchemaLocation="http://www.coldboxframework.com/schema/config_2.6.0.xsd">
4        <Settings>
5                <!--The name of your application.-->
6                <Setting name="AppName"                                         value="Your App Name here"/>
7                <!-- ColdBox set-up information for J2EE installation.
8                     As context-root are actually virtual locations which does not correspond to physical location of files. for example
9                     /openbd   /var/www/html/tomcat/deploy/bluedragon
10
11                     AppMapping setting will adjust physical location of Project/App files and coldbox will load handlers,plugis,config file etc
12                     Create a cf mapping and enable this value.
13                     /MyApp /var/www/html/tomcat/deploy/bluedragon/MyAppFolder
14               
15                If you are using a coldbox app to power flex/remote apps, you NEED to set the AppMapping also. In Summary,
16                the AppMapping is either a CF mapping or the path from the webroot to this application root. If this setting
17                is not set, then coldbox will try to auto-calculate it for you. Please read the docs.
18               
19                <Setting name="AppMapping"                                      value="/MyApp"/>     
20               
21                -->
22                <!--Default Debugmode boolean flag (Set to false in production environments)-->
23                <Setting name="DebugMode"                                       value="true" />
24                <!--The Debug Password to use in order to activate/deactivate debugmode,activated by url actions -->
25                <Setting name="DebugPassword"                           value=""/>
26                <!--The fwreinit password to use in order to reinitialize the framework and application.Optional, else leave blank -->
27                <Setting name="ReinitPassword"                          value=""/>
28                <!--Default event name variable to use in URL/FORM etc. -->
29                <Setting name="EventName"                                       value="event" />
30                <!--This feature is enabled by default to permit the url dumpvar parameter-->
31                <Setting name="EnableDumpVar"                           value="true" />
32                <!--Log Errors and entries on the coldfusion server logs, disabled by default if not used-->
33                <Setting name="EnableColdfusionLogging"         value="false" />
34                <!--Log Errors and entries in ColdBox's own logging facilities. You choose the location, finally per application logging.-->
35                <Setting name="EnableColdboxLogging"            value="true" />
36                <!--The absolute or relative path to where you want to store your log files for this application-->
37                <Setting name="ColdboxLogsLocation"                     value="logs" />
38                <!--Default Event to run if no event is set or passed. Usually the event to be fired first (NOTE: use event handler syntax)-->
39                <Setting name="DefaultEvent"                            value="general.index"/>
40                <!--Event Handler to run on the start of a request, leave blank if not used. Emulates the Application.cfc onRequestStart method -->
41                <Setting name="RequestStartHandler"             value="main.onRequestStart"/>
42                <!--Event Handler to run at end of all requests, leave blank if not used. Emulates the Application.cfc onRequestEnd method-->
43                <Setting name="RequestEndHandler"                       value="main.onRequestEnd"/>
44                <!--Event Handler to run at the start of an application, leave blank if not used. Emulates the Application.cfc onApplicationStart method        -->
45                <Setting name="ApplicationStartHandler"         value="main.onAppInit"/>
46                <!--Event Handler to run at the start of a session, leave blank if not used.-->
47                <Setting name="SessionStartHandler"             value="main.onSessionStart"/>
48                <!--Event Handler to run at the end of a session, leave blank if not used.-->
49                <Setting name="SessionEndHandler"                       value="main.onSessionEnd"/>
50                <!--The event handler to execute on all framework exceptions. Event Handler syntax required.-->
51                <Setting name="ExceptionHandler"                        value="" />
52                <!--What event to fire when an invalid event is detected-->
53                <Setting name="onInvalidEvent"                          value="" />
54                <!--Full path from the application's root to your custom error page, else leave blank. -->
55                <Setting name="CustomErrorTemplate"                     value="" />
56                <!--The Email address from which all outgoing framework emails will be sent. -->
57                <Setting name="OwnerEmail"                                      value="myemail@gmail.com" />
58                <!-- Enable Bug Reports to be emailed out, set to true by default if left blank
59                        A sample template has been provided to you in includes/generic_error.cfm
60                 -->
61                <Setting name="EnableBugReports"                        value="true"/>
62                <!--UDF Library To Load on every request for your views and handlers -->
63                <Setting name="UDFLibraryFile"                          value="includes/helpers/ApplicationHelper.cfm" />
64                <!--Messagebox Style Override. A boolean of wether to override the styles using your own css.-->
65                <Setting name="MessageboxStyleOverride"         value="" />
66                <!--Flag to Auto reload the internal handlers directory listing. False for production. -->
67                <Setting name="HandlersIndexAutoReload"         value="true" />
68                <!--Flag to auto reload the config.xml settings. False for production. -->
69                <Setting name="ConfigAutoReload"                value="false" />
70                <!-- Declare the custom plugins base invocation path, if used. You have to use dot notation.Example: mymapping.myplugins        -->
71                <Setting name="MyPluginsLocation"               value="" />
72                <!-- Declare the external views location. It can be relative to this app or external. This in turn is used to do cfincludes. -->
73                <Setting name="ViewsExternalLocation"           value=""/>
74                <!-- Declare the external handlers base invocation path, if used. You have to use dot notation.Example: mymapping.myhandlers    -->
75                <Setting name="HandlersExternalLocation"        value="" />
76                <!--Flag to cache handlers. Default if left blank is true. -->
77                <Setting name="HandlerCaching"                          value="false"/>
78                <!--Flag to cache events if metadata declared. Default is true -->
79                <Setting name="EventCaching"                            value="false"/>
80                <!--IOC Framework if Used, else leave blank-->
81                <Setting name="IOCFramework"                            value="" />
82                <!--IOC Definition File Path, relative or absolute -->
83                <Setting name="IOCDefinitionFile"                       value="" />
84                <!--IOC Object Caching, true/false. For ColdBox to cache your IoC beans-->
85                <Setting name="IOCObjectCaching"                        value="false" />
86                <!--Request Context Decorator, leave blank if not using. Full instantiation path -->
87                <Setting name="RequestContextDecorator"         value=""/>
88                <!--Flag if the proxy returns the entire request collection or what the event handlers return, default is false -->
89                <Setting name="ProxyReturnCollection"           value="false"/>
90                <!-- What scope are flash persistance variables using. -->
91                <Setting name="FlashURLPersistScope"            value="session"/>
92        </Settings>
93
94        <!-- Your Settings can go here, if not needed, use <YourSettings />. You can use these for anything you like.
95                <YourSettings>
96                        <Setting name="MySetting" value="My Value"/>
97                       
98                        whether to encrypt the values or not
99                        <Setting name="cookiestorage_encryption" value="true"/>
100                       
101                        The encryption seed to use. Else, use a default one (Not Recommened)
102                        <Setting name="cookiestorage_encryption_seed" value="mykey"/>
103                       
104                        The encryption algorithm to use (According to CFML Engine)
105                        <Setting name="cookiestorage_encryption_algorithm" value="CFMX_COMPAT or BD_DEFAULT"/>
106                       
107                        Messagebox Plugin (You can now override the storage scope without affecting all framework applications)
108                        <Setting name="messagebox_storage_scope" value="session or client" />
109                       
110                        Complex Settings follow JSON Syntax. www.json.org. 
111                        *IMPORTANT: use single quotes in this xml file for JSON notation, ColdBox will translate it to double quotes.
112                </YourSettings>
113         -->
114        <YourSettings>
115                <!-- Show SideBar? true/false, else leave blank. -->
116                <Setting name="ColdBoxSideBar" value="true" />
117        </YourSettings>
118       
119        <!-- Custom Conventions : You can override the framework wide conventions of the locations of the needed objects
120        <Conventions>
121                <handlersLocation></handlersLocation>
122                <pluginsLocation></pluginsLocation>
123                <layoutsLocation></layoutsLocation>
124                <viewsLocation></viewsLocation>
125                <eventAction></eventAction>             
126        </Conventions> 
127        -->
128       
129        <!--
130        Control the ColdBox Debugger. The panels are self explanatory. The other settings are explained below.
131        PersistentRequestProfiler : Activate the event profiler across multiple requests
132        maxPersistentRequestProfilers : Max records to keep in the profiler. Don't get gready.
133        maxRCPanelQueryRows : If a query is dumped in the RC panel, it will be truncated to this many rows.
134       
135        <DebuggerSettings>
136                <PersistentRequestProfiler>true</PersistentRequestProfiler>
137                <maxPersistentRequestProfilers>10</maxPersistentRequestProfilers>
138                <maxRCPanelQueryRows>50</maxRCPanelQueryRows>
139               
140                <TracerPanel    show="true" expanded="true" />
141                <InfoPanel              show="true" expanded="true" />
142                <CachePanel     show="true" expanded="false" />
143                <RCPanel                show="true" expanded="false" />
144        </DebuggerSettings>
145        -->
146       
147        <!--Optional,if blank it will use the CFMX administrator settings.-->
148        <MailServerSettings>
149                <MailServer></MailServer>
150                <MailPort></MailPort>
151                <MailUsername></MailUsername>
152                <MailPassword></MailPassword>
153        </MailServerSettings>
154
155        <!--Emails to Send bug reports, you can create as many as you like -->
156        <BugTracerReports>
157                <!-- <BugEmail>myemail@gmail.com</BugEmail> -->
158        </BugTracerReports>
159       
160        <!--Webservice declarations your use in your application, if not use, leave blank
161        Note that for the same webservice name you can have a development url and a production url.-->
162        <WebServices>
163                <!-- <WebService name="TESTWS1" URL="http://www.test.com/test1.cfc?wsdl" DevURL="http://dev.test.com/test1.cfc?wsdl" /> -->
164                <!-- <WebService name="TESTWS2" URL="http://www.test.com/test2.cfc?wsdl" DevURL="http://dev.test.com/test2.cfc?wsdl" /> -->
165        </WebServices>
166
167        <!--Declare Layouts for your application here-->
168        <Layouts>
169                <!--Declare the default layout, MANDATORY-->
170                <DefaultLayout>Layout.Main.cfm</DefaultLayout>
171               
172                <!--Default View, OPTIONAL
173                <DefaultView>home</DefaultView>
174                -->
175               
176                <!--
177                Declare other layouts, with view/folder assignments if needed, else do not write them
178                <Layout file="Layout.Popup.cfm" name="popup">
179                        <View>vwTest</View>
180                        <View>vwMyView</View>
181                        <Folder>tags</Folder>
182                </Layout>
183                -->
184        </Layouts>
185
186        <!--Internationalization and resource Bundle setup:
187        <i18N>
188                <DefaultResourceBundle>includes/main</DefaultResourceBundle>
189                <DefaultLocale>en_US</DefaultLocale>
190                <LocaleStorage>session</LocaleStorage>
191                <UknownTranslation></UknownTranslation>
192        </i18N>
193        -->
194        <i18N />
195       
196        <!--Datasource Setup, you can then retreive a datasourceBean via the getDatasource("name") method: -->
197        <Datasources>
198                <!-- <Datasource alias="MyDSNAlias" name="real_dsn_name"   dbtype="mysql"  username="" password="" /> -->
199        </Datasources>
200       
201        <!--ColdBox Object Caching Settings Overrides the Framework-wide settings
202        <Cache>
203                <ObjectDefaultTimeout>60</ObjectDefaultTimeout>
204                <ObjectDefaultLastAccessTimeout>30</ObjectDefaultLastAccessTimeout>
205                <UseLastAccessTimeouts>true</UseLastAccessTimeouts>
206                <ReapFrequency>1</ReapFrequency>
207                <MaxObjects>100</MaxObjects>
208                <FreeMemoryPercentageThreshold>1</FreeMemoryPercentageThreshold>
209                <EvictionPolicy>LRU</EvictionPolicy>
210        </Cache>
211        -->
212       
213        <!-- Interceptor Declarations
214        <Interceptors throwOnInvalidStates="true">
215                <CustomInterceptionPoints>comma-delimited list</CustomInterceptionPoints>
216                <Interceptor class="full class name">
217                        <Property name="myProp">value</Property>
218                        <Property name="myArray">[1,2,3]</Property>
219                        <Property name="myStruct">{ key1:1, key2:2 }</Property>
220                </Inteceptor>
221                <Interceptor class="no property" />
222        </Interceptors>
223        -->
224       
225        <Interceptors>
226                <!-- USE ENVIRONMENT CONTROL -->
227                <Interceptor class="coldbox.system.interceptors.environment">
228                        <Property name='configFile'>config/environments.xml.cfm</Property>
229                </Interceptor>
230                <!-- USE SES -->
231                <Interceptor class="coldbox.system.interceptors.ses">
232                        <Property name="configFile">config/routes.cfm</Property>
233                </Interceptor>
234               
235                <!-- Developer's ColdBox Sidebar -->
236                <Interceptor class="coldbox.system.interceptors.coldboxSideBar">
237                        <!-- Y offset: number, else leave blank -->
238                        <Property name="yOffset"></Property>
239                        <!-- Scroll: true/false, else leave blank -->
240                        <Property name="isScroll"></Property>
241                        <!-- Slide Speed: number, else leave blank -->
242                        <Property name="slideSpeed"></Property>
243                        <!-- Wait time before closing: number, else leave blank -->
244                        <Property name="waitTimeBeforeClose"></Property>
245                        <!-- Links (JSON array of objects), else leave blank
246                        e.g.
247                                [
248                                {"desc":"ColdBox API","href":"http:\/\/www.coldboxframework.com\/api\/"}
249                                ,{"desc":"ColdBox Credits","href":"http:\/\/ortus.svnrepository.com\/coldbox\/trac.cgi\/wiki\/cbCredits"}
250                                ,{"desc":"ColdBox SideBar Help","href":"http:\/\/ortus.svnrepository.com\/coldbox\/trac.cgi\/wiki\/cbSideBar"}
251                                ,{"desc":"Transfer Docs","href":"http:\/\/docs.transfer-orm.com\/"}
252                                ,{"desc":"My API","href":"http:\/\/localhost\/myApi/"}
253                                ,{"desc":"My Database Schema","href":"http:\/\/localhost\/myDatabaseSchema.pdf"}
254                                ]                       
255                         -->
256                        <Property name="links"></Property>
257                        <!-- Width of the sidebar including visible width, else leave blank -->
258                        <Property name="width"></Property>
259                        <!-- Visible width, else leave blank  -->
260                        <Property name="visibleWidth"></Property>
261                        <!--Full path from the application's root, else leave blank. -->
262                        <Property name="imagePath"></Property>
263                        <!-- Vertical alignment of the image: top,middle or bottom, else leave blank  -->
264                        <Property name="imageVAlign"></Property>
265                        <!--Full path from the application's root, else leave blank -->
266                        <Property name="cssPath"></Property>
267                </Interceptor>
268        </Interceptors>
269       
270</Config>
Note: See TracBrowser for help on using the browser.