Skip to content
/ devbox Public

A full open source development stack for the ColdBox Platform.

Notifications You must be signed in to change notification settings

ColdBox/devbox

Repository files navigation

                                                                                                         
                                                          dddddddd                                                       
        CCCCCCCCCCCCC                 lllllll             d::::::dBBBBBBBBBBBBBBBBB                                      
     CCC::::::::::::C                 l:::::l             d::::::dB::::::::::::::::B                                     
   CC:::::::::::::::C                 l:::::l             d::::::dB::::::BBBBBB:::::B                                    
  C:::::CCCCCCCC::::C                 l:::::l             d:::::d BB:::::B     B:::::B                                   
 C:::::C       CCCCCC   ooooooooooo    l::::l     ddddddddd:::::d   B::::B     B:::::B   ooooooooooo xxxxxxx      xxxxxxx
C:::::C               oo:::::::::::oo  l::::l   dd::::::::::::::d   B::::B     B:::::B oo:::::::::::oox:::::x    x:::::x 
C:::::C              o:::::::::::::::o l::::l  d::::::::::::::::d   B::::BBBBBB:::::B o:::::::::::::::ox:::::x  x:::::x  
C:::::C              o:::::ooooo:::::o l::::l d:::::::ddddd:::::d   B:::::::::::::BB  o:::::ooooo:::::o x:::::xx:::::x   
C:::::C              o::::o     o::::o l::::l d::::::d    d:::::d   B::::BBBBBB:::::B o::::o     o::::o  x::::::::::x    
C:::::C              o::::o     o::::o l::::l d:::::d     d:::::d   B::::B     B:::::Bo::::o     o::::o   x::::::::x     
C:::::C              o::::o     o::::o l::::l d:::::d     d:::::d   B::::B     B:::::Bo::::o     o::::o   x::::::::x     
 C:::::C       CCCCCCo::::o     o::::o l::::l d:::::d     d:::::d   B::::B     B:::::Bo::::o     o::::o  x::::::::::x    
  C:::::CCCCCCCC::::Co:::::ooooo:::::ol::::::ld::::::ddddd::::::ddBB:::::BBBBBB::::::Bo:::::ooooo:::::o x:::::xx:::::x   
   CC:::::::::::::::Co:::::::::::::::ol::::::l d:::::::::::::::::dB:::::::::::::::::B o:::::::::::::::ox:::::x  x:::::x  
     CCC::::::::::::C oo:::::::::::oo l::::::l  d:::::::::ddd::::dB::::::::::::::::B   oo:::::::::::oox:::::x    x:::::x 
        CCCCCCCCCCCCC   ooooooooooo   llllllll   ddddddddd   dddddBBBBBBBBBBBBBBBBB      ooooooooooo xxxxxxx      xxxxxxx
                                                                                                                         
                                                                                                                         
DDDDDDDDDDDDD                                                 BBBBBBBBBBBBBBBBB                                      
D::::::::::::DDD                                              B::::::::::::::::B                                     
D:::::::::::::::DD                                            B::::::BBBBBB:::::B                                    
DDD:::::DDDDD:::::D                                           BB:::::B     B:::::B                                   
  D:::::D    D:::::D     eeeeeeeeeeee  vvvvvvv           vvvvvvvB::::B     B:::::B   ooooooooooo xxxxxxx      xxxxxxx
  D:::::D     D:::::D  ee::::::::::::ee v:::::v         v:::::v B::::B     B:::::B oo:::::::::::oox:::::x    x:::::x 
  D:::::D     D:::::D e::::::eeeee:::::eev:::::v       v:::::v  B::::BBBBBB:::::B o:::::::::::::::ox:::::x  x:::::x  
  D:::::D     D:::::De::::::e     e:::::e v:::::v     v:::::v   B:::::::::::::BB  o:::::ooooo:::::o x:::::xx:::::x   
  D:::::D     D:::::De:::::::eeeee::::::e  v:::::v   v:::::v    B::::BBBBBB:::::B o::::o     o::::o  x::::::::::x    
  D:::::D     D:::::De:::::::::::::::::e    v:::::v v:::::v     B::::B     B:::::Bo::::o     o::::o   x::::::::x     
  D:::::D     D:::::De::::::eeeeeeeeeee      v:::::v:::::v      B::::B     B:::::Bo::::o     o::::o   x::::::::x     
  D:::::D    D:::::D e:::::::e                v:::::::::v       B::::B     B:::::Bo::::o     o::::o  x::::::::::x    
DDD:::::DDDDD:::::D  e::::::::e                v:::::::v      BB:::::BBBBBB::::::Bo:::::ooooo:::::o x:::::xx:::::x   
D:::::::::::::::DD    e::::::::eeeeeeee         v:::::v       B:::::::::::::::::B o:::::::::::::::ox:::::x  x:::::x  
D::::::::::::DDD       ee:::::::::::::e          v:::v        B::::::::::::::::B   oo:::::::::::oox:::::x    x:::::x 
DDDDDDDDDDDDD            eeeeeeeeeeeeee           vvv         BBBBBBBBBBBBBBBBB      ooooooooooo xxxxxxx      xxxxxxx
                                                                                                                     
                                                                                                                     
                                                                                                                     
       
ColdBox DevBox v2.4
Copyright (c) 2012 Ortus Solutions, Corp
www.ortussolutions.com
www.coldbox.org
==============================================
This is the README file for the ColdBox DevBox
==============================================

The ColdBox DevBox is a complete development environment for your ColdBox needs.
It includes a fully configured J2EE application server, Resin 4 with Railo,
the open source CFML engine, deployed for you.  We have also installed a few nice 
plugins into your Railo Administrator for memory monitoring, scope monitor and more.

To start the DevBox:
Windows  
- Run start.exe or the setup.exe to setup with Apache or IIS

*nix/Mac 
- Make sure the files are executable, if not run: chmod -R 777 * to make files executable
- Run start.sh in the command line or in Mac run the start.app

The webroot path for your DevBox is:
/coldbox-devbox/webapps/ROOT

The ColdBox bundle has been deployed for you:
/coldbox-devbox/webapps/ROOT/coldbox

The web address for your DevBox is:
http://localhost:8081/index.cfm

The DevBox has some more applications deployed for you:
ColdBox Dashboard - http://localhost:8081/coldbox/dashboard
ColdBox API Docs - http://localhost:8081/coldbox-docs
ColdBox Samples Gallery - http://localhost:8081/coldbox/samples
ColdBox Application Templates - http://localhost:8081/coldbox/ApplicationTemplates
Coldbox Platform Utilities - /webapps/ROOT/coldbox-utilities

The web address for the Railo Administrator console is:
http://localhost:8081/railo-context/admin/server.cfm

The password for the Railo administrators are: coldbox

Questions should go to our mailing list or forums.

https://groups.google.com/forum/?fromgroups#!forum/coldbox

To change the port for the application server you must configure it
in the following file:
/coldbox-devbox/conf/resin.properties

To add more hostnames to different directories you can configur it in the: 'resin.xml'
Just look for the <host> element(s) and add your own host element:

<host id="www.coldbox.org" root-directory=".">
  <web-app id="/" root-directory="webapps/mysite">
  </web-app>
</host>

==============================================
ChangeLog
==============================================
Version 2.4
# Updated railo engine
# Updated to ColdBox 3.7.0

Version 2.3
# Updated railo engine
# Updated to ColdBox 3.6.0

Version 2.2
# Updated engine to Railo 4 final

Version 2.1
# Fixes on distributed ColdBox version

Version 2.0 
# Updated all libraries to use Railo 4 Beta
# Updated resin logging

Version 1.0 
# Initial release

============================================================================================
============================================================================================

RESIN Documentation
==============================================
The documentation included with Resin is in XTP format starting at
http://localhost:8081/resin-doc/index.xtp.

For more information about configuring Resin, the full documentation is
also available online at:

  http://www.caucho.com/resin-4.0/


I) Licensing/Support
--------------------

For pricing and licensing information for Resin 4.0 Professional,
see http://www.caucho.com/resin/sales.  Resin Professional contains
additional performance and reliability features beyond the Resin Open
Source version.

Resin 4.0 Open Source is released under the GPL.

Resin licenses do not include technical support. However, we offer several
technical support options to fit your support and budget needs.

  http://www.caucho.com/resin/sales  -- licenses and support


II) Preconditions
-----------------

  1) Resin needs a Java JDK before it can run.  Resin 4.0 works with 
     JDK 1.6 or greater.

     Some locations for JDKs include:

     Oracle:
       http://www.oracle.com/technetwork/java/javase/downloads/index.html

  2) On Windows, you'll need an unzip tool available at http://www.winzip.com
 
  3) A HTML 5 browser is needed for some features of the /resin-admin tool.

III) Getting Started
--------------------

The included HTTP/1.1 server makes it easy to evaluate Resin, JSP
and servlets.  Just start it up.  The default configuration
file is found in resin-4.0.x/conf/resin.xml.

  1) On Unix, you'll want to build the JNI libraries:

     resin-4.0.x> ./configure --prefix=`pwd`
     resin-4.0.x> make
     resin-4.0.x> make install

  2) To start the server:

       unix> bin/resin.sh start

     or

       C:\> java -jar lib/resin.jar start

     The server listens to port 8081.  Port 8081 is the default specified
     in the configuration file resin-4.0.x/conf/resin.xml

     Log files are in resin-4.0.x/log

  3) Usually, Resin can find the JDK, but you may need to set JAVA_HOME in some
     configurations. 

     Starting Resin with -verbose is a great way to see what environment
     Resin is running.

  4) Browse http://localhost:8081 or equivalently http://127.0.0.1:8081.

  5) Go through the documentation at http://localhost:8081/resin-doc


IV) Application Deployment
--------------------------

  1) You can use the command-line to deploy a .war file:
  
       unix> bin/resin.sh deploy foo.war

  2) You can also copy the war file to the webapps directory.

     To deploy a war file, place the file in resin-4.0.x/webapps/foo.war
     Resin will expand the war file, and the application will be available
     with the url http://localhost:8081/foo/

  3) Resin supports the development of applications without requiring a war
     file deployment.  Create a directory resin-4.0.x/webapps/bar to
     correspond to url http://localhost:8081/bar/.  Java source files
     placed in resin-4.0.x/webapps/bar/WEB-INF/classes/ are automatically 
     compiled by Resin.

     resin-4.0.x/webapps/bar/index.jsp
       --> http://localhost:8081/bar/
       --> http://localhost:8081/bar/index.jsp

    resin-4.0.x/webapps/bar/WEB-INF/web.xml
       -- servlet/jsp configuration file

    resin-4.0.x/webapps/bar/WEB-INF/resin-web.xml
       -- Resin specific configuration

    resin-4.0.x/webapps/bar/WEB-INF/classes/example/HelloServlet.java
       -- java source file, automatically compiled by Resin
     
  4) For PHP, create test.php in resin-4.0.x/webapps/ROOT/test.php and browse
     http://localhost:8081/test.php.


IV) PDF Reports
---------------

  With Resin-Pro, you can get a PDF snapshot report of the server with the
  command-line:

    unix> bin/resin.sh pdf-report

  You can also get a watchdog restart report with the -watchdog option
  
    unix> bin/resin.sh pdf-report -watchdog

    
V) /resin-admin browser-based administration
--------------------------------------------

  An administration application is available at

     http://localhost:8081/resin-admin

  Instructions are provided for setting a password.