Revision as of 21:37, 1 April 2011

This article describes how to install CKFinder for Java.

Installation Procedure

To install CKFinder, download the CKFinder for Java distribution package (a .war file) from the official download site (Note: the official release is not yet available). You will need to deploy this file to your Java server and run as an application. For detailed instructions on how to run CKFinder on one of the most popular Java servers refer to an appropriate section below.

Running the Sample Application

A test application is available in the _samples folder of the distribution package. After the deployment open the _samples/index.html page in your Web browser to see a few usage scenarios for CKFinder.

Basic Configuration

When your application works correctly in the browser, it is time to review its configuration. Go to the config.xml file where you can customize your application. See the Configuration section for more information about the CKFinder configuration.

Please note that due to security reasons by default CKFinder is disabled. When you reviewed the settings and are ready to go, open the configuration file and enable the program.

<enabled>true</enabled>

For more security tips please refer to the Security section.

Deployment on a Server

For detailed instructions on how to deploy CKFinder for Java to one of the supported servers, please refer to an appropriate section below.

Tomcat

Place the CKFinder Java .war file in the Tomcat webapps folder. Go to Tomcat bin folder and run the startup script file for your operating system — startup.bat for Windows or startup.sh for Linux. When you are running Tomcat as a service, restart the server.

By default Tomcat has the autoDeploy="true" option enabled (check the Host element in the server.xml file). If this option was not changed, running the application should also be possible after you copy it to the webapps folder without stopping the server.

By deafult, the application should be available under the following URL in your browser: http://localhost:8080/CKFinderJava-2.0/

Please note that the HTTP 8080 port of the sample URL is the default Tomcat port. If you changed this value while configuring your Tomcat installation, you will need to use a modified port value to run the sample application.

Jetty

Place the CKFinder Java .war file in the Jetty webapps folder. In the command line go to the root of the Jetty server and start it with a java -jar start.jar command.

By deafult, the application should be available under the following URL in your browser: http://localhost:8080/CKFinderJava-2.0/

Please note that the HTTP 8080 port of the sample URL is the default Jetty port. If you changed this value while configuring your Jetty installation, you will need to use a modified port value to run the sample application.

Go to the Jetty Quick Start guide for more information about using this server.

JBoss

The server can be started from the command line. Go to the JBoss bin folder and run the following command:

• Windows: run.bat -c all
• Linux: run -c all

After the server was started, go to the Web Application (WAR)s menu and click the Add new resource button. In the Add New Web Application (WAR) window specify the path to CKFinder Java .war file, and check the following option:

• Deploy Exploded – for most usage scenarios,
• Deploy Farm – when the server works in a cluster.

The application will be deployed after you click the Continue button.

By deafult, the application should be available under the following URL in your browser: http://localhost:8080/CKFinderJava-2.0/

Please note that the HTTP 8080 port of the sample URL is the default JBoss port. If you changed this value while configuring your JBoss installation, you will need to use a modified port value to run the sample application.

Go to the JBoss AS6 Documentation site for more information about using this server.

GlassFish

The GlassFish server can be started from the command line. Go to the server bin folder and run the asadmin script. Next you need to start the domain which is a pre-requisite to upload the application or use the administrator's console. In this example we are going to use the test domain that is deployed with the servr. Run the start-domain command to start it.

The application can be uploaded to the server by using the command line or the administrator's console.

When using the command line, run the following:

deploy relativePath/CKFinderJava-2.0.war

Please note that the path to the CKFinder Java .war file is relative to the asadmin script that is located in the bin folder of GlassFish.

When using the administrator's console, log in and go to the Applications tab. Specify the location of the CKFinder Java .war file and set the application type to Web Application.

By deafult, the application should be available under the following URL in your browser: http://localhost:8080/CKFinderJava-2.0/

Please note that the HTTP 8080 port of the sample URL is the default GlassFish port. If you changed this value while configuring your GlassFish installation, you will need to use a modified port value to run the sample application.

Go to the Oracle GlassFish Server Quick Start Guide for more information about using this server.