CKSource Docs - User contributions [en]

Template:Drupal OS CKFinder

2018-09-19T12:08:22Z

J.swiderski:

CKFinder is an Ajax-based file manager created by CKEditor developers: http://ckfinder.com/. CKFinder support is already built into the CKEditor for Drupal module, but due to licensing issues you need to buy it separately, add the files to your Drupal site and then enable the file browser.

<note>The instructions below are valid for '''CKFinder 2.x only'''.</note>

<note>If you are looking for a simplified solution, try the [http://ckeditor.com/ckeditor-for-drupal Enterprise version of the module] that comes with a CKFinder license and the file browser already included in the module and working out-of-the-box. The Enterprise version of the component also includes professional assistance from the original CKEditor development team in the form of a '''dedicated e-mail support channel'''.</note>

If you want to install CKFinder on your Drupal {{{version}}} site, follow the steps described below.

First of all, download '''CKFinder for PHP''' from the [http://ckfinder.com/download official CKFinder website].

Unpack the contents of the installation package into the directory that contains the CKEditor module and place it in the <code>sites/all/modules/ckeditor/ckfinder</code> (or <code>sites/all/libraries/ckfinder</code>) folder. . When the files are unpacked, you should see the following file structure inside the <code>drupal/sites/all/modules</code> directory:
<source>
modules <dir>
ckeditor <dir>
ckeditor.css
ckeditor.info
...
ckeditor <dir>
_samples <dir>
_source <dir>
adapters <dir>
images <dir>
...
ckeditor.js
...
ckfinder <dir>
_samples <dir>
core <dir>
...
ckfinder.js
ckfinder.php
...
</source>

You will now need to grant the '''"{{{permission}}}"''' permission in the '''Administration panel''' > '''{{{path1}}}''' > '''Permissions''' section. Note: if you do not see this permission, it means that CKEditor did not find CKFinder and you have probably uploaded CKFinder into a wrong directory.

[[Image:Drupal_{{{version}}}_Enterprise_CKFinder_permission.png|frame|center|Granting CKFinder access permission in the Drupal Administration panel]]

Now open the CKFinder configuration file (<code>ckfinder/config.php</code>) and introduce the code changes described below.

Firstly, remove the <code>CheckAuthentication()</code> function (do not worry, this function is defined in <code>filemanager.config.php</code>, see below):
<source lang="php">
function CheckAuthentication() <- remove it
{ <- remove it
//WARNING : DO NOT simply... <- remove it
... <- remove it
return false; <- remove it
} <- remove it
</source>
For CKFinder installed in the <code>sites/all/modules/ckeditor/ckfinder</code> directory add:
<source lang="php">
require_once '../../../../includes/filemanager.config.php';
</source>
straight below the following line:
<source lang="php">
$baseDir = resolveUrl($baseUrl);
</source>
For CKFinder installed in the <code>sites/all/libraries/ckfinder</code> directory add:
<source lang="php">
require_once '../../../../../modules/ckeditor/includes/filemanager.config.php';
</source>
straight below the following line:
<source lang="php">
$baseDir = resolveUrl($baseUrl);
</source>

Now open the Drupal settings file (<code>sites/default/settings.php</code>) and do the following:
* Uncomment the <code>$base_url</code> variable and set the base URL of your website (without the trailing slash).
* Uncomment the <code>$cookie_domain</code> variable and set the domain name of your website.

Select CKFinder as a preferred file browser in the '''Administration panel''' > '''{{{path2}}}''' > '''CKEditor''' section (for a selected CKEditor profile scroll down to the '''File browser settings''' section).

[[Image:Drupal_{{{version}}}_OS_enable_CKFinder.png|frame|center|Selecting CKFinder as a preferred file browser in the Drupal Administration panel]]

You can now [[CKEditor_for_Drupal/Open Source/Drupal_{{{version}}}/Configuration|configure]] CKFinder settings in the '''File browser settings''' section for the CKEditor profile that you want to use. You may also change destination folders for files uploaded with CKFinder.

CKFinder 2.x/Developers Guide/ASP/Troubleshooting

2018-08-27T10:32:31Z

J.swiderski:

If you are unable to quickly setup CKFinder for ASP, you can use a [http://cksource.com/forums/viewtopic.php?f=10&t=13604 wizard script] as explained in the community forums (the wizard can also be found on [https://gitlab.com/AlfonsoML/ckfinder-for-asp-wizard Github]). This script should be able to tell you exactly the steps to follow in your configuration or your server and get CKFinder working in just a matter of minutes.

The script might point you to this pages in order to get extended information about some common problems. This is a list of articles aimed to help you fix any problems while setting up your CKFinder for ASP installation.

* [[CKFinder_2.x/Developers Guide/ASP/Troubleshooting/ParentPath|"ASP 0131" Error – not being able to use relative paths]]
* [[CKFinder_2.x/Developers Guide/ASP/Troubleshooting/UploadSize|Adjusting maximum upload size]]
* [[CKFinder_2.x/Developers Guide/ASP/Troubleshooting/Windows_Authentication|Using CKFinder with Windows Authentication]]

CKFinder 2.x/Developers Guide/Java/System Requirements

2015-12-04T11:07:57Z

J.swiderski:

{{Ckfinder_2.x Requirements Description}}

== Server ==
Minimum CKFinder requirements for Java:
* JRE 1.6 and a Servlet 2.5/JSP 2.1 compliant server.
<note>The requirement of JDK or JRE is dependent on the particular application server itself. Some servers like Apache Tomcat require JRE and others like GlassFish or JBOSS require JDK. While JRE is the minimum requirement that will work with some servers, JDK is the recommended requirement which will work with all the servers.</note>

CKFinder 2.x/Developers Guide/Java/System Requirements

2015-12-04T10:47:13Z

J.swiderski:

{{Ckfinder_2.x Requirements Description}}

== Server ==
Minimum CKFinder requirements for Java:
* JRE 1.6 and a Servlet 2.5/JSP 2.1 compliant server.

CKFinder 2.x/Developers Guide/Java/Configuration/baseURL and baseDir

2015-11-29T20:54:06Z

J.swiderski:

{{#CUSTOMTITLE:baseDir and baseURL Parameters Explained}}
__TOC__
Both <code>baseDir</code> and <code>baseURL</code> should point to the same location on the server — the <code>userfiles</code> directory that contains all user files uploaded with CKFinder. The difference between them is as follows:
* <code>baseURL</code> gives a full URL to the <code>userfiles</code> directory or a path that is ''relative'' to the domain. For example:
*; <source lang="xml"><baseURL>http://example.com/CKFinderJava/userfiles/</baseURL></source>
*; <source lang="xml"><baseURL>/CKFinderJava/userfiles/</baseURL></source>
* <code>baseDir</code> gives an ''absolute'' path to the directory on the server (a physical machine). For example:
*; <source lang="xml"><baseDir>/usr/tomcat/webapps/CKFinderJava/userfiles/</baseDir></source>
*; <source lang="xml"><baseDir>C:\tomcat\webapps\CKFinderJava\userfiles\</baseDir></source>

You may ask: why use two paths to point to one location?

The <code>baseURL</code> parameter represents the path that is used by HTTP clients. It is employed for example when CKFinder returns the URL addresses of the files.

CKFinder itself is not an HTTP client, but an application that operates on server-based files that needs absolute paths to these files to operate correctly. A specific server configuration may sometimes lead to problems with setting the absolute path based on the <code>baseURL</code> parameter, which leads to the malfunctioning of the application. This is where the <code>baseDir</code> parameter that contains the direct path to the <code>userfiles</code> directory may help.

== Misconfiguration of baseURL and baseDir ==
Since setting the parameters may sometimes seem counter-intuitive, especially for the beginners, here are a couple of examples of CKFinder misconfiguration, i.e. the situation where the <code>baseURL</code> and <code>baseDir</code> settings were wrong.

=== Example 1: Using a Relative Path for baseDir ===
<source lang="xml">

<baseDir>/userfiles/</baseDir>
<baseURL>/CKFinderJava/userfiles/</baseURL>
</source>

In this example the <code>baseDir</code> parameter contains the relative (and not absolute) path to the <code>userfiles</code> directory. In a Windows system with this configuration the <code>userfiles</code> directory will be created on the same partition that hosts the server (for example, <code>C:\userfiles</code>). On a Linux machine the system will try to create a <code>/userfiles/</code> directory which will probably fail due to missing server permissions to create new directories in <code>/</code>.

=== Example 2: Incoherent Directory Paths ===
<source lang="xml">

<baseDir>C:\userfiles</baseDir>
<baseURL>/CKFinderJava/userfiles/</baseURL>
</source>

In this example <code>baseDir</code> is set to an absolute path, but the parameter points to a different location than <code>baseURL</code> that is set relative to the application root.

=== Result: CKFinder Misconfiguration ===
In both examples the parameters point to different server directories. As a result, some CKFinder features may not work correctly. The '''View''' function, for example, will be one of them.

Why is that so?

As mentioned above, CKFinder works on files and for this it uses the <code>baseDir</code> parameter value. All uploaded files will thus be placed in the location that is set in this parameter. HTTP clients, on the other hand, will use the <code>baseURL</code> value, but in both examples presented above this parameter will point to a non-existent location which in some cases may lead to a lack of access to files.

== BaseDir and BaseUrl best practice ==
<note>It is always recommended to set both <code>baseUrl</code> and <code>baseDir</code> so that they point to same location which is outside of an application directory.</note>

In previous section, we have seen what problems we may get when these two properties are misconfigured but what will happen when only <code>baseUrl</code> is set? CKFinder needs both, <code>baseUrl</code> and <code>baseDir</code> to work correctly and if <code>baseDir</code> is missing, CKFinder will try to determine its value based on the <code>baseUrl</code> property. You must know however that CKFinder has limited capabilities in this case. To be more precise, CKFinder is mainly limited to application context (application main directory).
Let’s have a look at few examples:
<source lang="xml">
<baseURL>/userfiles/</baseURL>
<baseDir></baseDir>

<baseURL>http://example.com/userfiles/</baseURL>
<baseDir></baseDir>
</source>

In both above cases the <code>userfiles</code> folder points to server’s main applications directory. When multiple applications are kept on server they are accessible like <code><nowiki>http://example.com/CKFinderJava-2.5</nowiki></code> or <code><nowiki>http://example.com/CKFinderJava-2.4</nowiki></code>. As you can probably see the <code>userfiles</code> folder should be created on same level as applications in order to be accessible through HTTP. The problem is that applications folder is not accessible from the web. There are however two servers which have general accessible folders and to which CKFinder can get. These servers are Apache Tomcat and Oracle GlassFish. Having configuration like presented above, starting from CKFinder 2.5.1, CKFinder will create <code>userfiles</code> folder in <code>TOMCAT_HOME/webapps/ROOT</code> directory for Apache Tomcat and <code>GLASSFISH_HOME/glassfish/domains/domain_name/docroot </code> directory for Oracle GlassFish. Everything will work as expected in this case. For other supported servers, CKFinder will use fallback approach and create <code>userfiles</code> folder inside <code>CKFinderJava</code> application directory. As you probably know, this will unfortunately result in View option not working properly.

Let’s take a look at another example:
<source lang="xml">
<baseURL>/CKFinderJava/userfiles/</baseURL>
<baseDir></baseDir>
</source>

Above setting will create <code>userfiles</code> inside <code>CKFinderJava</code> application directory. Although such configuration will work on every server there is a caveat to that approach. It isn’t recommended to put folder for uploaded files into deployed application folder because with every redeployment (e.g. when upgrading <code>war</code> to new version) of the application, the upload folder will be removed.
So, what should be done to set <code>baseUrl</code> and <code>baseDir</code> correctly? 

<note>
First of all you should set both properties so that they point to same location which is accessible through <code>HTTP</code> and from <code> the file system</code>. Second, you should set these properties to point to location outside of CKFinder application folder.</note>

One solution is using [https://en.wikipedia.org/wiki/Symbolic_link symlinks]. The <code>userfiles</code> folder located inside application context can be a symbolic link to some other directory on the disk. With that simple approach <code>/CKFinderJava/userfiles/</code> can point to folder of your choice. One downside of this technique is that you have to recreate the symbolic link with every application redeploy as the symlink gets removed on redeployment.

Another solution is using server features. Most of the servers provide "virtual directory" mechanism. A "Virtual Directory" allows accessing through <code>HTTP</code> a folder which can be located even outside of the server. In Tomcat 7-8 this can be done through aliases, in Tomcat 6 by adding another context to <code>server.xml</code>, in GlassFish through alternate docroots, in Jetty by adding another context to <code>jetty.xml</code>, in Weblogic through virtual directories, in WildFly by adding extra entries to <code>urn:jboss:domain:undertow</code> <code>subsystem</code> element in one of configuration files e.g. standalone.xml and in JBOSS EAP by allowing symlinks for particular external folder in <code>jboss-web.xml</code> file and then making that symlink. 

Let’s have a look at an example for Apache Tomcat 8. The server is installed in <code>C:/Apache-Tomcat-8/</code> directory, CKFinderJava is installed in <code>C:/Apache-Tomcat-8/CKFinderJava</code>, we want to have our <code>userfiles</code> folder located directly on <code>C</code> drive and we want that folder to be called <code>"myimages"</code>. Here are the settings that will allow having all CKFinder features working, and <code>userfiles</code> folder not being removed with every redeployment of the application:

CKFinder config.xml settings:
<source lang="xml">
<baseDir>C:/myimages</baseDir>
<baseURL>/CKFinderJava/userfiles/</baseURL>
</source>

CKFinderJava/META-INF/context.xaml settings:
<source lang="xml">
<Context antiJARLocking="true" path="/CKFinderJava" reloadable="true" >
<Resources>
<PreResources base="C://myimages" className="org.apache.catalina.webresources.DirResourceSet" webAppMount="/userfiles" />
</Resources>
<Valve className="org.apache.catalina.valves.RemoteAddrValve" allow=".*" />
</Context>
</source>
With the help of the server and two configuration changes, you can have your files being saved to <code>C:/myimages</code> folder. It’s also worth mentioning that <code>myimages</code> directory is invisible to end user and Tomcat serves files as if they really were located inside <code> CKFinderJava/userfiles/</code>.

CKFinder 2.x/Developers Guide/Java/Configuration/URI Encoding

2015-11-19T22:51:36Z

J.swiderski:

By default some servers use the ISO-8859-1 encoding for request parameters and request body. What is more, changing the encoding for request body on such servers has no influence on the encoding of the request parameters. This may cause problems if you want to use international file names with '''CKFinder which expects request body and parameters to be encoded in UTF-8'''. To overcome this issue you can either set UTF-8 URI encoding on the server or if you do not have enough privileges to do that, you can adjust CKFinder to use same URI encoding as your server. 
You will find more detailed instructions below.

===GlassFish 3.0===
According to Glassfish 3.0 [http://docs.oracle.com/cd/E19798-01/821-1752/beafu/index.html documentation] default parameter encoding for requests is ISO-8859-1. To change this encoding to UTF-8 you have to use the sun-web.xml [http://docs.oracle.com/cd/E19798-01/821-1750/beaql/index.html file] with xml <code>parameter-encoding</code> element. This file has to be placed in the <code>WEB-INF</code> folder of your web application. 
CKFinder sample web application comes with such a file. If you are using Glassfish 3.0, want to use UTF-8, and to integrate CKFinder in to your application then apart from files mentioned in the [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Integration Integration] section, copy <code>sun-web.xml</code> as well. 
Below is the code for the <code>sun-web.xml</code> file:

<source lang="xml">
<!DOCTYPE sun-web-app PUBLIC "-//Sun Microsystems, Inc.//DTD GlassFish Application Server 3.0 Servlet 3.0//EN"
"http://www.sun.com/software/appserver/dtds/sun-web-app_3_0-0.dtd">
<sun-web-app>
<parameter-encoding default-charset="UTF-8" />
</sun-web-app>
</source>

===GlassFish 3.1+===
By default this [http://docs.oracle.com/cd/E18930_01/html/821-2418/beaft.html#beafu server] uses ISO-8859-1 for parameter encoding. In order to change this to UTF-8, you have to use the <code>glassfish-web.xml</code> [http://docs.oracle.com/cd/E18930_01/html/821-2417/beaql.html#scrolltoc file] with xml <code>parameter-encoding</code> element. This file has to be placed in the <code>WEB-INF</code> folder of the web application. 
CKFinder sample web application comes with such a file. If you are using Glassfish 3.1 or above, want to use UTF-8, and to integrate CKFinder in to your application then apart from files mentioned in the [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Integration Integration] section, copy <code>glassfish-web.xml</code> as well. 
Below is the code for the <code>glassfish-web.xml</code> file:
<source lang="xml">
<!DOCTYPE glassfish-web-app PUBLIC "-//GlassFish.org//DTD GlassFish Application Server 3.1 Servlet 3.0//EN"
"http://glassfish.org/dtds/glassfish-web-app_3_0-1.dtd">
<glassfish-web-app>
<parameter-encoding default-charset="UTF-8" />
</glassfish-web-app>
</source>

===Tomcat===
According to [http://wiki.apache.org/tomcat/FAQ/CharacterEncoding Tomcat FAQ], Tomcat 5-7 by default use the ISO-8859-1 encoding for handling HTTP request parameters.

Starting with version 5 for all <code>GET</code> requests, when the encoding type used is different from the default one, the query parameters are not encoded in the same way as the request body. To be more specific, if you want to use the encoding other than the default ISO-8859-1 (like UTF-8, for example), the <code>HttpServletRequest.setCharacterEncoding("UTF-8")</code> method will only be applied to the request body, and not the URI.

In order to encode the query parameters just like the requests, you should use the <code>URIEncoding="UTF-8"</code> attribute in the <code>Connector</code> element of the <code>Server.xml</code> file:
<source lang="xml">
<Connector port="8080" protocol="HTTP/1.1" connectionTimeout="20000" redirectPort="8443" URIEncoding="UTF-8" />
</source>

In Tomcat 8 the default value of <code>URIEncoding</code> attribute depends on <code>org.apache.catalina.STRICT_SERVLET_COMPLIANCE</code> [https://tomcat.apache.org/tomcat-8.0-doc/config/systemprops.html#Specifications system property]. When "strict servlet compliance" is off (default value), <code>URIEncoding</code> is now UTF-8. If "strict servlet compliance" is enabled, the <code>URIEncoding</code> is ISO-8859-1. 
In other words, the <code>URIEncoding</code> in Tomcat 8+ is now optional but if you are getting encoding problems (e.g. because <code>org.apache.catalina.STRICT_SERVLET_COMPLIANCE</code> was enabled) you can set this attribute explicitly to UTF-8 in the <code>Connector</code> element.

===JBOSS EAP 6===
By default this server uses ISO-8859-1 for parameter encoding. To change this to UTF-8, you have to modify the configuration file appropriate for the mode and configuration used. 
As you probably know, JBOSS EAP can run in two modes ("domain" and "standalone") and can use various configurations.
To simplify the example let us assume that the server uses the standalone mode and default configuration. In order to set UTF-8 for URI encoding you have to edit the <code><nowiki>JBOSS_HOME/standalone/configuration/standalone.xml</nowiki></code> file and add a system property named <code>org.apache.catalina.connector.URI_ENCODING</code>,(with value set to UTF-8) to the <code>system-properties</code> element. 
Below is the code that needs to be added to the configuration file you use:

<source lang="xml">
<system-properties>
<property name="org.apache.catalina.connector.URI_ENCODING" value="UTF-8"/>
</system-properties>
</source>
Please note that the <code>system-properties</code> node has to be placed directly under the <code>extensions</code> node, in standalone.xml file, or you will get parse errors.

===WildFly===
The WildFly belongs to the group of servers which use UTF-8 encoding for handling request parameters. Configuration setting responsible for the encoding is [https://docs.jboss.org/author/display/WFLY9/Undertow+%28web%29+subsystem+configuration#Undertow%28web%29subsystemconfiguration-Commonsettings url-charset]. In order to use international file names in CKFinder, one must leave <code>url-charset</code> setting with its default value and use [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html#setCharacterEncoding%28java.lang.String%29 setCharacterEncoding("UTF-8");] for requests and [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html#setCharacterEncoding%28java.lang.String%29 setCharacterEncoding("UTF-8");] or [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html#setContentType%28java.lang.String%29 setContentType("UTF-8");] for responses in the application. CKFinder is using the mentioned methods however since request parameters sent in the request body (occurs with an HTTP POST request) are parsed only once, it is very important that proper encoding is set as early as possible (best in a filter), before any reading of the parameters is performed.

===Weblogic===
This server follows J2EE specification when it comes to encoding. This means that if no encoding is specified then default ISO-8859-1 is set for everything (Servlets, JSP, Tag Files) except for XML format files. 
Weblogic documentation provides a couple of ways for setting the encoding you want (UTF-8 in this case). There are server typical methods as well as general Servlet API methods. It seems the best way to set encoding in the WLS server is using [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html#setCharacterEncoding%28java.lang.String%29 setCharacterEncoding("UTF-8");] for requests and [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html#setCharacterEncoding%28java.lang.String%29 setCharacterEncoding("UTF-8");] or [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html#setContentType%28java.lang.String%29 setContentType("UTF-8");] for responses.

Please see this [http://otndnld.oracle.co.jp/document/products/wls/docs103/en/relnotes_ja.htmlotndnld.oracle.co.jp/document/products/wls/docs92/en/relnotes_ja.html link] (Web Components section) for more details on setting appropriate encoding on the server-side.

===Jetty===
The Jetty server uses UTF-8 by default. Jetty [http://wiki.eclipse.org/Jetty/Howto/International_Characters#Characters_included_in_HTTP_requests documentation] states if no overriding character encoding is set on a request, Jetty uses UTF-8 encoding.

===Alternative Solution (CKFinder Adjustment)===
'''By default, CKFinder uses the UTF-8 encoding, so you should stick to the guidelines presented above in order to make it work properly.'''

If you cannot or do not want to set this parameter in the server configuration file, CKFinder will try to address this problem for you. This is why the <code>uriEncoding</code> configuration element was created in the <code>config.xml<code> file. This parameter accepts the encoding of your query parameters. 
For example, for Tomcat, JBoss, Glassfish, and Weblogic with their default configuration set (which is ISO-8859-1) you should set uriEncoding to ISO-8859-1 and CKFinder will convert the query parameters for you.

<source lang="xml">
<uriEncoding>ISO-8859-1</uriEncoding>
</source>

CKFinder 2.x/Developers Guide/Java/Configuration/URI Encoding

2015-11-19T22:26:16Z

J.swiderski:

By default some servers use the ISO-8859-1 encoding for request parameters and request body. What is more, changing the encoding for request body on such servers has no influence on the encoding of the request parameters. This may cause problems if you want to use international file names with '''CKFinder which expects request body and parameters to be encoded in UTF-8'''. To overcome this issue you can either set UTF-8 URI encoding on the server or if you do not have enough privileges to do that, you can adjust CKFinder to use same URI encoding as your server. 
You will find more detailed instructions below.

===GlassFish 3.0===
According to Glassfish 3.0 [http://docs.oracle.com/cd/E19798-01/821-1752/beafu/index.html documentation] default parameter encoding for requests is ISO-8859-1. To change this encoding to UTF-8 you have to use the sun-web.xml [http://docs.oracle.com/cd/E19798-01/821-1750/beaql/index.html file] with xml <code>parameter-encoding</code> element. This file has to be placed in the <code>WEB-INF</code> folder of your web application. 
CKFinder sample web application comes with such a file. If you are using Glassfish 3.0, want to use UTF-8, and to integrate CKFinder in to your application then apart from files mentioned in the [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Integration Integration] section, copy <code>sun-web.xml</code> as well. 
Below is the code for the <code>sun-web.xml</code> file:

<source lang="xml">
<!DOCTYPE sun-web-app PUBLIC "-//Sun Microsystems, Inc.//DTD GlassFish Application Server 3.0 Servlet 3.0//EN"
"http://www.sun.com/software/appserver/dtds/sun-web-app_3_0-0.dtd">
<sun-web-app>
<parameter-encoding default-charset="UTF-8" />
</sun-web-app>
</source>

===GlassFish 3.1+===
By default this [http://docs.oracle.com/cd/E18930_01/html/821-2418/beaft.html#beafu server] uses ISO-8859-1 for parameter encoding. In order to change this to UTF-8, you have to use the <code>glassfish-web.xml</code> [http://docs.oracle.com/cd/E18930_01/html/821-2417/beaql.html#scrolltoc file] with xml <code>parameter-encoding</code> element. This file has to be placed in the <code>WEB-INF</code> folder of the web application. 
CKFinder sample web application comes with such a file. If you are using Glassfish 3.1 or above, want to use UTF-8, and to integrate CKFinder in to your application then apart from files mentioned in the [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Integration Integration] section, copy <code>glassfish-web.xml</code> as well. 
Below is the code for the <code>glassfish-web.xml</code> file:
<source lang="xml">
<!DOCTYPE glassfish-web-app PUBLIC "-//GlassFish.org//DTD GlassFish Application Server 3.1 Servlet 3.0//EN"
"http://glassfish.org/dtds/glassfish-web-app_3_0-1.dtd">
<glassfish-web-app>
<parameter-encoding default-charset="UTF-8" />
</glassfish-web-app>
</source>

===Tomcat===
According to [http://wiki.apache.org/tomcat/FAQ/CharacterEncoding Tomcat FAQ], Tomcat 5-7 by default use the ISO-8859-1 encoding for handling HTTP request parameters.

Starting with version 5 for all <code>GET</code> requests, when the encoding type used is different from the default one, the query parameters are not encoded in the same way as the request body. To be more specific, if you want to use the encoding other than the default ISO-8859-1 (like UTF-8, for example), the <code>HttpServletRequest.setCharacterEncoding("UTF-8")</code> method will only be applied to the request body, and not the URI.

In order to encode the query parameters just like the requests, you should use the <code>URIEncoding="UTF-8"</code> attribute in the <code>Connector</code> element of the <code>Server.xml</code> file:
<source lang="xml">
<Connector port="8080" protocol="HTTP/1.1" connectionTimeout="20000" redirectPort="8443" URIEncoding="UTF-8" />
</source>

In Tomcat 8 the default value of <code>URIEncoding</code> attribute depends on <code>org.apache.catalina.STRICT_SERVLET_COMPLIANCE</code> [https://tomcat.apache.org/tomcat-8.0-doc/config/systemprops.html#Specifications system property]. When "strict servlet compliance" is off (default value), <code>URIEncoding</code> is now UTF-8. If "strict servlet compliance" is enabled, the <code>URIEncoding</code> is ISO-8859-1. 
In other words, the <code>URIEncoding</code> in Tomcat 8+ is now optional but if you are getting encoding problems (e.g. because <code>org.apache.catalina.STRICT_SERVLET_COMPLIANCE</code> was enabled) you can set this attribute explicitly to UTF-8 in the <code>Connector</code> element.

===JBOSS EAP 6===
By default this server uses ISO-8859-1 for parameter encoding. To change this to UTF-8, you have to modify the configuration file appropriate for the mode and configuration used. 
As you probably know, JBOSS EAP can run in two modes ("domain" and "standalone") and can use various configurations.
To simplify the example let us assume that the server uses the standalone mode and default configuration. In order to set UTF-8 for URI encoding you have to edit the <code><nowiki>JBOSS_HOME/standalone/configuration/standalone.xml</nowiki></code> file and add a system property named <code>org.apache.catalina.connector.URI_ENCODING</code>,(with value set to UTF-8) to the <code>system-properties</code> element. 
Below is the code that needs to be added to the configuration file you use:

<source lang="xml">
<system-properties>
<property name="org.apache.catalina.connector.URI_ENCODING" value="UTF-8"/>
</system-properties>
</source>
Please note that the <code>system-properties</code> node has to be placed directly under the <code>extensions</code> node, in standalone.xml file, or you will get parse errors.

===WildFly===
The WildFly belongs to the group of servers which use UTF-8 encoding for handling request parameters. Configuration setting responsible for the encoding is [https://docs.jboss.org/author/display/WFLY9/Undertow+%28web%29+subsystem+configuration#Undertow%28web%29subsystemconfiguration-Commonsettings url-charset]. In order to use international file names in CKFinder, one must leave <code>url-charset</code> setting with its default value and use [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html#setCharacterEncoding%28java.lang.String%29 setCharacterEncoding("UTF-8");] for requests and [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html#setCharacterEncoding%28java.lang.String%29 setCharacterEncoding("UTF-8");] or [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html#setContentType%28java.lang.String%29 setContentType("UTF-8");] for responses in the application.

===Weblogic===
This server follows J2EE specification when it comes to encoding. This means that if no encoding is specified then default ISO-8859-1 is set for everything (Servlets, JSP, Tag Files) except for XML format files. 
Weblogic documentation provides a couple of ways for setting the encoding you want (UTF-8 in this case). There are server typical methods as well as general Servlet API methods. It seems the best way to set encoding in the WLS server is using [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html#setCharacterEncoding%28java.lang.String%29 setCharacterEncoding("UTF-8");] for requests and [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html#setCharacterEncoding%28java.lang.String%29 setCharacterEncoding("UTF-8");] or [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html#setContentType%28java.lang.String%29 setContentType("UTF-8");] for responses.

Please see this [http://otndnld.oracle.co.jp/document/products/wls/docs103/en/relnotes_ja.htmlotndnld.oracle.co.jp/document/products/wls/docs92/en/relnotes_ja.html link] (Web Components section) for more details on setting appropriate encoding on the server-side.

===Jetty===
The Jetty server uses UTF-8 by default. Jetty [http://wiki.eclipse.org/Jetty/Howto/International_Characters#Characters_included_in_HTTP_requests documentation] states if no overriding character encoding is set on a request, Jetty uses UTF-8 encoding.

===Alternative Solution (CKFinder Adjustment)===
'''By default, CKFinder uses the UTF-8 encoding, so you should stick to the guidelines presented above in order to make it work properly.'''

If you cannot or do not want to set this parameter in the server configuration file, CKFinder will try to address this problem for you. This is why the <code>uriEncoding</code> configuration element was created in the <code>config.xml<code> file. This parameter accepts the encoding of your query parameters. 
For example, for Tomcat, JBoss, Glassfish, and Weblogic with their default configuration set (which is ISO-8859-1) you should set uriEncoding to ISO-8859-1 and CKFinder will convert the query parameters for you.

<source lang="xml">
<uriEncoding>ISO-8859-1</uriEncoding>
</source>

CKFinder 2.x/Developers Guide/Java/Configuration/URI Encoding

2015-11-19T06:50:13Z

J.swiderski:

By default some servers use the ISO-8859-1 encoding for request parameters and request body. What is more, changing the encoding for request body on such servers has no influence on the encoding of the request parameters. This may cause problems if you want to use international file names with '''CKFinder which expects request body and parameters to be encoded in UTF-8'''. To overcome this issue you can either set UTF-8 URI encoding on the server or if you do not have enough privileges to do that, you can adjust CKFinder to use same URI encoding as your server. 
You will find more detailed instructions below.

===GlassFish 3.0===
According to Glassfish 3.0 [http://docs.oracle.com/cd/E19798-01/821-1752/beafu/index.html documentation] default parameter encoding for requests is ISO-8859-1. To change this encoding to UTF-8 you have to use the sun-web.xml [http://docs.oracle.com/cd/E19798-01/821-1750/beaql/index.html file] with xml <code>parameter-encoding</code> element. This file has to be placed in the <code>WEB-INF</code> folder of your web application. 
CKFinder sample web application comes with such a file. If you are using Glassfish 3.0, want to use UTF-8, and to integrate CKFinder in to your application then apart from files mentioned in the [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Integration Integration] section, copy <code>sun-web.xml</code> as well. 
Below is the code for the <code>sun-web.xml</code> file:

<source lang="xml">
<!DOCTYPE sun-web-app PUBLIC "-//Sun Microsystems, Inc.//DTD GlassFish Application Server 3.0 Servlet 3.0//EN"
"http://www.sun.com/software/appserver/dtds/sun-web-app_3_0-0.dtd">
<sun-web-app>
<parameter-encoding default-charset="UTF-8" />
</sun-web-app>
</source>

===GlassFish 3.1+===
By default this [http://docs.oracle.com/cd/E18930_01/html/821-2418/beaft.html#beafu server] uses ISO-8859-1 for parameter encoding. In order to change this to UTF-8, you have to use the <code>glassfish-web.xml</code> [http://docs.oracle.com/cd/E18930_01/html/821-2417/beaql.html#scrolltoc file] with xml <code>parameter-encoding</code> element. This file has to be placed in the <code>WEB-INF</code> folder of the web application. 
CKFinder sample web application comes with such a file. If you are using Glassfish 3.1 or above, want to use UTF-8, and to integrate CKFinder in to your application then apart from files mentioned in the [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Integration Integration] section, copy <code>glassfish-web.xml</code> as well. 
Below is the code for the <code>glassfish-web.xml</code> file:
<source lang="xml">
<!DOCTYPE glassfish-web-app PUBLIC "-//GlassFish.org//DTD GlassFish Application Server 3.1 Servlet 3.0//EN"
"http://glassfish.org/dtds/glassfish-web-app_3_0-1.dtd">
<glassfish-web-app>
<parameter-encoding default-charset="UTF-8" />
</glassfish-web-app>
</source>

===Tomcat===
According to [http://wiki.apache.org/tomcat/FAQ/CharacterEncoding Tomcat FAQ], Tomcat 5-7 by default use the ISO-8859-1 encoding for handling HTTP request parameters.

Starting with version 5 for all <code>GET</code> requests, when the encoding type used is different from the default one, the query parameters are not encoded in the same way as the request body. To be more specific, if you want to use the encoding other than the default ISO-8859-1 (like UTF-8, for example), the <code>HttpServletRequest.setCharacterEncoding("UTF-8")</code> method will only be applied to the request body, and not the URI.

In order to encode the query parameters just like the requests, you should use the <code>URIEncoding="UTF-8"</code> attribute in the <code>Connector</code> element of the <code>Server.xml</code> file:
<source lang="xml">
<Connector port="8080" protocol="HTTP/1.1" connectionTimeout="20000" redirectPort="8443" URIEncoding="UTF-8" />
</source>

In Tomcat 8 the default value of <code>URIEncoding</code> attribute depends on <code>org.apache.catalina.STRICT_SERVLET_COMPLIANCE</code> [https://tomcat.apache.org/tomcat-8.0-doc/config/systemprops.html#Specifications system property]. When "strict servlet compliance" is off (default value), <code>URIEncoding</code> is now UTF-8. If "strict servlet compliance" is enabled, the <code>URIEncoding</code> is ISO-8859-1. 
In other words, the <code>URIEncoding</code> in Tomcat 8+ is now optional but if you are getting encoding problems (e.g. because <code>org.apache.catalina.STRICT_SERVLET_COMPLIANCE</code> was enabled) you can set this attribute explicitly to UTF-8 in the <code>Connector</code> element.

===JBOSS EAP 6===
By default this server uses ISO-8859-1 for parameter encoding. To change this to UTF-8, you have to modify the configuration file appropriate for the mode and configuration used. 
As you probably know, JBOSS EAP can run in two modes ("domain" and "standalone") and can use various configurations.
To simplify the example let us assume that the server uses the standalone mode and default configuration. In order to set UTF-8 for URI encoding you have to edit the <code><nowiki>JBOSS_HOME/standalone/configuration/standalone.xml</nowiki></code> file and add a system property named <code>org.apache.catalina.connector.URI_ENCODING</code>,(with value set to UTF-8) to the <code>system-properties</code> element. 
Below is the code that needs to be added to the configuration file you use:

<source lang="xml">
<system-properties>
<property name="org.apache.catalina.connector.URI_ENCODING" value="UTF-8"/>
</system-properties>
</source>
Please note that the <code>system-properties</code> node has to be placed directly under the <code>extensions</code> node, in standalone.xml file, or you will get parse errors.

===WildFly===
The WildFly belongs to the group of servers which use UTF-8 for handling request parameters. Configuration setting responsible for the encoding is [https://docs.jboss.org/author/display/WFLY9/Undertow+%28web%29+subsystem+configuration#Undertow%28web%29subsystemconfiguration-Commonsettings url-charset]. In order to have parameters properly encoded, one must leave <code>url-charset</code> setting with its default value and use [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html#setCharacterEncoding%28java.lang.String%29 setCharacterEncoding("UTF-8");] for requests and [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html#setCharacterEncoding%28java.lang.String%29 setCharacterEncoding("UTF-8");] or [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html#setContentType%28java.lang.String%29 setContentType("UTF-8");] for responses in the application.

===Weblogic===
This server follows J2EE specification when it comes to encoding. This means that if no encoding is specified then default ISO-8859-1 is set for everything (Servlets, JSP, Tag Files) except for XML format files. 
Weblogic documentation provides a couple of ways for setting the encoding you want (UTF-8 in this case). There are server typical methods as well as general Servlet API methods. It seems the best way to set encoding in the WLS server is using [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html#setCharacterEncoding%28java.lang.String%29 setCharacterEncoding("UTF-8");] for requests and [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html#setCharacterEncoding%28java.lang.String%29 setCharacterEncoding("UTF-8");] or [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html#setContentType%28java.lang.String%29 setContentType("UTF-8");] for responses.

Please see this [http://otndnld.oracle.co.jp/document/products/wls/docs103/en/relnotes_ja.htmlotndnld.oracle.co.jp/document/products/wls/docs92/en/relnotes_ja.html link] (Web Components section) for more details on setting appropriate encoding on the server-side.

===Jetty===
The Jetty server uses UTF-8 by default. Jetty [http://wiki.eclipse.org/Jetty/Howto/International_Characters#Characters_included_in_HTTP_requests documentation] states if no overriding character encoding is set on a request, Jetty uses UTF-8 encoding.

===Alternative Solution (CKFinder Adjustment)===
'''By default, CKFinder uses the UTF-8 encoding, so you should stick to the guidelines presented above in order to make it work properly.'''

If you cannot or do not want to set this parameter in the server configuration file, CKFinder will try to address this problem for you. This is why the <code>uriEncoding</code> configuration element was created in the <code>config.xml<code> file. This parameter accepts the encoding of your query parameters. 
For example, for Tomcat, JBoss, Glassfish, and Weblogic with their default configuration set (which is ISO-8859-1) you should set uriEncoding to ISO-8859-1 and CKFinder will convert the query parameters for you.

<source lang="xml">
<uriEncoding>ISO-8859-1</uriEncoding>
</source>

CKFinder 2.x/Developers Guide/Java/Configuration/URI Encoding

2015-11-18T23:32:39Z

J.swiderski:

By default some servers use the ISO-8859-1 encoding for request parameters and request body. What is more, changing the encoding for request body on such servers has no influence on the encoding of the request parameters. This may cause problems if you want to use international file names with '''CKFinder which expects request body and parameters to be encoded in UTF-8'''. To overcome this issue you can either set UTF-8 URI encoding on the server or if you do not have enough privileges to do that, you can adjust CKFinder to use same URI encoding as your server. 
You will find more detailed instructions below.

===GlassFish 3.0===
According to Glassfish 3.0 [http://docs.oracle.com/cd/E19798-01/821-1752/beafu/index.html documentation] default parameter encoding for requests is ISO-8859-1. To change this encoding to UTF-8 you have to use the sun-web.xml [http://docs.oracle.com/cd/E19798-01/821-1750/beaql/index.html file] with xml <code>parameter-encoding</code> element. This file has to be placed in the <code>WEB-INF</code> folder of your web application. 
CKFinder sample web application comes with such a file. If you are using Glassfish 3.0, want to use UTF-8, and to integrate CKFinder in to your application then apart from files mentioned in the [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Integration Integration] section, copy <code>sun-web.xml</code> as well. 
Below is the code for the <code>sun-web.xml</code> file:

<source lang="xml">
<!DOCTYPE sun-web-app PUBLIC "-//Sun Microsystems, Inc.//DTD GlassFish Application Server 3.0 Servlet 3.0//EN"
"http://www.sun.com/software/appserver/dtds/sun-web-app_3_0-0.dtd">
<sun-web-app>
<parameter-encoding default-charset="UTF-8" />
</sun-web-app>
</source>

===GlassFish 3.1+===
By default this [http://docs.oracle.com/cd/E18930_01/html/821-2418/beaft.html#beafu server] uses ISO-8859-1 for parameter encoding. In order to change this to UTF-8, you have to use the <code>glassfish-web.xml</code> [http://docs.oracle.com/cd/E18930_01/html/821-2417/beaql.html#scrolltoc file] with xml <code>parameter-encoding</code> element. This file has to be placed in the <code>WEB-INF</code> folder of the web application. 
CKFinder sample web application comes with such a file. If you are using Glassfish 3.1 or above, want to use UTF-8, and to integrate CKFinder in to your application then apart from files mentioned in the [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Integration Integration] section, copy <code>glassfish-web.xml</code> as well. 
Below is the code for the <code>glassfish-web.xml</code> file:
<source lang="xml">
<!DOCTYPE glassfish-web-app PUBLIC "-//GlassFish.org//DTD GlassFish Application Server 3.1 Servlet 3.0//EN"
"http://glassfish.org/dtds/glassfish-web-app_3_0-1.dtd">
<glassfish-web-app>
<parameter-encoding default-charset="UTF-8" />
</glassfish-web-app>
</source>

===Tomcat===
According to [http://wiki.apache.org/tomcat/FAQ/CharacterEncoding Tomcat FAQ], Tomcat 5-7 by default use the ISO-8859-1 encoding for handling HTTP request parameters.

Starting with version 5 for all <code>GET</code> requests, when the encoding type used is different from the default one, the query parameters are not encoded in the same way as the request body. To be more specific, if you want to use the encoding other than the default ISO-8859-1 (like UTF-8, for example), the <code>HttpServletRequest.setCharacterEncoding("UTF-8")</code> method will only be applied to the request body, and not the URI.

In order to encode the query parameters just like the requests, you should use the <code>URIEncoding="UTF-8"</code> attribute in the <code>Connector</code> element of the <code>Server.xml</code> file:
<source lang="xml">
<Connector port="8080" protocol="HTTP/1.1" connectionTimeout="20000" redirectPort="8443" URIEncoding="UTF-8" />
</source>

In Tomcat 8 the default value of <code>URIEncoding</code> attribute depends on <code>org.apache.catalina.STRICT_SERVLET_COMPLIANCE</code> [https://tomcat.apache.org/tomcat-8.0-doc/config/systemprops.html#Specifications system property]. When "strict servlet compliance" is off (default value), <code>URIEncoding</code> is now UTF-8. If "strict servlet compliance" is enabled, the <code>URIEncoding</code> is ISO-8859-1. 
In other words, the <code>URIEncoding</code> in Tomcat 8+ is now optional but if you are getting encoding problems (e.g. because <code>org.apache.catalina.STRICT_SERVLET_COMPLIANCE</code> was enabled) you can set this attribute explicitly to UTF-8 in the <code>Connector</code> element.

===JBOSS EAP 6===
By default this server uses ISO-8859-1 for parameter encoding. To change this to UTF-8, you have to modify the configuration file appropriate for the mode and configuration used. 
As you probably know, JBOSS EAP can run in two modes ("domain" and "standalone") and can use various configurations.
To simplify the example let us assume that the server uses the standalone mode and default configuration. In order to set UTF-8 for URI encoding you have to edit the <code><nowiki>JBOSS_HOME/standalone/configuration/standalone.xml</nowiki></code> file and add a system property named <code>org.apache.catalina.connector.URI_ENCODING</code>,(with value set to UTF-8) to the <code>system-properties</code> element. 
Below is the code that needs to be added to the configuration file you use:

<source lang="xml">
<system-properties>
<property name="org.apache.catalina.connector.URI_ENCODING" value="UTF-8"/>
</system-properties>
</source>
Please note that the <code>system-properties</code> node has to be placed directly under the <code>extensions</code> node, in standalone.xml file, or you will get parse errors.

===WildFly===
The WildFly belongs to the group of servers which by default use UTF-8 for handling request parameters. Configuration setting responsible for the encoding is [https://docs.jboss.org/author/display/WFLY9/Undertow+%28web%29+subsystem+configuration#Undertow%28web%29subsystemconfiguration-Commonsettings url-charset]. In order to have parameters properly encoded, one must leave <code>url-charset</code> setting with its default value and use [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html#setCharacterEncoding%28java.lang.String%29 setCharacterEncoding("UTF-8");] for requests and [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html#setCharacterEncoding%28java.lang.String%29 setCharacterEncoding("UTF-8");] or [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html#setContentType%28java.lang.String%29 setContentType("UTF-8");] for responses in the application.

===Weblogic===
This server follows J2EE specification when it comes to encoding. This means that if no encoding is specified then default ISO-8859-1 is set for everything (Servlets, JSP, Tag Files) except for XML format files. 
Weblogic documentation provides a couple of ways for setting the encoding you want (UTF-8 in this case). There are server typical methods as well as general Servlet API methods. It seems the best way to set encoding in the WLS server is using [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html#setCharacterEncoding%28java.lang.String%29 setCharacterEncoding("UTF-8");] for requests and [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html#setCharacterEncoding%28java.lang.String%29 setCharacterEncoding("UTF-8");] or [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html#setContentType%28java.lang.String%29 setContentType("UTF-8");] for responses.

Please see this [http://otndnld.oracle.co.jp/document/products/wls/docs103/en/relnotes_ja.htmlotndnld.oracle.co.jp/document/products/wls/docs92/en/relnotes_ja.html link] (Web Components section) for more details on setting appropriate encoding on the server-side.

===Jetty===
The Jetty server uses UTF-8 by default. Jetty [http://wiki.eclipse.org/Jetty/Howto/International_Characters#Characters_included_in_HTTP_requests documentation] states if no overriding character encoding is set on a request, Jetty uses UTF-8 encoding.

===Alternative Solution (CKFinder Adjustment)===
'''By default, CKFinder uses the UTF-8 encoding, so you should stick to the guidelines presented above in order to make it work properly.'''

If you cannot or do not want to set this parameter in the server configuration file, CKFinder will try to address this problem for you. This is why the <code>uriEncoding</code> configuration element was created in the <code>config.xml<code> file. This parameter accepts the encoding of your query parameters. 
For example, for Tomcat, JBoss, Glassfish, and Weblogic with their default configuration set (which is ISO-8859-1) you should set uriEncoding to ISO-8859-1 and CKFinder will convert the query parameters for you.

<source lang="xml">
<uriEncoding>ISO-8859-1</uriEncoding>
</source>

CKFinder 2.x/Developers Guide/Java/Configuration/URI Encoding

2015-11-18T21:47:31Z

J.swiderski:

By default some servers use the ISO-8859-1 encoding for request parameters and request body. What is more, changing the encoding for request body on such servers has no influence on the encoding of the request parameters. This may cause problems if you want to use international file names with '''CKFinder which expects request body and parameters to be encoded in UTF-8'''. To overcome this issue you can either set UTF-8 URI encoding on the server or if you do not have enough privileges to do that, you can adjust CKFinder to use same URI encoding as your server. 
You will find more detailed instructions below.

===GlassFish 3.0===
According to Glassfish 3.0 [http://docs.oracle.com/cd/E19798-01/821-1752/beafu/index.html documentation] default parameter encoding for requests is ISO-8859-1. To change this encoding to UTF-8 you have to use the sun-web.xml [http://docs.oracle.com/cd/E19798-01/821-1750/beaql/index.html file] with xml <code>parameter-encoding</code> element. This file has to be placed in the <code>WEB-INF</code> folder of your web application. 
CKFinder sample web application comes with such a file. If you are using Glassfish 3.0, want to use UTF-8, and to integrate CKFinder in to your application then apart from files mentioned in the [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Integration Integration] section, copy <code>sun-web.xml</code> as well. 
Below is the code for the <code>sun-web.xml</code> file:

<source lang="xml">
<!DOCTYPE sun-web-app PUBLIC "-//Sun Microsystems, Inc.//DTD GlassFish Application Server 3.0 Servlet 3.0//EN"
"http://www.sun.com/software/appserver/dtds/sun-web-app_3_0-0.dtd">
<sun-web-app>
<parameter-encoding default-charset="UTF-8" />
</sun-web-app>
</source>

===GlassFish 3.1+===
By default this [http://docs.oracle.com/cd/E18930_01/html/821-2418/beaft.html#beafu server] uses ISO-8859-1 for parameter encoding. In order to change this to UTF-8, you have to use the <code>glassfish-web.xml</code> [http://docs.oracle.com/cd/E18930_01/html/821-2417/beaql.html#scrolltoc file] with xml <code>parameter-encoding</code> element. This file has to be placed in the <code>WEB-INF</code> folder of the web application. 
CKFinder sample web application comes with such a file. If you are using Glassfish 3.1 or above, want to use UTF-8, and to integrate CKFinder in to your application then apart from files mentioned in the [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Integration Integration] section, copy <code>glassfish-web.xml</code> as well. 
Below is the code for the <code>glassfish-web.xml</code> file:
<source lang="xml">
<!DOCTYPE glassfish-web-app PUBLIC "-//GlassFish.org//DTD GlassFish Application Server 3.1 Servlet 3.0//EN"
"http://glassfish.org/dtds/glassfish-web-app_3_0-1.dtd">
<glassfish-web-app>
<parameter-encoding default-charset="UTF-8" />
</glassfish-web-app>
</source>

===Tomcat===
According to [http://wiki.apache.org/tomcat/FAQ/CharacterEncoding Tomcat FAQ], Tomcat 5-7 by default use the ISO-8859-1 encoding for handling HTTP request parameters.

Starting with version 5 for all <code>GET</code> requests, when the encoding type used is different from the default one, the query parameters are not encoded in the same way as the request body. To be more specific, if you want to use the encoding other than the default ISO-8859-1 (like UTF-8, for example), the <code>HttpServletRequest.setCharacterEncoding("UTF-8")</code> method will only be applied to the request body, and not the URI.

In order to encode the query parameters just like the requests, you should use the <code>URIEncoding="UTF-8"</code> attribute in the <code>Connector</code> element of the <code>Server.xml</code> file:
<source lang="xml">
<Connector port="8080" protocol="HTTP/1.1" connectionTimeout="20000" redirectPort="8443" URIEncoding="UTF-8" />
</source>

In Tomcat 8 the default value of <code>URIEncoding</code> attribute depends on <code>org.apache.catalina.STRICT_SERVLET_COMPLIANCE</code> [https://tomcat.apache.org/tomcat-8.0-doc/config/systemprops.html#Specifications system property]. When "strict servlet compliance" is off (default value), <code>URIEncoding</code> is now UTF-8. If "strict servlet compliance" is enabled, the <code>URIEncoding</code> is ISO-8859-1. 
In other words, the <code>URIEncoding</code> in Tomcat 8+ is now optional but if you are getting encoding problems (e.g. because <code>org.apache.catalina.STRICT_SERVLET_COMPLIANCE</code> was enabled) you can set this attribute explicitly to UTF-8 in the <code>Connector</code> element.

===JBOSS EAP 6===
By default this server uses ISO-8859-1 for parameter encoding. To change this to UTF-8, you have to modify the configuration file appropriate for the mode and configuration used. 
As you probably know, JBOSS EAP can run in two modes ("domain" and "standalone") and can use various configurations.
To simplify the example let us assume that the server uses the standalone mode and default configuration. In order to set UTF-8 for URI encoding you have to edit the <code><nowiki>JBOSS_HOME/standalone/configuration/standalone.xml</nowiki></code> file and add a system property named <code>org.apache.catalina.connector.URI_ENCODING</code>,(with value set to UTF-8) to the <code>system-properties</code> element. 
Below is the code that needs to be added to the configuration file you use:

<source lang="xml">
<system-properties>
<property name="org.apache.catalina.connector.URI_ENCODING" value="UTF-8"/>
</system-properties>
</source>
Please note that the <code>system-properties</code> node has to be placed directly under the <code>extensions</code> node, in standalone.xml file, or you will get parse errors.

===Weblogic===
This server follows J2EE specification when it comes to encoding. This means that if no encoding is specified then default ISO-8859-1 is set for everything (Servlets, JSP, Tag Files) except for XML format files. 
Weblogic documentation provides a couple of ways for setting the encoding you want (UTF-8 in this case). There are server typical methods as well as general Servlet API methods. It seems the best way to set encoding in the WLS server is using [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html#setCharacterEncoding%28java.lang.String%29 setCharacterEncoding("UTF-8");] for requests and [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html#setCharacterEncoding%28java.lang.String%29 setCharacterEncoding("UTF-8");] or [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html#setContentType%28java.lang.String%29 setContentType("UTF-8");] for responses.

Please see this [http://otndnld.oracle.co.jp/document/products/wls/docs103/en/relnotes_ja.htmlotndnld.oracle.co.jp/document/products/wls/docs92/en/relnotes_ja.html link] (Web Components section) for more details on setting appropriate encoding on the server-side.

===Jetty===
The Jetty server uses UTF-8 by default. Jetty [http://wiki.eclipse.org/Jetty/Howto/International_Characters#Characters_included_in_HTTP_requests documentation] states if no overriding character encoding is set on a request, Jetty uses UTF-8 encoding.

===Alternative Solution (CKFinder Adjustment)===
'''By default, CKFinder uses the UTF-8 encoding, so you should stick to the guidelines presented above in order to make it work properly.'''

If you cannot or do not want to set this parameter in the server configuration file, CKFinder will try to address this problem for you. This is why the <code>uriEncoding</code> configuration element was created in the <code>config.xml<code> file. This parameter accepts the encoding of your query parameters. 
For example, for Tomcat, JBoss, Glassfish, and Weblogic with their default configuration set (which is ISO-8859-1) you should set uriEncoding to ISO-8859-1 and CKFinder will convert the query parameters for you.

<source lang="xml">
<uriEncoding>ISO-8859-1</uriEncoding>
</source>

CKFinder 2.x/Developers Guide/Java/Configuration/URI Encoding

2015-11-15T23:34:28Z

J.swiderski:

By default some servers use the ISO-8859-1 encoding for request parameters and request body. What is more, changing the encoding for request body on such servers has no influence on the encoding of the request parameters. This may cause problems if you want to use international file names with '''CKFinder which expects request body and parameters to be encoded in UTF-8'''. To overcome this issue you can either set UTF-8 URI encoding on the server or if you do not have enough privileges to do that, you can adjust CKFinder to use same URI encoding as your server. 
You will find more detailed instructions below.

===JBOSS EAP 6===
By default this server uses ISO-8859-1 for parameter encoding. To change this to UTF-8, you have to modify the configuration file appropriate for the mode and configuration used. 
As you probably know, JBOSS EAP can run in two modes ("domain" and "standalone") and can use various configurations.
To simplify the example let us assume that the server uses the standalone mode and default configuration. In order to set UTF-8 for URI encoding you have to edit the <code><nowiki>JBOSS_HOME/standalone/configuration/standalone.xml</nowiki></code> file and add a system property named <code>org.apache.catalina.connector.URI_ENCODING</code>,(with value set to UTF-8) to the <code>system-properties</code> element. 
Below is the code that needs to be added to the configuration file you use:

<source lang="xml">
<system-properties>
<property name="org.apache.catalina.connector.URI_ENCODING" value="UTF-8"/>
</system-properties>
</source>
Please note that the <code>system-properties</code> node has to be placed directly under the <code>extensions</code> node, in standalone.xml file, or you will get parse errors.

===GlassFish 3.0===
According to Glassfish 3.0 [http://docs.oracle.com/cd/E19798-01/821-1752/beafu/index.html documentation] default parameter encoding for requests is ISO-8859-1. To change this encoding to UTF-8 you have to use the sun-web.xml [http://docs.oracle.com/cd/E19798-01/821-1750/beaql/index.html file] with xml <code>parameter-encoding</code> element. This file has to be placed in the <code>WEB-INF</code> folder of your web application. 
CKFinder sample web application comes with such a file. If you are using Glassfish 3.0, want to use UTF-8, and to integrate CKFinder in to your application then apart from files mentioned in the [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Integration Integration] section, copy <code>sun-web.xml</code> as well. 
Below is the code for the <code>sun-web.xml</code> file:

<source lang="xml">
<!DOCTYPE sun-web-app PUBLIC "-//Sun Microsystems, Inc.//DTD GlassFish Application Server 3.0 Servlet 3.0//EN"
"http://www.sun.com/software/appserver/dtds/sun-web-app_3_0-0.dtd">
<sun-web-app>
<parameter-encoding default-charset="UTF-8" />
</sun-web-app>
</source>

===GlassFish 3.1+===
By default this [http://docs.oracle.com/cd/E18930_01/html/821-2418/beaft.html#beafu server] uses ISO-8859-1 for parameter encoding. In order to change this to UTF-8, you have to use the <code>glassfish-web.xml</code> [http://docs.oracle.com/cd/E18930_01/html/821-2417/beaql.html#scrolltoc file] with xml <code>parameter-encoding</code> element. This file has to be placed in the <code>WEB-INF</code> folder of the web application. 
CKFinder sample web application comes with such a file. If you are using Glassfish 3.1 or above, want to use UTF-8, and to integrate CKFinder in to your application then apart from files mentioned in the [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Integration Integration] section, copy <code>glassfish-web.xml</code> as well. 
Below is the code for the <code>glassfish-web.xml</code> file:
<source lang="xml">
<!DOCTYPE glassfish-web-app PUBLIC "-//GlassFish.org//DTD GlassFish Application Server 3.1 Servlet 3.0//EN"
"http://glassfish.org/dtds/glassfish-web-app_3_0-1.dtd">
<glassfish-web-app>
<parameter-encoding default-charset="UTF-8" />
</glassfish-web-app>
</source>

===Tomcat===
According to [http://wiki.apache.org/tomcat/FAQ/CharacterEncoding Tomcat FAQ], Tomcat 5-7 by default use the ISO-8859-1 encoding for handling HTTP request parameters.

Starting with version 5 for all <code>GET</code> requests, when the encoding type used is different from the default one, the query parameters are not encoded in the same way as the request body. To be more specific, if you want to use the encoding other than the default ISO-8859-1 (like UTF-8, for example), the <code>HttpServletRequest.setCharacterEncoding("UTF-8")</code> method will only be applied to the request body, and not the URI.

In order to encode the query parameters just like the requests, you should use the <code>URIEncoding="UTF-8"</code> attribute in the <code>Connector</code> element of the <code>Server.xml</code> file:
<source lang="xml">
<Connector port="8080" protocol="HTTP/1.1" connectionTimeout="20000" redirectPort="8443" URIEncoding="UTF-8" />
</source>

In Tomcat 8 the default value of <code>URIEncoding</code> attribute depends on <code>org.apache.catalina.STRICT_SERVLET_COMPLIANCE</code> [https://tomcat.apache.org/tomcat-8.0-doc/config/systemprops.html#Specifications system property]. When "strict servlet compliance" is off (default value), <code>URIEncoding</code> is now UTF-8. If "strict servlet compliance" is enabled, the <code>URIEncoding</code> is ISO-8859-1. 
In other words, the <code>URIEncoding</code> in Tomcat 8+ is now optional but if you are getting encoding problems (e.g. because <code>org.apache.catalina.STRICT_SERVLET_COMPLIANCE</code> was enabled) you can set this attribute explicitly to UTF-8 in the <code>Connector</code> element.

===Weblogic===
This server follows J2EE specification when it comes to encoding. This means that if no encoding is specified then default ISO-8859-1 is set for everything (Servlets, JSP, Tag Files) except for XML format files. 
Weblogic documentation provides a couple of ways for setting the encoding you want (UTF-8 in this case). There are server typical methods as well as general Servlet API methods. It seems the best way to set encoding in the WLS server is using [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html#setCharacterEncoding%28java.lang.String%29 setCharacterEncoding("UTF-8");] for requests and [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html#setCharacterEncoding%28java.lang.String%29 setCharacterEncoding("UTF-8");] or [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html#setContentType%28java.lang.String%29 setContentType("UTF-8");] for responses.

Please see this [http://otndnld.oracle.co.jp/document/products/wls/docs103/en/relnotes_ja.htmlotndnld.oracle.co.jp/document/products/wls/docs92/en/relnotes_ja.html link] (Web Components section) for more details on setting appropriate encoding on the server-side.

===Jetty===
The Jetty server uses UTF-8 by default. Jetty [http://wiki.eclipse.org/Jetty/Howto/International_Characters#Characters_included_in_HTTP_requests documentation] states if no overriding character encoding is set on a request, Jetty uses UTF-8 encoding.

===Alternative Solution (CKFinder Adjustment)===
'''By default, CKFinder uses the UTF-8 encoding, so you should stick to the guidelines presented above in order to make it work properly.'''

If you cannot or do not want to set this parameter in the server configuration file, CKFinder will try to address this problem for you. This is why the <code>uriEncoding</code> configuration element was created in the <code>config.xml<code> file. This parameter accepts the encoding of your query parameters. 
For example, for Tomcat, JBoss, Glassfish, and Weblogic with their default configuration set (which is ISO-8859-1) you should set uriEncoding to ISO-8859-1 and CKFinder will convert the query parameters for you.

<source lang="xml">
<uriEncoding>ISO-8859-1</uriEncoding>
</source>

CKFinder 2.x/Developers Guide/Java/Configuration/URI Encoding

2015-11-05T15:55:40Z

J.swiderski:

By default some servers use the ISO-8859-1 encoding for request parameters and request body. What is more, changing the encoding for request body on such servers has no influence on the encoding of the request parameters. This may cause problems if you want to use international file names with '''CKFinder which expects request body and parameters to be encoded in UTF-8'''. To overcome this issue you can either set UTF-8 URI encoding on the server or if you do not have enough privileges to do that, you can adjust CKFinder to use same URI encoding as your server. 
You will find more detailed instructions below.

===JBOSS 7===
By default this server uses ISO-8859-1 for parameter encoding. To change this to UTF-8, you have to modify the configuration file appropriate for the mode and configuration used. 
As you probably know, JBOSS 7 can run in two modes ("domain" and "standalone") and can use various configurations.
To simplify the example let us assume that the server uses the standalone mode and default configuration. In order to set UTF-8 for URI encoding you have to edit the <code><nowiki>JBOSS_HOME/standalone/configuration/standalone.xml</nowiki></code> file and add a system property named <code>org.apache.catalina.connector.URI_ENCODING</code>,(with value set to UTF-8) to the <code>system-properties</code> element. 
Below is the code that needs to be added to the configuration file you use:

<source lang="xml">
<system-properties>
<property name="org.apache.catalina.connector.URI_ENCODING" value="UTF-8"/>
</system-properties>
</source>

===GlassFish 3.0===
According to Glassfish 3.0 [http://docs.oracle.com/cd/E19798-01/821-1752/beafu/index.html documentation] default parameter encoding for requests is ISO-8859-1. To change this encoding to UTF-8 you have to use the sun-web.xml [http://docs.oracle.com/cd/E19798-01/821-1750/beaql/index.html file] with xml <code>parameter-encoding</code> element. This file has to be placed in the <code>WEB-INF</code> folder of your web application. 
CKFinder sample web application comes with such a file. If you are using Glassfish 3.0, want to use UTF-8, and to integrate CKFinder in to your application then apart from files mentioned in the [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Integration Integration] section, copy <code>sun-web.xml</code> as well. 
Below is the code for the <code>sun-web.xml</code> file:

<source lang="xml">
<!DOCTYPE sun-web-app PUBLIC "-//Sun Microsystems, Inc.//DTD GlassFish Application Server 3.0 Servlet 3.0//EN"
"http://www.sun.com/software/appserver/dtds/sun-web-app_3_0-0.dtd">
<sun-web-app>
<parameter-encoding default-charset="UTF-8" />
</sun-web-app>
</source>

===GlassFish 3.1+===
By default this [http://docs.oracle.com/cd/E18930_01/html/821-2418/beaft.html#beafu server] uses ISO-8859-1 for parameter encoding. In order to change this to UTF-8, you have to use the <code>glassfish-web.xml</code> [http://docs.oracle.com/cd/E18930_01/html/821-2417/beaql.html#scrolltoc file] with xml <code>parameter-encoding</code> element. This file has to be placed in the <code>WEB-INF</code> folder of the web application. 
CKFinder sample web application comes with such a file. If you are using Glassfish 3.1 or above, want to use UTF-8, and to integrate CKFinder in to your application then apart from files mentioned in the [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Integration Integration] section, copy <code>glassfish-web.xml</code> as well. 
Below is the code for the <code>glassfish-web.xml</code> file:
<source lang="xml">
<!DOCTYPE glassfish-web-app PUBLIC "-//GlassFish.org//DTD GlassFish Application Server 3.1 Servlet 3.0//EN"
"http://glassfish.org/dtds/glassfish-web-app_3_0-1.dtd">
<glassfish-web-app>
<parameter-encoding default-charset="UTF-8" />
</glassfish-web-app>
</source>

===Tomcat===
According to [http://wiki.apache.org/tomcat/FAQ/CharacterEncoding Tomcat FAQ], Tomcat 5-7 by default use the ISO-8859-1 encoding for handling HTTP request parameters.

Starting with version 5 for all <code>GET</code> requests, when the encoding type used is different from the default one, the query parameters are not encoded in the same way as the request body. To be more specific, if you want to use the encoding other than the default ISO-8859-1 (like UTF-8, for example), the <code>HttpServletRequest.setCharacterEncoding("UTF-8")</code> method will only be applied to the request body, and not the URI.

In order to encode the query parameters just like the requests, you should use the <code>URIEncoding="UTF-8"</code> attribute in the <code>Connector</code> element of the <code>Server.xml</code> file:
<source lang="xml">
<Connector port="8080" protocol="HTTP/1.1" connectionTimeout="20000" redirectPort="8443" URIEncoding="UTF-8" />
</source>

In Tomcat 8 the default value of <code>URIEncoding</code> attribute depends on <code>org.apache.catalina.STRICT_SERVLET_COMPLIANCE</code> [https://tomcat.apache.org/tomcat-8.0-doc/config/systemprops.html#Specifications system property]. When "strict servlet compliance" is off (default value), <code>URIEncoding</code> is now UTF-8. If "strict servlet compliance" is enabled, the <code>URIEncoding</code> is ISO-8859-1. 
In other words, the <code>URIEncoding</code> in Tomcat 8+ is now optional but if you are getting encoding problems (e.g. because <code>org.apache.catalina.STRICT_SERVLET_COMPLIANCE</code> was enabled) you can set this attribute explicitly to UTF-8 in the <code>Connector</code> element.

===Weblogic===
This server follows J2EE specification when it comes to encoding. This means that if no encoding is specified then default ISO-8859-1 is set for everything (Servlets, JSP, Tag Files) except for XML format files. 
Weblogic documentation provides a couple of ways for setting the encoding you want (UTF-8 in this case). There are server typical methods as well as general Servlet API methods. It seems the best way to set encoding in the WLS server is using [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html#setCharacterEncoding%28java.lang.String%29 setCharacterEncoding("UTF-8");] for requests and [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html#setCharacterEncoding%28java.lang.String%29 setCharacterEncoding("UTF-8");] or [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html#setContentType%28java.lang.String%29 setContentType("UTF-8");] for responses.

Please see this [http://otndnld.oracle.co.jp/document/products/wls/docs103/en/relnotes_ja.htmlotndnld.oracle.co.jp/document/products/wls/docs92/en/relnotes_ja.html link] (Web Components section) for more details on setting appropriate encoding on the server-side.

===Jetty===
The Jetty server uses UTF-8 by default. Jetty [http://wiki.eclipse.org/Jetty/Howto/International_Characters#Characters_included_in_HTTP_requests documentation] states if no overriding character encoding is set on a request, Jetty uses UTF-8 encoding.

===Alternative Solution (CKFinder Adjustment)===
'''By default, CKFinder uses the UTF-8 encoding, so you should stick to the guidelines presented above in order to make it work properly.'''

If you cannot or do not want to set this parameter in the server configuration file, CKFinder will try to address this problem for you. This is why the <code>uriEncoding</code> configuration element was created in the <code>config.xml<code> file. This parameter accepts the encoding of your query parameters. 
For example, for Tomcat, JBoss, Glassfish, and Weblogic with their default configuration set (which is ISO-8859-1) you should set uriEncoding to ISO-8859-1 and CKFinder will convert the query parameters for you.

<source lang="xml">
<uriEncoding>ISO-8859-1</uriEncoding>
</source>

CKFinder 2.x/Developers Guide/Java/Installation

2015-11-05T14:58:54Z

J.swiderski:

__TOC__
{{#CUSTOMTITLE:CKFinder Installation}}
This article describes how to install CKFinder for Java.

== Installation Procedure ==
To install CKFinder, download the CKFinder for Java distribution package (a <code>.war</code> file) from the [http://ckfinder.com/download official download site]. 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 <code>_samples</code> folder of the distribution package. After the deployment open the <code>_samples/index.html</code> 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 <code>config.xml</code> file where you can customize your application. See the [[CKFinder_2.x/Developers Guide/Java/Configuration|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.
<source lang="xml">
<enabled>true</enabled>
</source>

== Deployment on a Server ==
The CKFinder Java connector supports the following servers:
* Tomcat 6-8,
* Jetty 9,
* WildFly (former JBoss AS) 8-9,
* JBoss EAP 6,
* GlassFish 3-4,
* Weblogic 11g-12c.
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 <code>.war</code> file in the Tomcat <code>webapps</code> folder. Go to Tomcat <code>bin</code> folder and run the startup script file for your operating system — <code>startup.bat</code> for Windows or <code>startup.sh</code> for Linux. When you are running Tomcat as a service, restart the server.

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

If you want to use international files names with CKFinder please see [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Configuration/URI_Encoding URI Encoding section] which explains how to set UTF-8 in Tomcat.

Go to the [http://wiki.apache.org/tomcat/FAQ Tomcat FAQ] and [http://tomcat.apache.org/tomcat-6.0-doc/index.html Tomcat 6], or [http://tomcat.apache.org/tomcat-7.0-doc/index.html Tomcat 7], or [http://tomcat.apache.org/tomcat-8.0-doc/index.html Tomcat 8] documentation for more information about using this server.

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

By default Jetty unpacks war files to folders like <code><nowiki>C:\Users\admin\AppData\Local\Temp\jetty-0.0.0.0-8080-CKFinderJava.war-_CKFinderJava-any-\webapp\</nowiki></code>. Information about this folder is displayed in the output console, when application is deployed. If you wish to change this folder, you can either put the unpacked <code>CKFinderJava.war</code> file in the webapps folder (Jetty will use the unpacked application folder) or go to <code><nowiki>jetty9\etc\jetty-deploy.xml</nowiki></code> and set the below parameter to the folder path of your choice:

<source lang="xml"><Set name="tempDir"><New class="java.io.File"><Arg>C:\tmp</Arg></New></Set></source>

Go to the [http://www.eclipse.org/jetty/documentation/current/quick-start.html Jetty 9] Quick Start guide for more information about using this server.

=== WildFly ===
The server can be started from the command line. Go to the WildFly <code>bin</code> folder and run the following command:
* Windows: <code>standalone.bat</code> or <code>domain.bat</code>
* Linux: <code>standalone.sh</code> or <code>domain.sh</code>

WildFly Application Server can run in two modes: standalone and domain. First one allows running a single standalone Server, while the latter is used to manage multiple physical (or virtual) machines from a single control point. 
'''NOTE:''' In this example we are going to work with a standalone server.

The above two commands start server with its default configurations. If one wishes to start the server with one of alternative configurations, one should pass the <code>--server-config</code> argument with the server configuration file to be used. The example below shows how to run the full profile configuration with high availability:
* Windows: <code>standalone.bat --server-config=standalone-ha.xml</code>
* Linux: <code>standalone.sh --server-config=standalone-ha.xml</code>
You can read more about available WildFly configurations [https://docs.jboss.org/author/display/WFLY9/Getting+Started+Guide#GettingStartedGuide-WildFly8Configurations here].

After the server was started, log into administration console, click '''Deployments''' link, next click the '''Add''' button, select '''Upload a new deployment''' radio button, click '''Next''' and select <code>CKFinderJava.war</code> file. Once CKFinderJava.war upload is finished, verify its runtime name and check the '''Enable''' checkbox. The Application is now ready to use.

Another way of deploying the CKFinderJava application is using WildFly Command Line Interface (CLI). It has to be first launched using the <code>jboss-cli.sh</code> or <code>jboss-cli.bat</code> script located in <code>JBOSS_HOME/bin</code> directory. Once this is done, you can deploy applications as in the example given below:
* '''In standalone mode:''' <code>[standalone@localhost:9999 /] deploy ~/Desktop/CKFinderJava.war</code>
* '''In domain mode:''' <code>[domain@localhost:9999 /] deploy ~/Desktop/ CKFinderJava.war --all-server-groups</code>
'''NOTE:''' Either <code>--all-server-groups</code> or <code>--server-groups</code> with specified server groups must be used. 

To learn more about CLI please see this [https://docs.jboss.org/author/display/WFLY9/Admin+Guide#AdminGuide-CommandLineInterface link].

If your Server is running in the standalone mode, then aside from using the administration console and CLI, WildFly can also work in manual and auto deployment mode (this depends on your settings). 
In the '''Auto-Deploy mode''' the scanner directly monitors the deployment content, available in <code><nowiki>JBOSS_HOME/standalone/deployments</nowiki></code> directory, automatically deploying new content and redeploying content whose timestamp has changed. It means that you can simply drop CKFinderJava.war into deployments folder and the application will be deployed. 
To undeploy CKFinderJava in auto mode simply remove war file from deploy directory. 
In the '''Manual deploy mode''' the scanner does not directly monitor the deployment content. Instead, the scanner relies on a system of marker files, which the user can add to or remove from deployment directory. These files serve as a sort of command telling the scanner to deploy, undeploy, or redeploy the content. You can learn more about marker files in the "Marker Files" section available under this [https://docs.jboss.org/author/display/WFLY8/Application+deployment link].

To deploy <code>CKFinderJava.war</code> in manual mode, copy this file into the <code>JBOSS_HOME/standalone/deployments</code> directory and create the <code>CKFinderJava.war.dodeploy</code> file. CKFinder will be deployed and the <code>CKFinderJava.war.deployed</code> marker file will be created. To undeploy CKFinderJava simply remove <code>CKFinderJava.war.deployed</code> file.

Please note that by default WildFly allows auto-deployment of zipped content and prevents auto-deployment of exploded content. This is because exploded content is vulnerable to the scanner trying to auto-deploy partially copied content. However, if you wish to change this behavior, you can go to the <code><nowiki>JBOSS_HOME/standalone/configuration/standalone.xml</nowiki></code> file, look for the '''deployment-scanner'' tag and change the deployment options as you like:

<source lang="xml">
<deployment-scanner scan-interval="5000" relative-to="jboss.server.base.dir" path="deployments"
auto-deploy-zipped="true" auto-deploy-exploded="false"/>
</source>

By default, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>
Please note that the HTTP <code>8080</code> port of the sample URL is the default WildFly port. If you changed this value while configuring your WildFly installation, you will need to use a modified port value to run the sample application.

If you want to use international files names with CKFinder please see [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Configuration/URI_Encoding URI Encoding section] which explains how to set UTF-8 in WildFly.

Go to the WildFly [https://docs.jboss.org/author/display/WFLY9/Getting+Started+Guide Getting Started] and [https://docs.jboss.org/author/display/WFLY9/Admin+Guide Administration Guide] for more information about using this server.

=== JBoss EAP 6 ===
The server can be started from the command line. Go to the JBoss Enterprise Application Platform (EAP) <code>bin</code> folder and run the following command:
* Windows: <code>standalone.bat</code> or <code>domain.bat</code>
* Linux: <code>standalone.sh</code> or <code>domain.sh</code>

JBoss EAP can run in two modes: standalone and domain. First one allows running a single standalone Server, while the latter is used to manage multiple physical (or virtual) machines from a single control point. 
'''NOTE:''' In this example we are going to work with a standalone server.

The above two commands start server with its default configurations. If one wishes to start the server with one of alternative configurations, one should pass the <code>--server-config</code> argument with the server configuration file to be used. The example below shows how to run the full profile configuration with high availability:
* Windows: <code>standalone.bat --server-config=standalone-ha.xml</code>
* Linux: <code>standalone.sh --server-config=standalone-ha.xml</code>
You can read more about available JBoss configurations [https://access.redhat.com/documentation/en-US/JBoss_Enterprise_Application_Platform/6.4/html-single/Administration_and_Configuration_Guide/#sect-Configuration_Files here].

After the server was started, log into administration console, click '''Deployments''' link, next click the '''Add''' button and select <code>CKFinderJava.war</code> file. Once CKFinderJava.war upload is finished, verify its runtime name and check the '''Enable''' checkbox. The Application is now ready to use.

Another way of deploying the CKFinderJava application is using JBoss Command Line Interface (CLI). It has to be first launched using the <code>jboss-cli.sh</code> or <code>jboss-cli.bat</code> script located in the <code>EAP_HOME/bin</code> directory. Once this is done, you can deploy applications as in the example given below:
* '''In standalone mode:''' <code>[standalone@localhost:9999 /] deploy ~/Desktop/CKFinderJava.war</code>
* '''In domain mode:''' <code>[domain@localhost:9999 /] deploy ~/Desktop/ CKFinderJava.war --all-server-groups</code>
'''NOTE:''' Either <code>--all-server-groups</code> or <code>--server-groups</code> with specified server groups must be used. 

To learn more about CLI please see this [https://access.redhat.com/documentation/en-US/JBoss_Enterprise_Application_Platform/6.4/html-single/Administration_and_Configuration_Guide/#sect-The_Management_CLI link].

If your Server is running in the standalone mode, then aside from using the administration console and CLI, JBoss can also work in manual and auto deployment mode (this depends on your settings). 
In the '''Auto-Deploy mode''' the scanner directly monitors the deployment content, available in <code><nowiki>EAP_HOME/standalone/deployments</nowiki></code> directory, automatically deploying new content and redeploying content whose timestamp has changed. It means that you can simply drop CKFinderJava.war into deployments folder and the application will be deployed. 
To undeploy CKFinderJava in auto mode simply remove war file from deploy directory. 
In the '''Manual deploy mode''' the scanner does not directly monitor the deployment content. Instead, the scanner relies on a system of marker files, which the user can add to or remove from deployment directory. These files serve as a sort of command telling the scanner to deploy, undeploy, or redeploy the content. You can learn more about marker files under this [https://access.redhat.com/documentation/en-US/JBoss_Enterprise_Application_Platform/6.4/html-single/Administration_and_Configuration_Guide/#Reference_for_Deployment_Scanner_Marker_Files1 link].

To deploy <code>CKFinderJava.war</code> in manual mode, copy this file into the <code>EAP_HOME/standalone/deployments</code> directory and create the <code>CKFinderJava.war.dodeploy</code> file. CKFinder will be deployed and the <code>CKFinderJava.war.deployed</code> marker file will be created. To undeploy CKFinderJava simply remove <code>CKFinderJava.war.deployed</code> file.

Please note that by default JBoss EAP allows auto-deployment of zipped content and prevents auto-deployment of exploded content. This is because exploded content is vulnerable to the scanner trying to auto-deploy partially copied content. However, if you wish to change this behaviour, you can go to the <code><nowiki>EAP_HOME/standalone/configuration/standalone.xml</nowiki></code> file, look for the '''deployment-scanner'' tag and change the deployment options as you like:

<source lang="xml">
<deployment-scanner scan-interval="5000" relative-to="jboss.server.base.dir" path="deployments"
auto-deploy-zipped="true" auto-deploy-exploded="false"/>
</source>

By default, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>
Please note that the HTTP <code>8080</code> port of the sample URL is the default JBoss EAP port. If you changed this value while configuring your EAP installation, you will need to use a modified port value to run the sample application.

If you want to use international files names with CKFinder please see [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Configuration/URI_Encoding URI Encoding section] which explains how to set UTF-8 in JBOSS EAP.

Go to the JBoss EAP [https://access.redhat.com/documentation/en-US/JBoss_Enterprise_Application_Platform/6.4/html-single/Getting_Started_Guide/ Getting Started] and [https://access.redhat.com/documentation/en-US/JBoss_Enterprise_Application_Platform/6.4/html-single/Administration_and_Configuration_Guide/ Administration Guide] for more information about using this server.

=== GlassFish ===
The GlassFish server can be started from the command line. Go to the server <code>bin</code> folder and run the <code>asadmin</code> 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 <code>start-domain</code> 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: 

* <code>deploy relativePath/CKFinderJava.war</code>

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

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

By default, Glassfish has ISO parameter-encoding set, which may cause problems if your users want to use filenames with non-ISO characters. If CKFinder in your application is to be used worldwide, it is recommended to set UTF-8 for Glassfish. Please refer to the [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Configuration/URI_Encoding URI Encoding] section for more details.

Go to the Oracle [http://docs.oracle.com/cd/E19798-01/821-1757/index.html GlassFish 3.0] or, [http://docs.oracle.com/cd/E18930_01/html/821-2432/ GlassFish 3.1] or [https://glassfish.java.net/getstarted.html GlassFish 4.x] Server Quick Start Guide for more information about using this server.

=== Weblogic ===
The Weblogic Server (WLS) can be started from the command line. Go to the <code><nowiki>weblogic_main_folder/user_projects/domains/your_domain/bin</nowiki></code> folder and run the following script:
* Windows: <code>startWeblogic.cmd</code> or <code>startManagedWebLogic.cmd</code>
* Linux: <code>startWeblogic.sh</code> or <code>startManagedWebLogic.sh</code>
If Weblogic is in production mode then please remember that you need to specify the user name and password in order to run it.

As you probably know, Weblogic Server uses domains which are logically related groups of server resources. A domain can consist of an Administration Server and one or more Managed Servers, or of a single standalone server that acts as an Administration Server and runs deployed applications. In this example we are going to use a single standalone Administration Server.

After starting Weblogic, log into the Administration Console and click '''Deployments''' in the '''Domain Structure''' upper left menu. If WLS is in production mode, you need to click '''Lock&Edit''' first. In main panel click the '''Install''' button, specify the path to <code>CKFinderJava.war</code>, and click the '''Next''' button. Select the '''"Install this deployment as an application"''' option and press the '''Next''' button. In the last panel you can change the name of your deployment, the security model and the source accessibility. Once you are done, click the '''Finish''' button and CKFinderJava will be deployed. If WLS works in production mode, you will need to confirm all changes by clicking the '''Activate Changes''' button and start the application manually by selecting it and pressing the '''Start''' button.

By deafult, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:7001/CKFinderJava/</nowiki></code>

The HTTP <code>7001</code> port of the sample URL is the default Weblogic Administration Server port. If you changed this value while configuring your Weblogic domain(s), you will need to use a modified port value to run the sample application.

Go to the [http://docs.oracle.com/cd/E17904_01/index.htm Weblogic 11g] or [http://docs.oracle.com/cd/E24329_01/index.htm Weblogic 12c] Documentation site for more information about using this server.

CKFinder 2.x/Developers Guide/Java/Configuration/URI Encoding

2015-11-04T22:51:54Z

J.swiderski:

By default some servers use the ISO-8859-1 encoding for request parameters and request body. What is more, changing the encoding for request body on such servers has no influence on the encoding of the request parameters. This may cause problems if you want to use international file names with '''CKFinder which expects request body and parameters to be encoded in UTF-8'''. To overcome this issue you can either set UTF-8 URI encoding on the server or if you do not have enough privileges to do that, you can adjust CKFinder to use same URI encoding as your server. 
You will find more detailed instructions below.

===JBOSS 7===
By default this server uses ISO-8859-1 for parameter encoding. To change this to UTF-8, you have to modify the configuration file appropriate for the mode and configuration used. 
As you probably know, JBOSS 7 can run in two modes ("domain" and "standalone") and can use various configurations.
To simplify the example let us assume that the server uses the standalone mode and default configuration. In order to set UTF-8 for URI encoding you have to edit the <code><nowiki>JBOSS_HOME/standalone/configuration/standalone.xml</nowiki></code> file and add a system property named <code>org.apache.catalina.connector.URI_ENCODING</code>,(with value set to UTF-8) to the <code>system-properties</code> element. 
Below is the code that needs to be added to the configuration file you use:

<source lang="xml">
<system-properties>
<property name="org.apache.catalina.connector.URI_ENCODING" value="UTF-8"/>
</system-properties>
</source>

===GlassFish 3.0===
According to Glassfish 3.0 [http://docs.oracle.com/cd/E19798-01/821-1752/beafu/index.html documentation] default parameter encoding for requests is ISO-8859-1. To change this encoding to UTF-8 you have to use the sun-web.xml [http://docs.oracle.com/cd/E19798-01/821-1750/beaql/index.html file] with xml <code>parameter-encoding</code> element. This file has to be placed in the <code>WEB-INF</code> folder of your web application. 
CKFinder sample web application comes with such a file. If you are using Glassfish 3.0, want to use UTF-8, and to integrate CKFinder in to your application then apart from files mentioned in the [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Integration Integration] section, copy <code>sun-web.xml</code> as well. 
Below is the code for the <code>sun-web.xml</code> file:

<source lang="xml">
<!DOCTYPE sun-web-app PUBLIC "-//Sun Microsystems, Inc.//DTD GlassFish Application Server 3.0 Servlet 3.0//EN"
"http://www.sun.com/software/appserver/dtds/sun-web-app_3_0-0.dtd">
<sun-web-app>
<parameter-encoding default-charset="UTF-8" />
</sun-web-app>
</source>

===GlassFish 3.1+===
By default this [http://docs.oracle.com/cd/E18930_01/html/821-2418/beaft.html#beafu server] uses ISO-8859-1 for parameter encoding. In order to change this to UTF-8, you have to use the <code>glassfish-web.xml</code> [http://docs.oracle.com/cd/E18930_01/html/821-2417/beaql.html#scrolltoc file] with xml <code>parameter-encoding</code> element. This file has to be placed in the <code>WEB-INF</code> folder of the web application. 
CKFinder sample web application comes with such a file. If you are using Glassfish 3.1 or above, want to use UTF-8, and to integrate CKFinder in to your application then apart from files mentioned in the [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Integration Integration] section, copy <code>glassfish-web.xml</code> as well. 
Below is the code for the <code>glassfish-web.xml</code> file:
<source lang="xml">
<!DOCTYPE glassfish-web-app PUBLIC "-//GlassFish.org//DTD GlassFish Application Server 3.1 Servlet 3.0//EN"
"http://glassfish.org/dtds/glassfish-web-app_3_0-1.dtd">
<glassfish-web-app>
<parameter-encoding default-charset="UTF-8" />
</glassfish-web-app>
</source>

===Tomcat===
According to [http://wiki.apache.org/tomcat/FAQ/CharacterEncoding Tomcat FAQ], for handling HTTP requests by default Tomcat uses the ISO-8859-1 encoding.

Starting with version 5 for all <code>GET</code> requests, when the encoding type used is different from the default one, the query parameters are not encoded in the same way as the request body. To be more specific, if you want to use the encoding other than the default ISO-8859-1 (like UTF-8, for example), the <code>HttpServletRequest.setCharacterEncoding("UTF-8")</code> method will only be applied to the request body, and not the URI.

In order to encode the query parameters just like the requests, you should use the <code>URIEncoding="UTF-8"</code> attribute in the <code>Connector</code> element of the <code>Server.xml</code> file:
<source lang="xml">
<Connector port="8080" protocol="HTTP/1.1" connectionTimeout="20000" redirectPort="8443" URIEncoding="UTF-8" />
</source>

===Weblogic===
This server follows J2EE specification when it comes to encoding. This means that if no encoding is specified then default ISO-8859-1 is set for everything (Servlets, JSP, Tag Files) except for XML format files. 
Weblogic documentation provides a couple of ways for setting the encoding you want (UTF-8 in this case). There are server typical methods as well as general Servlet API methods. It seems the best way to set encoding in the WLS server is using [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html#setCharacterEncoding%28java.lang.String%29 setCharacterEncoding("UTF-8");] for requests and [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html#setCharacterEncoding%28java.lang.String%29 setCharacterEncoding("UTF-8");] or [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html#setContentType%28java.lang.String%29 setContentType("UTF-8");] for responses.

Please see this [http://otndnld.oracle.co.jp/document/products/wls/docs103/en/relnotes_ja.htmlotndnld.oracle.co.jp/document/products/wls/docs92/en/relnotes_ja.html link] (Web Components section) for more details on setting appropriate encoding on the server-side.

===Jetty===
The Jetty server uses UTF-8 by default. Jetty [http://wiki.eclipse.org/Jetty/Howto/International_Characters#Characters_included_in_HTTP_requests documentation] states if no overriding character encoding is set on a request, Jetty uses UTF-8 encoding.

===Alternative Solution (CKFinder Adjustment)===
'''By default, CKFinder uses the UTF-8 encoding, so you should stick to the guidelines presented above in order to make it work properly.'''

If you cannot or do not want to set this parameter in the server configuration file, CKFinder will try to address this problem for you. This is why the <code>uriEncoding</code> configuration element was created in the <code>config.xml<code> file. This parameter accepts the encoding of your query parameters. 
For example, for Tomcat, JBoss, Glassfish, and Weblogic with their default configuration set (which is ISO-8859-1) you should set uriEncoding to ISO-8859-1 and CKFinder will convert the query parameters for you.

<source lang="xml">
<uriEncoding>ISO-8859-1</uriEncoding>
</source>

CKFinder 2.x/Developers Guide/Java/Installation

2015-11-04T08:30:25Z

J.swiderski:

__TOC__
{{#CUSTOMTITLE:CKFinder Installation}}
This article describes how to install CKFinder for Java.

== Installation Procedure ==
To install CKFinder, download the CKFinder for Java distribution package (a <code>.war</code> file) from the [http://ckfinder.com/download official download site]. 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 <code>_samples</code> folder of the distribution package. After the deployment open the <code>_samples/index.html</code> 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 <code>config.xml</code> file where you can customize your application. See the [[CKFinder_2.x/Developers Guide/Java/Configuration|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.
<source lang="xml">
<enabled>true</enabled>
</source>

== Deployment on a Server ==
The CKFinder Java connector supports the following servers:
* Tomcat 6-8,
* Jetty 9,
* WildFly (former JBoss AS) 8-9,
* JBoss EAP 6,
* GlassFish 3-4,
* Weblogic 11g-12c.
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 <code>.war</code> file in the Tomcat <code>webapps</code> folder. Go to Tomcat <code>bin</code> folder and run the startup script file for your operating system — <code>startup.bat</code> for Windows or <code>startup.sh</code> for Linux. When you are running Tomcat as a service, restart the server.

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

Go to the [http://wiki.apache.org/tomcat/FAQ Tomcat FAQ] and [http://tomcat.apache.org/tomcat-6.0-doc/index.html Tomcat 6], or [http://tomcat.apache.org/tomcat-7.0-doc/index.html Tomcat 7], or [http://tomcat.apache.org/tomcat-8.0-doc/index.html Tomcat 8] documentation for more information about using this server.

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

By default Jetty unpacks war files to folders like <code><nowiki>C:\Users\admin\AppData\Local\Temp\jetty-0.0.0.0-8080-CKFinderJava.war-_CKFinderJava-any-\webapp\</nowiki></code>. Information about this folder is displayed in the output console, when application is deployed. If you wish to change this folder, you can either put the unpacked <code>CKFinderJava.war</code> file in the webapps folder (Jetty will use the unpacked application folder) or go to <code><nowiki>jetty9\etc\jetty-deploy.xml</nowiki></code> and set the below parameter to the folder path of your choice:

<source lang="xml"><Set name="tempDir"><New class="java.io.File"><Arg>C:\tmp</Arg></New></Set></source>

Go to the [http://www.eclipse.org/jetty/documentation/current/quick-start.html Jetty 9] Quick Start guide for more information about using this server.

=== WildFly ===
The server can be started from the command line. Go to the WildFly <code>bin</code> folder and run the following command:
* Windows: <code>standalone.bat</code> or <code>domain.bat</code>
* Linux: <code>standalone.sh</code> or <code>domain.sh</code>

WildFly Application Server can run in two modes: standalone and domain. First one allows running a single standalone Server, while the latter is used to manage multiple physical (or virtual) machines from a single control point. 
'''NOTE:''' In this example we are going to work with a standalone server.

The above two commands start server with its default configurations. If one wishes to start the server with one of alternative configurations, one should pass the <code>--server-config</code> argument with the server configuration file to be used. The example below shows how to run the full profile configuration with high availability:
* Windows: <code>standalone.bat --server-config=standalone-ha.xml</code>
* Linux: <code>standalone.sh --server-config=standalone-ha.xml</code>
You can read more about available WildFly configurations [https://docs.jboss.org/author/display/WFLY9/Getting+Started+Guide#GettingStartedGuide-WildFly8Configurations here].

After the server was started, log into administration console, click '''Deployments''' link, next click the '''Add''' button, select '''Upload a new deployment''' radio button, click '''Next''' and select <code>CKFinderJava.war</code> file. Once CKFinderJava.war upload is finished, verify its runtime name and check the '''Enable''' checkbox. The Application is now ready to use.

Another way of deploying the CKFinderJava application is using WildFly Command Line Interface (CLI). It has to be first launched using the <code>jboss-cli.sh</code> or <code>jboss-cli.bat</code> script located in <code>JBOSS_HOME/bin</code> directory. Once this is done, you can deploy applications as in the example given below:
* '''In standalone mode:''' <code>[standalone@localhost:9999 /] deploy ~/Desktop/CKFinderJava.war</code>
* '''In domain mode:''' <code>[domain@localhost:9999 /] deploy ~/Desktop/ CKFinderJava.war --all-server-groups</code>
'''NOTE:''' Either <code>--all-server-groups</code> or <code>--server-groups</code> with specified server groups must be used. 

To learn more about CLI please see this [https://docs.jboss.org/author/display/WFLY9/Admin+Guide#AdminGuide-CommandLineInterface link].

If your Server is running in the standalone mode, then aside from using the administration console and CLI, WildFly can also work in manual and auto deployment mode (this depends on your settings). 
In the '''Auto-Deploy mode''' the scanner directly monitors the deployment content, available in <code><nowiki>JBOSS_HOME/standalone/deployments</nowiki></code> directory, automatically deploying new content and redeploying content whose timestamp has changed. It means that you can simply drop CKFinderJava.war into deployments folder and the application will be deployed. 
To undeploy CKFinderJava in auto mode simply remove war file from deploy directory. 
In the '''Manual deploy mode''' the scanner does not directly monitor the deployment content. Instead, the scanner relies on a system of marker files, which the user can add to or remove from deployment directory. These files serve as a sort of command telling the scanner to deploy, undeploy, or redeploy the content. You can learn more about marker files in the "Marker Files" section available under this [https://docs.jboss.org/author/display/WFLY8/Application+deployment link].

To deploy <code>CKFinderJava.war</code> in manual mode, copy this file into the <code>JBOSS_HOME/standalone/deployments</code> directory and create the <code>CKFinderJava.war.dodeploy</code> file. CKFinder will be deployed and the <code>CKFinderJava.war.deployed</code> marker file will be created. To undeploy CKFinderJava simply remove <code>CKFinderJava.war.deployed</code> file.

Please note that by default WildFly allows auto-deployment of zipped content and prevents auto-deployment of exploded content. This is because exploded content is vulnerable to the scanner trying to auto-deploy partially copied content. However, if you wish to change this behavior, you can go to the <code><nowiki>JBOSS_HOME/standalone/configuration/standalone.xml</nowiki></code> file, look for the '''deployment-scanner'' tag and change the deployment options as you like:

<source lang="xml">
<deployment-scanner scan-interval="5000" relative-to="jboss.server.base.dir" path="deployments"
auto-deploy-zipped="true" auto-deploy-exploded="false"/>
</source>

By default, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>
Please note that the HTTP <code>8080</code> port of the sample URL is the default WildFly port. If you changed this value while configuring your WildFly installation, you will need to use a modified port value to run the sample application.

If you want to use international files names with CKFinder please see [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Configuration/URI_Encoding URI Encoding section] which explains how to set UTF-8 on WildFly.

Go to the WildFly [https://docs.jboss.org/author/display/WFLY9/Getting+Started+Guide Getting Started] and [https://docs.jboss.org/author/display/WFLY9/Admin+Guide Administration Guide] for more information about using this server.

=== JBoss EAP 6 ===
The server can be started from the command line. Go to the JBoss Enterprise Application Platform (EAP) <code>bin</code> folder and run the following command:
* Windows: <code>standalone.bat</code> or <code>domain.bat</code>
* Linux: <code>standalone.sh</code> or <code>domain.sh</code>

JBoss EAP can run in two modes: standalone and domain. First one allows running a single standalone Server, while the latter is used to manage multiple physical (or virtual) machines from a single control point. 
'''NOTE:''' In this example we are going to work with a standalone server.

The above two commands start server with its default configurations. If one wishes to start the server with one of alternative configurations, one should pass the <code>--server-config</code> argument with the server configuration file to be used. The example below shows how to run the full profile configuration with high availability:
* Windows: <code>standalone.bat --server-config=standalone-ha.xml</code>
* Linux: <code>standalone.sh --server-config=standalone-ha.xml</code>
You can read more about available JBoss configurations [https://access.redhat.com/documentation/en-US/JBoss_Enterprise_Application_Platform/6.4/html-single/Administration_and_Configuration_Guide/#sect-Configuration_Files here].

After the server was started, log into administration console, click '''Deployments''' link, next click the '''Add''' button and select <code>CKFinderJava.war</code> file. Once CKFinderJava.war upload is finished, verify its runtime name and check the '''Enable''' checkbox. The Application is now ready to use.

Another way of deploying the CKFinderJava application is using JBoss Command Line Interface (CLI). It has to be first launched using the <code>jboss-cli.sh</code> or <code>jboss-cli.bat</code> script located in the <code>EAP_HOME/bin</code> directory. Once this is done, you can deploy applications as in the example given below:
* '''In standalone mode:''' <code>[standalone@localhost:9999 /] deploy ~/Desktop/CKFinderJava.war</code>
* '''In domain mode:''' <code>[domain@localhost:9999 /] deploy ~/Desktop/ CKFinderJava.war --all-server-groups</code>
'''NOTE:''' Either <code>--all-server-groups</code> or <code>--server-groups</code> with specified server groups must be used. 

To learn more about CLI please see this [https://access.redhat.com/documentation/en-US/JBoss_Enterprise_Application_Platform/6.4/html-single/Administration_and_Configuration_Guide/#sect-The_Management_CLI link].

If your Server is running in the standalone mode, then aside from using the administration console and CLI, JBoss can also work in manual and auto deployment mode (this depends on your settings). 
In the '''Auto-Deploy mode''' the scanner directly monitors the deployment content, available in <code><nowiki>EAP_HOME/standalone/deployments</nowiki></code> directory, automatically deploying new content and redeploying content whose timestamp has changed. It means that you can simply drop CKFinderJava.war into deployments folder and the application will be deployed. 
To undeploy CKFinderJava in auto mode simply remove war file from deploy directory. 
In the '''Manual deploy mode''' the scanner does not directly monitor the deployment content. Instead, the scanner relies on a system of marker files, which the user can add to or remove from deployment directory. These files serve as a sort of command telling the scanner to deploy, undeploy, or redeploy the content. You can learn more about marker files under this [https://access.redhat.com/documentation/en-US/JBoss_Enterprise_Application_Platform/6.4/html-single/Administration_and_Configuration_Guide/#Reference_for_Deployment_Scanner_Marker_Files1 link].

To deploy <code>CKFinderJava.war</code> in manual mode, copy this file into the <code>EAP_HOME/standalone/deployments</code> directory and create the <code>CKFinderJava.war.dodeploy</code> file. CKFinder will be deployed and the <code>CKFinderJava.war.deployed</code> marker file will be created. To undeploy CKFinderJava simply remove <code>CKFinderJava.war.deployed</code> file.

Please note that by default JBoss EAP allows auto-deployment of zipped content and prevents auto-deployment of exploded content. This is because exploded content is vulnerable to the scanner trying to auto-deploy partially copied content. However, if you wish to change this behaviour, you can go to the <code><nowiki>EAP_HOME/standalone/configuration/standalone.xml</nowiki></code> file, look for the '''deployment-scanner'' tag and change the deployment options as you like:

<source lang="xml">
<deployment-scanner scan-interval="5000" relative-to="jboss.server.base.dir" path="deployments"
auto-deploy-zipped="true" auto-deploy-exploded="false"/>
</source>

By default, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>
Please note that the HTTP <code>8080</code> port of the sample URL is the default JBoss EAP port. If you changed this value while configuring your EAP installation, you will need to use a modified port value to run the sample application.

If you want to use international files names with CKFinder please see [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Configuration/URI_Encoding URI Encoding section] which explains how to set UTF-8 on JBOSS EAP.

Go to the JBoss EAP [https://access.redhat.com/documentation/en-US/JBoss_Enterprise_Application_Platform/6.4/html-single/Getting_Started_Guide/ Getting Started] and [https://access.redhat.com/documentation/en-US/JBoss_Enterprise_Application_Platform/6.4/html-single/Administration_and_Configuration_Guide/ Administration Guide] for more information about using this server.

=== GlassFish ===
The GlassFish server can be started from the command line. Go to the server <code>bin</code> folder and run the <code>asadmin</code> 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 <code>start-domain</code> 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: 

* <code>deploy relativePath/CKFinderJava.war</code>

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

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

By default, Glassfish has ISO parameter-encoding set, which may cause problems if your users want to use filenames with non-ISO characters. If CKFinder in your application is to be used worldwide, it is recommended to set UTF-8 for Glassfish. Please refer to the [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Configuration/URI_Encoding URI Encoding] section for more details.

Go to the Oracle [http://docs.oracle.com/cd/E19798-01/821-1757/index.html GlassFish 3.0] or, [http://docs.oracle.com/cd/E18930_01/html/821-2432/ GlassFish 3.1] or [https://glassfish.java.net/getstarted.html GlassFish 4.x] Server Quick Start Guide for more information about using this server.

=== Weblogic ===
The Weblogic Server (WLS) can be started from the command line. Go to the <code><nowiki>weblogic_main_folder/user_projects/domains/your_domain/bin</nowiki></code> folder and run the following script:
* Windows: <code>startWeblogic.cmd</code> or <code>startManagedWebLogic.cmd</code>
* Linux: <code>startWeblogic.sh</code> or <code>startManagedWebLogic.sh</code>
If Weblogic is in production mode then please remember that you need to specify the user name and password in order to run it.

As you probably know, Weblogic Server uses domains which are logically related groups of server resources. A domain can consist of an Administration Server and one or more Managed Servers, or of a single standalone server that acts as an Administration Server and runs deployed applications. In this example we are going to use a single standalone Administration Server.

After starting Weblogic, log into the Administration Console and click '''Deployments''' in the '''Domain Structure''' upper left menu. If WLS is in production mode, you need to click '''Lock&Edit''' first. In main panel click the '''Install''' button, specify the path to <code>CKFinderJava.war</code>, and click the '''Next''' button. Select the '''"Install this deployment as an application"''' option and press the '''Next''' button. In the last panel you can change the name of your deployment, the security model and the source accessibility. Once you are done, click the '''Finish''' button and CKFinderJava will be deployed. If WLS works in production mode, you will need to confirm all changes by clicking the '''Activate Changes''' button and start the application manually by selecting it and pressing the '''Start''' button.

By deafult, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:7001/CKFinderJava/</nowiki></code>

The HTTP <code>7001</code> port of the sample URL is the default Weblogic Administration Server port. If you changed this value while configuring your Weblogic domain(s), you will need to use a modified port value to run the sample application.

Go to the [http://docs.oracle.com/cd/E17904_01/index.htm Weblogic 11g] or [http://docs.oracle.com/cd/E24329_01/index.htm Weblogic 12c] Documentation site for more information about using this server.

CKFinder 2.x/Developers Guide/Java/Configuration/baseURL and baseDir

2015-11-04T08:23:23Z

J.swiderski:

{{#CUSTOMTITLE:baseDir and baseURL Parameters Explained}}
__TOC__
Both <code>baseDir</code> and <code>baseURL</code> should point to the same location on the server — the <code>userfiles</code> directory that contains all user files uploaded with CKFinder. The difference between them is as follows:
* <code>baseURL</code> gives a full URL to the <code>userfiles</code> directory or a path that is ''relative'' to the domain. For example:
*; <source lang="xml"><baseURL>http://example.com/CKFinderJava/userfiles/</baseURL></source>
*; <source lang="xml"><baseURL>/CKFinderJava/userfiles/</baseURL></source>
* <code>baseDir</code> gives an ''absolute'' path to the directory on the server (a physical machine). For example:
*; <source lang="xml"><baseDir>/usr/tomcat/webapps/CKFinderJava/userfiles/</baseDir></source>
*; <source lang="xml"><baseDir>C:\tomcat\webapps\CKFinderJava\userfiles\</baseDir></source>

You may ask: why use two paths to point to one location?

The <code>baseURL</code> parameter represents the path that is used by HTTP clients. It is employed for example when CKFinder returns the URL addresses of the files.

CKFinder itself is not an HTTP client, but an application that operates on server-based files that needs absolute paths to these files to operate correctly. A specific server configuration may sometimes lead to problems with setting the absolute path based on the <code>baseURL</code> parameter, which leads to the malfunctioning of the application. This is where the <code>baseDir</code> parameter that contains the direct path to the <code>userfiles</code> directory may help.

== Misconfiguration of baseURL and baseDir ==
Since setting the parameters may sometimes seem counter-intuitive, especially for the beginners, here are a couple of examples of CKFinder misconfiguration, i.e. the situation where the <code>baseURL</code> and <code>baseDir</code> settings were wrong.

=== Example 1: Using a Relative Path for baseDir ===
<source lang="xml">

<baseDir>/userfiles/</baseDir>
<baseURL>/CKFinderJava/userfiles/</baseURL>
</source>

In this example the <code>baseDir</code> parameter contains the relative (and not absolute) path to the <code>userfiles</code> directory. In a Windows system with this configuration the <code>userfiles</code> directory will be created on the same partition that hosts the server (for example, <code>C:\userfiles</code>). On a Linux machine the system will try to create a <code>/userfiles/</code> directory which will probably fail due to missing server permissions to create new directories in <code>/</code>.

=== Example 2: Incoherent Directory Paths ===
<source lang="xml">

<baseDir>C:\userfiles</baseDir>
<baseURL>/CKFinderJava/userfiles/</baseURL>
</source>

In this example <code>baseDir</code> is set to an absolute path, but the parameter points to a different location than <code>baseURL</code> that is set relative to the application root.

=== Result: CKFinder Misconfiguration ===
In both examples the parameters point to different server directories. As a result, some CKFinder features may not work correctly. The '''View''' function, for example, will be one of them.

Why is that so?

As mentioned above, CKFinder works on files and for this it uses the <code>baseDir</code> parameter value. All uploaded files will thus be placed in the location that is set in this parameter. HTTP clients, on the other hand, will use the <code>baseURL</code> value, but in both examples presented above this parameter will point to a non-existent location which in some cases may lead to a lack of access to files.

== BaseDir and BaseUrl best practice ==
<note>It is always recommended to set both <code>baseUrl</code> and <code>baseDir</code> so that they point to same location which is outside of an application directory.</note>

In previous section, we have seen what problems we may get when these two properties are misconfigured but what will happen when only <code>baseUrl</code> is set? CKFinder needs both, <code>baseUrl</code> and <code>baseDir</code> to work correctly and if <code>baseDir</code> is missing, CKFinder will try to determine its value based on the <code>baseUrl</code> property. You must know however that CKFinder has limited capabilities in this case. To be more precise, CKFinder is mainly limited to application context (application main directory).
Let’s have a look at few examples:
<source lang="xml">
<baseURL>/userfiles/</baseURL>
<baseDir></baseDir>

<baseURL>http://example.com/userfiles/</baseURL>
<baseDir></baseDir>
</source>

In both above cases the <code>userfiles</code> folder points to server’s main applications directory. When multiple applications are kept on server they are accessible like <code><nowiki>http://example.com/CKFinderJava-2.5</nowiki></code> or <code><nowiki>http://example.com/CKFinderJava-2.4</nowiki></code>. As you can probably see the <code>userfiles</code> folder should be created on same level as applications in order to be accessible through HTTP. The problem is that applications folder is not accessible from the web. There are however two servers which have general accessible folders and to which CKFinder can get. These servers are Apache Tomcat and Oracle GlassFish. Having configuration like presented above, starting from CKFinder 2.5.1, CKFinder will create <code>userfiles</code> folder in <code>TOMCAT_HOME/webapps/ROOT</code> directory for Apache Tomcat and <code>GLASSFISH_HOME/glassfish/domains/domain_name/docroot </code> directory for Oracle GlassFish. Everything will work as expected in this case. For other supported servers, CKFinder will use fallback approach and create <code>userfiles</code> folder inside <code>CKFinderJava</code> application directory. As you probably know, this will unfortunately result in View option not working properly.

Let’s take a look at another example:
<source lang="xml">
<baseURL>/CKFinderJava/userfiles/</baseURL>
<baseDir></baseDir>
</source>

Above setting will create <code>userfiles</code> inside <code>CKFinderJava</code> application directory. Although such configuration will work on every server there is a caveat to that approach. It isn’t recommended to put folder for uploaded files into deployed application folder because with every redeployment (e.g. when upgrading <code>war</code> to new version) of the application, the upload folder will be removed.
So, what should be done to set <code>baseUrl</code> and <code>baseDir</code> correctly? 

<note>
First of all you should set both properties so that they point to same location which is accessible through <code>HTTP</code> and from <code> the file system</code>. Second, you should set these properties to point to location outside of CKFinder application folder.</note>

One solution is using [https://en.wikipedia.org/wiki/Symbolic_link symlinks]. The <code>userfiles</code> folder located inside application context can be a symbolic link to some other directory on the disk. With that simple approach <code>/CKFinderJava/userfiles/</code> can point to folder of your choice. One downside of this technique is that you have to recreate the symbolic link with every application redeploy as the symlink gets removed on redeployment.

Another solution is using server features. Most of the servers provide "virtual directory" mechanism. A "Virtual Directory" allows accessing through <code>HTTP</code> a folder which can be located even outside of the server. In Tomcat 7-8 this can be done through aliases, in Tomcat 6 by adding another context to <code>server.xml</code>, in GlassFish through alternate docroots, in Jetty by adding another context to <code>jetty.xml</code> and In Weblogic through virtual directories. 

Let’s have a look at an example for Apache Tomcat 8. The server is installed in <code>C:/Apache-Tomcat-8/</code> directory, CKFinderJava is installed in <code>C:/Apache-Tomcat-8/CKFinderJava</code>, we want to have our <code>userfiles</code> folder located directly on <code>C</code> drive and we want that folder to be called <code>"myimages"</code>. Here are the settings that will allow having all CKFinder features working, and <code>userfiles</code> folder not being removed with every redeployment of the application:

CKFinder config.xml settings:
<source lang="xml">
<baseDir>C:/myimages</baseDir>
<baseURL>/CKFinderJava/userfiles/</baseURL>
</source>

CKFinderJava/META-INF/context.xaml settings:
<source lang="xml">
<Context antiJARLocking="true" path="/CKFinderJava" reloadable="true" >
<Resources>
<PreResources base="C://myimages" className="org.apache.catalina.webresources.DirResourceSet" webAppMount="/userfiles" />
</Resources>
<Valve className="org.apache.catalina.valves.RemoteAddrValve" allow=".*" />
</Context>
</source>
With the help of the server and two configuration changes, you can have your files being saved to <code>C:/myimages</code> folder. It’s also worth mentioning that <code>myimages</code> directory is invisible to end user and Tomcat serves files as if they really were located inside <code> CKFinderJava/userfiles/</code>.

CKFinder 2.x/Developers Guide/Java/Configuration/baseURL and baseDir

2015-11-03T22:44:36Z

J.swiderski:

{{#CUSTOMTITLE:baseDir and baseURL Parameters Explained}}
__TOC__
Both <code>baseDir</code> and <code>baseURL</code> should point to the same location on the server — the <code>userfiles</code> directory that contains all user files uploaded with CKFinder. The difference between them is as follows:
* <code>baseURL</code> gives a full URL to the <code>userfiles</code> directory or a path that is ''relative'' to the domain. For example:
*; <source lang="xml"><baseURL>http://example.com/CKFinderJava/userfiles/</baseURL></source>
*; <source lang="xml"><baseURL>/CKFinderJava/userfiles/</baseURL></source>
* <code>baseDir</code> gives an ''absolute'' path to the directory on the server (a physical machine). For example:
*; <source lang="xml"><baseDir>/usr/tomcat/webapps/CKFinderJava/userfiles/</baseDir></source>
*; <source lang="xml"><baseDir>C:\tomcat\webapps\CKFinderJava\userfiles\</baseDir></source>

You may ask: why use two paths to point to one location?

The <code>baseURL</code> parameter represents the path that is used by HTTP clients. It is employed for example when CKFinder returns the URL addresses of the files.

CKFinder itself is not an HTTP client, but an application that operates on server-based files that needs absolute paths to these files to operate correctly. A specific server configuration may sometimes lead to problems with setting the absolute path based on the <code>baseURL</code> parameter, which leads to the malfunctioning of the application. This is where the <code>baseDir</code> parameter that contains the direct path to the <code>userfiles</code> directory may help.

== Misconfiguration of baseURL and baseDir ==
Since setting the parameters may sometimes seem counter-intuitive, especially for the beginners, here are a couple of examples of CKFinder misconfiguration, i.e. the situation where the <code>baseURL</code> and <code>baseDir</code> settings were wrong.

=== Example 1: Using a Relative Path for baseDir ===
<source lang="xml">

<baseDir>/userfiles/</baseDir>
<baseURL>/CKFinderJava/userfiles/</baseURL>
</source>

In this example the <code>baseDir</code> parameter contains the relative (and not absolute) path to the <code>userfiles</code> directory. In a Windows system with this configuration the <code>userfiles</code> directory will be created on the same partition that hosts the server (for example, <code>C:\userfiles</code>). On a Linux machine the system will try to create a <code>/userfiles/</code> directory which will probably fail due to missing server permissions to create new directories in <code>/</code>.

=== Example 2: Incoherent Directory Paths ===
<source lang="xml">

<baseDir>C:\userfiles</baseDir>
<baseURL>/CKFinderJava/userfiles/</baseURL>
</source>

In this example <code>baseDir</code> is set to an absolute path, but the parameter points to a different location than <code>baseURL</code> that is set relative to the application root.

=== Result: CKFinder Misconfiguration ===
In both examples the parameters point to different server directories. As a result, some CKFinder features may not work correctly. The '''View''' function, for example, will be one of them.

Why is that so?

As mentioned above, CKFinder works on files and for this it uses the <code>baseDir</code> parameter value. All uploaded files will thus be placed in the location that is set in this parameter. HTTP clients, on the other hand, will use the <code>baseURL</code> value, but in both examples presented above this parameter will point to a non-existent location which in some cases may lead to a lack of access to files.

== BaseDir and BaseUrl best practice ==
<note>It is always recommended to set both <code>baseUrl</code> and <code>baseDir</code> so that they point to same location which is outside of application directory.</note>

In previous section, we have seen what problems we may get when these two properties are misconfigured but what will happen when only <code>baseUrl</code> is set? CKFinder needs both, <code>baseUrl</code> and <code>baseDir</code> to work correctly and if <code>baseDir</code> is missing, CKFinder will try to determine its value based on <code>baseUrl</code>. You must know however that CKFinder has limited capabilities in this case. To be more precise, CKFinder is mainly limited to application context (application main directory).
Let’s have a look at few examples:
<source lang="xml">
<baseURL>/userfiles/</baseURL>
<baseDir></baseDir>

<baseURL>http://example.com/userfiles/</baseURL>
<baseDir></baseDir>
</source>

In both above cases the <code>userfiles</code> folder points to server’s main applications directory. When multiple applications are kept on server they are accessible like <code><nowiki>http://example.com/CKFinderJava-2.5</nowiki></code> or <code><nowiki>http://example.com/CKFinderJava-2.4</nowiki></code>. As you can probably see the <code>userfiles</code> folder should be created on same level as applications in order to be accessible through HTTP. The problem is that applications folder is not accessible from the web. There are however two servers which have general accessible folders and to which CKFinder can get. These servers are Apache Tomcat and Oracle GlassFish. Having configuration like presented above, starting from CKFinder 2.5.1, CKFinder will create <code>userfiles</code> folder in <code>TOMCAT_HOME/webapps/ROOT</code> directory for Apache Tomcat and <code>GLASSFISH_HOME/glassfish/domains/domain_name/docroot </code> directory for Oracle GlassFish. Everything will work as expected in this case. For other supported servers, CKFinder will use fallback approach and create <code>userfiles</code> folder inside <code>CKFinderJava</code>application directory. As you probably know, this will unfortunately result in View option not working properly.

Let’s take a look at another example:
<source lang="xml">
<baseURL>/CKFinderJava/userfiles/</baseURL>
<baseDir></baseDir>
</source>

Above setting will create <code>userfiles</code> inside <code>CKFinderJava</code> application directory. Although such configuration will work on every server there is a caveat to that approach. It isn’t recommended to put folder for uploaded files into deployed application folder because with every redeployment (e.g. when upgrading <code>war</code> to new version) of the application, the upload folder will be removed.
So, what should be done to set <code>baseUrl</code> and <code>baseDir</code> correctly? 

<note>
First of all you should set both properties so that they point to same location which is accessible through <code>HTTP</code> and from <code> the file system</code>. Second, you should set these properties to point to location outside of CKFinder application folder.</note>

One solution is using [https://en.wikipedia.org/wiki/Symbolic_link symlinks]. The <code>userfiles</code> folder located inside application context can be a symbolic link to some other directory on the disk. With that simple approach <code>/CKFinderJava/userfiles/</code> can point to folder of your choice. One downside of this technique is that you have to recreate the symbolic link with every application redeploy as the symlink gets removed on redeployment.

Another and better one solution is using server features. Most of the servers provide "virtual directory" mechanism. A "Virtual Directory" allows accessing folder which can be located even outside of the server, through <code>HTTP</code>. In Tomcat 7-8 this can be done through aliases, in Tomcat 6 by adding another context to <code>server.xml</code>, in GlassFish through alternate docroots, in Jetty by adding another context to <code>jetty.xml</code> and In Weblogic through virtual directories. 

Let’s have a look at an example for Apache Tomcat 8. The server is installed in <code>C:/Apache-Tomcat-8/</code> directory, CKFinderJava is installed in <code>C:/Apache-Tomcat-8/CKFinderJava</code>, we want to have our <code>userfiles</code> folder located directly on <code>C</code> drive and we want that folder to be called <code>"myimages"</code>. Here are the settings that will allow having all CKFinder features working, and <code>userfiles</code> folder not being removed with every redeployment of the application:

CKFinder config.xml settings:
<source lang="xml">
<baseDir>C:/myimages</baseDir>
<baseURL>/CKFinderJava/userfiles/</baseURL>
</source>

CKFinderJava/META-INF/context.xaml settings:
<source lang="xml">
<Context antiJARLocking="true" path="/CKFinderJava" reloadable="true" >
<Resources>
<PreResources base="C://myimages" className="org.apache.catalina.webresources.DirResourceSet" webAppMount="/userfiles" />
</Resources>
<Valve className="org.apache.catalina.valves.RemoteAddrValve" allow=".*" />
</Context>
</source>
With the help of the server and two configuration changes, you can have your files being saved to <code>C:/myimages</code> folder. It’s also worth mentioning that <code>myimages</code> directory is invisible to end user and Tomcat serves files as if they really were located inside <code> CKFinderJava/userfiles/</code>.

CKFinder 2.x/Developers Guide/Java/Configuration/baseURL and baseDir

2015-11-03T22:25:50Z

J.swiderski:

{{#CUSTOMTITLE:baseDir and baseURL Parameters Explained}}
__TOC__
Both <code>baseDir</code> and <code>baseURL</code> should point to the same location on the server — the <code>userfiles</code> directory that contains all user files uploaded with CKFinder. The difference between them is as follows:
* <code>baseURL</code> gives a full URL to the <code>userfiles</code> directory or a path that is ''relative'' to the domain. For example:
*; <source lang="xml"><baseURL>http://example.com/CKFinderJava/userfiles/</baseURL></source>
*; <source lang="xml"><baseURL>/CKFinderJava/userfiles/</baseURL></source>
* <code>baseDir</code> gives an ''absolute'' path to the directory on the server (a physical machine). For example:
*; <source lang="xml"><baseDir>/usr/tomcat/webapps/CKFinderJava/userfiles/</baseDir></source>
*; <source lang="xml"><baseDir>C:\tomcat\webapps\CKFinderJava\userfiles\</baseDir></source>

You may ask: why use two paths to point to one location?

The <code>baseURL</code> parameter represents the path that is used by HTTP clients. It is employed for example when CKFinder returns the URL addresses of the files.

CKFinder itself is not an HTTP client, but an application that operates on server-based files that needs absolute paths to these files to operate correctly. A specific server configuration may sometimes lead to problems with setting the absolute path based on the <code>baseURL</code> parameter, which leads to the malfunctioning of the application. This is where the <code>baseDir</code> parameter that contains the direct path to the <code>userfiles</code> directory may help.

== Misconfiguration of baseURL and baseDir ==
Since setting the parameters may sometimes seem counter-intuitive, especially for the beginners, here are a couple of examples of CKFinder misconfiguration, i.e. the situation where the <code>baseURL</code> and <code>baseDir</code> settings were wrong.

=== Example 1: Using a Relative Path for baseDir ===
<source lang="xml">

<baseDir>/userfiles/</baseDir>
<baseURL>/CKFinderJava/userfiles/</baseURL>
</source>

In this example the <code>baseDir</code> parameter contains the relative (and not absolute) path to the <code>userfiles</code> directory. In a Windows system with this configuration the <code>userfiles</code> directory will be created on the same partition that hosts the server (for example, <code>C:\userfiles</code>). On a Linux machine the system will try to create a <code>/userfiles/</code> directory which will probably fail due to missing server permissions to create new directories in <code>/</code>.

=== Example 2: Incoherent Directory Paths ===
<source lang="xml">

<baseDir>C:\userfiles</baseDir>
<baseURL>/CKFinderJava/userfiles/</baseURL>
</source>

In this example <code>baseDir</code> is set to an absolute path, but the parameter points to a different location than <code>baseURL</code> that is set relative to the application root.

=== Result: CKFinder Misconfiguration ===
In both examples the parameters point to different server directories. As a result, some CKFinder features may not work correctly. The '''View''' function, for example, will be one of them.

Why is that so?

As mentioned above, CKFinder works on files and for this it uses the <code>baseDir</code> parameter value. All uploaded files will thus be placed in the location that is set in this parameter. HTTP clients, on the other hand, will use the <code>baseURL</code> value, but in both examples presented above this parameter will point to a non-existent location which in some cases may lead to a lack of access to files.

== BaseDir and BaseUrl best practice ==
<note>It is always recommended to set both <code>baseUrl</code> and <code>baseDir</code> so that they point to same location which is outside of application directory.</note>

In previous section, we have seen what problems we may get when these two properties are misconfigured but what will happen when only <code>baseUrl</code> is set? CKFinder needs both, <code>baseUrl</code> and <code>baseDir</code> to work correctly and if <code>baseDir</code> is missing, CKFinder will try to determine its value based on <code>baseUrl</code>. You must know however that CKFinder has limited capabilities in this case. To be more precise, CKFinder is mainly limited to application context (application main directory).
Let’s have a look at few examples:
<source lang="xml">
<baseURL>/userfiles/</baseURL>
<baseDir></baseDir>

<baseURL>http://example.com/userfiles/</baseURL>
<baseDir></baseDir>
</source>

In both above cases the <code>userfiles</code> folder points to server’s main applications directory. When multiple applications are kept on server they are accessible like <code><nowiki>http://example.com/CKFinderJava-2.5</nowiki></code> or <code><nowiki>http://example.com/CKFinderJava-2.4</nowiki></code>. As you can probably see the <code>userfiles</code> folder should be created on same level as applications in order to be accessible through HTTP. The problem is that applications folder is not accessible from the web. There are however two servers which have general accessible folders and to which CKFinder can get. These servers are Apache Tomcat and Oracle GlassFish. Having configuration like presented above, starting from CKFinder 2.5.1, CKFinder will create <code>userfiles</code> folder in <code>TOMCAT_HOME/webapps/ROOT</code> directory for Apache Tomcat and <code>GLASSFISH_HOME/glassfish/domains/domain_name/docroot </code> directory for Oracle GlassFish. Everything will work as expected in this case. For other supported servers, CKFinder will use fallback approach and create <code>userfiles</code> folder inside <code>CKFinderJava</code>application directory. As you probably know, this will unfortunately result in View option not working properly.

Let’s take a look at another example:
<source lang="xml">
<baseURL>/CKFinderJava/userfiles/</baseURL>
<baseDir></baseDir>
</source>

Above setting will create <code>userfiles</code> inside <code>CKFinderJava</code> application directory. Although such configuration will work on every server there is a caveat to that approach. It isn’t recommended to put folder for uploaded files into deployed application folder because with every redeployment (e.g. when upgrading <code>war</code> to new version) of the application, the upload folder will be removed.
So, what should be done to set <code>baseUrl</code> and <code>baseDir</code> correctly? 

<note>
First of all you should set both properties so that they point to same location which is accessible through <code>HTTP</code> and from <code> the file system</code>. Second, you should set these properties to point to location outside of CKFinder application folder.</note>

One solution is using [https://en.wikipedia.org/wiki/Symbolic_link symlinks]. The <code>userfiles</code> folder located inside application context can be a symbolic link to some other directory on the disk. With that simple approach <code>/CKFinderJava/userfiles/</code> can point to folder of your choice. One downside of this technique is that you have to recreate the symbolic link with every application redeploy as the symlink gets removed on redeployment.

Another and better one solution is using server features. Most of the servers provide "virtual directory" mechanism. A "Virtual Directory" allows accessing folder which can be located even outside of the server, through <code>HTTP</code>. In Tomcat 7-8 this can be done through aliases, in Tomcat 6 by adding another context to <code>server.xml</code>, in GlassFish through alternate docroots, in Jetty by adding another context to <code>jetty.xml</code> and In Weblogic through virtual directories. 

Let’s have a look at an example for Apache Tomcat 8. The server is installed in <code>C:/Apache-Tomcat-8/</code> directory, CKFinderJava is installed in <code>C:/Apache-Tomcat-8/CKFinderJava</code>, we want to have our <code>userfiles</code> folder located directly on <code>C</code> drive and we want that folder to be called <code>"myimages"</code>. Here are the settings that will allow having all CKFinder features working, and <code>userfiles</code> folder not being removed with every redeployment of the application:

CKFinder config.xml settings:
<source lang="xml">
<baseDir>C:/myimages</baseDir>
<baseURL>/CKFinderJava/userfiles/</baseURL>
</source>

CKFinderJava/META-INF/context.xaml settings:
<source lang="xml">
<Context antiJARLocking="true" path="/CKFinderJava" reloadable="true" >
<Resources>
<PreResources base="C://myimages" className="org.apache.catalina.webresources.DirResourceSet" webAppMount="/userfiles" />
</Resources>
<Valve className="org.apache.catalina.valves.RemoteAddrValve" allow=".*" />
</Context>
</source>

CKFinder 2.x/Developers Guide/Java/Configuration/baseURL and baseDir

2015-11-03T21:45:54Z

J.swiderski:

{{#CUSTOMTITLE:baseDir and baseURL Parameters Explained}}
__TOC__
Both <code>baseDir</code> and <code>baseURL</code> should point to the same location on the server — the <code>userfiles</code> directory that contains all user files uploaded with CKFinder. The difference between them is as follows:
* <code>baseURL</code> gives a full URL to the <code>userfiles</code> directory or a path that is ''relative'' to the domain. For example:
*; <source lang="xml"><baseURL>http://example.com/CKFinderJava/userfiles/</baseURL></source>
*; <source lang="xml"><baseURL>/CKFinderJava/userfiles/</baseURL></source>
* <code>baseDir</code> gives an ''absolute'' path to the directory on the server (a physical machine). For example:
*; <source lang="xml"><baseDir>/usr/tomcat/webapps/CKFinderJava/userfiles/</baseDir></source>
*; <source lang="xml"><baseDir>C:\tomcat\webapps\CKFinderJava\userfiles\</baseDir></source>

You may ask: why use two paths to point to one location?

The <code>baseURL</code> parameter represents the path that is used by HTTP clients. It is employed for example when CKFinder returns the URL addresses of the files.

CKFinder itself is not an HTTP client, but an application that operates on server-based files that needs absolute paths to these files to operate correctly. A specific server configuration may sometimes lead to problems with setting the absolute path based on the <code>baseURL</code> parameter, which leads to the malfunctioning of the application. This is where the <code>baseDir</code> parameter that contains the direct path to the <code>userfiles</code> directory may help.

== Misconfiguration of baseURL and baseDir ==
Since setting the parameters may sometimes seem counter-intuitive, especially for the beginners, here are a couple of examples of CKFinder misconfiguration, i.e. the situation where the <code>baseURL</code> and <code>baseDir</code> settings were wrong.

=== Example 1: Using a Relative Path for baseDir ===
<source lang="xml">

<baseDir>/userfiles/</baseDir>
<baseURL>/CKFinderJava/userfiles/</baseURL>
</source>

In this example the <code>baseDir</code> parameter contains the relative (and not absolute) path to the <code>userfiles</code> directory. In a Windows system with this configuration the <code>userfiles</code> directory will be created on the same partition that hosts the server (for example, <code>C:\userfiles</code>). On a Linux machine the system will try to create a <code>/userfiles/</code> directory which will probably fail due to missing server permissions to create new directories in <code>/</code>.

=== Example 2: Incoherent Directory Paths ===
<source lang="xml">

<baseDir>C:\userfiles</baseDir>
<baseURL>/CKFinderJava/userfiles/</baseURL>
</source>

In this example <code>baseDir</code> is set to an absolute path, but the parameter points to a different location than <code>baseURL</code> that is set relative to the application root.

=== Result: CKFinder Misconfiguration ===
In both examples the parameters point to different server directories. As a result, some CKFinder features may not work correctly. The '''View''' function, for example, will be one of them.

Why is that so?

As mentioned above, CKFinder works on files and for this it uses the <code>baseDir</code> parameter value. All uploaded files will thus be placed in the location that is set in this parameter. HTTP clients, on the other hand, will use the <code>baseURL</code> value, but in both examples presented above this parameter will point to a non-existent location which in some cases may lead to a lack of access to files.

== BaseDir and BaseUrl best practice ==
<note>It is always recommended to set both <code>baseUrl</code> and <code>baseDir</code> so that they point to same location which is outside of application directory.</note>

In previous section, we have seen what problems we may get when these two properties are misconfigured but what will happen when only <code>baseUrl</code> is set? CKFinder needs both, <code>baseUrl</code> and <code>baseDir</code> to work correctly and if <code>baseDir</code> is missing, CKFinder will try to determine its value based on <code>baseUrl</code>. You must know however that CKFinder has limited capabilities in this case. To be more precise, CKFinder is mainly limited to application context (application main directory).
Let’s have a look at few examples:
<source lang="xml">
<baseURL>/userfiles/</baseURL>
<baseDir></baseDir>

<baseURL>http://example.com/userfiles/</baseURL>
<baseDir></baseDir>
</source>

In both above cases the <code>userfiles</code> folder points to server’s main applications directory. When multiple applications are kept on server they are accessible like <code><nowiki>http://example.com/CKFinderJava-2.5</nowiki></code> or <code><nowiki>http://example.com/CKFinderJava-2.4</nowiki></code>. As you can probably see the <code>userfiles</code> folder should be created on same level as applications in order to be accessible through HTTP. The problem is that applications folder is not accessible from the web. There are however two servers which have general accessible folders and to which CKFinder can get. These servers are Apache Tomcat and Oracle GlassFish. Having configuration like presented above, starting from CKFinder 2.5.1, CKFinder will create <code>userfiles</code> folder in <code>TOMCAT_HOME/webapps/ROOT</code> directory for Apache Tomcat and <code>GLASSFISH_HOME/glassfish/domains/domain_name/docroot </code> directory for Oracle GlassFish. Everything will work as expected in this case. For other supported servers, CKFinder will use fallback approach and create <code>userfiles</code> folder inside <code>CKFinderJava</code>application directory. As you probably know, this will unfortunately result in View option not working properly.

Let’s take a look at another example:
<source lang="xml">
<baseURL>/CKFinderJava/userfiles/</baseURL>
<baseDir></baseDir>
</source>

Above setting will create <code>userfiles</code> inside <code>CKFinderJava</code> application directory. Although such configuration will work on every server there is a caveat to that approach. It isn’t recommended to put folder for uploaded files into deployed application folder because with every redeployment (e.g. when upgrading <code>war</code> to new version) of the application, the upload folder will be removed.
So, what should be done to set <code>baseUrl</code> and <code>baseDir</code> correctly? 
First of all you should set both properties so that they point to same location which is accessible through <code>HTTP</code> and from <code> the file system</code>. 
Second, you should set these properties to location outside of CKFinder application folder. Here is where server itself might be helpful as most of the servers provide “virtual directories”. A “Virtual Directory” allows accessing folder which can be located even outside of the server, through <code>HTTP</code>. In Tomcat 7-8 this can be done through aliases, in Tomcat 6 by adding another context to <code>server.xml</code>, in GlassFish through alternate docroots, in Jetty by adding another context to <code>jetty.xml</code> and In Weblogic through virtual directories. 

Let’s have a look at an example for Tomcat 8 server. The server is installed in <code>C:/Apache-Tomcat-8/</code> folder, CKFinderJava is installed in <code>C:/Apache-Tomcat-8/CKFinderJava</code>, we want to have our <code>userfiles</code> folder located directly on <code>C</code> drive and we want that folder to be called <code>"myimages"</code>. Here are the settings that will allow having all CKFinder features working, and <code>userfiles</code> folder not being removed with every redeployment of the application:

CKFinder config.xml settings:
<source lang="xml">
<baseDir>C:/myimages</baseDir>
<baseURL>/CKFinderJava/userfiles/</baseURL>
</source>

CKFinderJava/META-INF/context.xaml settings:
<source lang="xml">
<Context antiJARLocking="true" path="/CKFinderJava" reloadable="true" >
<Resources>
<PreResources base="C://myimages" className="org.apache.catalina.webresources.DirResourceSet" webAppMount="/userfiles" />
</Resources>
<Valve className="org.apache.catalina.valves.RemoteAddrValve" allow=".*" />
</Context>
</source>

CKFinder 2.x/Developers Guide/Java/Installation

2015-11-03T17:17:29Z

J.swiderski:

__TOC__
{{#CUSTOMTITLE:CKFinder Installation}}
This article describes how to install CKFinder for Java.

== Installation Procedure ==
To install CKFinder, download the CKFinder for Java distribution package (a <code>.war</code> file) from the [http://ckfinder.com/download official download site]. 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 <code>_samples</code> folder of the distribution package. After the deployment open the <code>_samples/index.html</code> 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 <code>config.xml</code> file where you can customize your application. See the [[CKFinder_2.x/Developers Guide/Java/Configuration|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.
<source lang="xml">
<enabled>true</enabled>
</source>

== Deployment on a Server ==
The CKFinder Java connector supports the following servers:
* Tomcat 6-8,
* Jetty 9,
* WildFly (former JBoss AS) 8-9,
* JBoss EAP 6,
* GlassFish 3-4,
* Weblogic 11g-12c.
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 <code>.war</code> file in the Tomcat <code>webapps</code> folder. Go to Tomcat <code>bin</code> folder and run the startup script file for your operating system — <code>startup.bat</code> for Windows or <code>startup.sh</code> for Linux. When you are running Tomcat as a service, restart the server.

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

Go to the [http://wiki.apache.org/tomcat/FAQ Tomcat FAQ] and [http://tomcat.apache.org/tomcat-6.0-doc/index.html Tomcat 6], or [http://tomcat.apache.org/tomcat-7.0-doc/index.html Tomcat 7], or [http://tomcat.apache.org/tomcat-8.0-doc/index.html Tomcat 8] documentation for more information about using this server.

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

By default Jetty unpacks war files to folders like <code><nowiki>C:\Users\admin\AppData\Local\Temp\jetty-0.0.0.0-8080-CKFinderJava.war-_CKFinderJava-any-\webapp\</nowiki></code>. Information about this folder is displayed in the output console, when application is deployed. If you wish to change this folder, you can either put the unpacked <code>CKFinderJava.war</code> file in the webapps folder (Jetty will use the unpacked application folder) or go to <code><nowiki>jetty9\etc\jetty-deploy.xml</nowiki></code> and set the below parameter to the folder path of your choice:

<source lang="xml"><Set name="tempDir"><New class="java.io.File"><Arg>C:\tmp</Arg></New></Set></source>

Go to the [http://www.eclipse.org/jetty/documentation/current/quick-start.html Jetty 9] Quick Start guide for more information about using this server.

=== WildFly ===
The server can be started from the command line. Go to the WildFly <code>bin</code> folder and run the following command:
* Windows: <code>standalone.bat</code> or <code>domain.bat</code>
* Linux: <code>standalone.sh</code> or <code>domain.sh</code>

WildFly Application Server can run in two modes: standalone and domain. First one allows running a single standalone Server, while the latter is used to manage multiple physical (or virtual) machines from a single control point. 
'''NOTE:''' In this example we are going to work with a standalone server.

The above two commands start server with its default configurations. If one wishes to start the server with one of alternative configurations, one should pass the <code>--server-config</code> argument with the server configuration file to be used. The example below shows how to run the full profile configuration with high availability:
* Windows: <code>standalone.bat --server-config=standalone-ha.xml</code>
* Linux: <code>standalone.sh --server-config=standalone-ha.xml</code>
You can read more about available WildFly configurations [https://docs.jboss.org/author/display/WFLY9/Getting+Started+Guide#GettingStartedGuide-WildFly8Configurations here].

After the server was started, log into administration console, click '''Deployments''' link, next click the '''Add''' button, select '''Upload a new deployment''' radio button, click '''Next''' and select <code>CKFinderJava.war</code> file. Once CKFinderJava.war upload is finished, verify its runtime name and check the '''Enable''' checkbox. The Application is now ready to use.

Another way of deploying the CKFinderJava application is using WildFly Command Line Interface (CLI). It has to be first launched using the <code>jboss-cli.sh</code> or <code>jboss-cli.bat</code> script located in <code>JBOSS_HOME/bin</code> directory. Once this is done, you can deploy applications as in the example given below:
* '''In standalone mode:''' <code>[standalone@localhost:9999 /] deploy ~/Desktop/CKFinderJava.war</code>
* '''In domain mode:''' <code>[domain@localhost:9999 /] deploy ~/Desktop/ CKFinderJava.war --all-server-groups</code>
'''NOTE:''' Either <code>--all-server-groups</code> or <code>--server-groups</code> with specified server groups must be used. 

To learn more about CLI please see this [https://docs.jboss.org/author/display/WFLY9/Admin+Guide#AdminGuide-CommandLineInterface link].

If your Server is running in the standalone mode, then aside from using the administration console and CLI, WildFly can also work in manual and auto deployment mode (this depends on your settings). 
In the '''Auto-Deploy mode''' the scanner directly monitors the deployment content, available in <code><nowiki>JBOSS_HOME/standalone/deployments</nowiki></code> directory, automatically deploying new content and redeploying content whose timestamp has changed. It means that you can simply drop CKFinderJava.war into deployments folder and the application will be deployed. 
To undeploy CKFinderJava in auto mode simply remove war file from deploy directory. 
In the '''Manual deploy mode''' the scanner does not directly monitor the deployment content. Instead, the scanner relies on a system of marker files, which the user can add to or remove from deployment directory. These files serve as a sort of command telling the scanner to deploy, undeploy, or redeploy the content. You can learn more about marker files in the "Marker Files" section available under this [https://docs.jboss.org/author/display/WFLY8/Application+deployment link].

To deploy <code>CKFinderJava.war</code> in manual mode, copy this file into the <code>JBOSS_HOME/standalone/deployments</code> directory and create the <code>CKFinderJava.war.dodeploy</code> file. CKFinder will be deployed and the <code>CKFinderJava.war.deployed</code> marker file will be created. To undeploy CKFinderJava simply remove <code>CKFinderJava.war.deployed</code> file.

Please note that by default WildFly allows auto-deployment of zipped content and prevents auto-deployment of exploded content. This is because exploded content is vulnerable to the scanner trying to auto-deploy partially copied content. However, if you wish to change this behavior, you can go to the <code><nowiki>JBOSS_HOME/standalone/configuration/standalone.xml</nowiki></code> file, look for the '''deployment-scanner'' tag and change the deployment options as you like:

<source lang="xml">
<deployment-scanner scan-interval="5000" relative-to="jboss.server.base.dir" path="deployments"
auto-deploy-zipped="true" auto-deploy-exploded="false"/>
</source>

By default, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>
Please note that the HTTP <code>8080</code> port of the sample URL is the default WildFly port. If you changed this value while configuring your WildFly installation, you will need to use a modified port value to run the sample application.

If you want to use international files names with CKFinder please see [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Configuration/URI_Encoding URI Encoding section] which explains how to set UTF-8 on WildFly.

Go to the JBoss EAP [https://docs.jboss.org/author/display/WFLY9/Getting+Started+Guide Getting Started] and [https://docs.jboss.org/author/display/WFLY9/Admin+Guide Administration Guide] for more information about using this server.

=== JBoss EAP 6 ===
The server can be started from the command line. Go to the JBoss Enterprise Application Platform (EAP) <code>bin</code> folder and run the following command:
* Windows: <code>standalone.bat</code> or <code>domain.bat</code>
* Linux: <code>standalone.sh</code> or <code>domain.sh</code>

JBoss EAP can run in two modes: standalone and domain. First one allows running a single standalone Server, while the latter is used to manage multiple physical (or virtual) machines from a single control point. 
'''NOTE:''' In this example we are going to work with a standalone server.

The above two commands start server with its default configurations. If one wishes to start the server with one of alternative configurations, one should pass the <code>--server-config</code> argument with the server configuration file to be used. The example below shows how to run the full profile configuration with high availability:
* Windows: <code>standalone.bat --server-config=standalone-ha.xml</code>
* Linux: <code>standalone.sh --server-config=standalone-ha.xml</code>
You can read more about available JBoss configurations [https://access.redhat.com/documentation/en-US/JBoss_Enterprise_Application_Platform/6.4/html-single/Administration_and_Configuration_Guide/#sect-Configuration_Files here].

After the server was started, log into administration console, click '''Deployments''' link, next click the '''Add''' button and select <code>CKFinderJava.war</code> file. Once CKFinderJava.war upload is finished, verify its runtime name and check the '''Enable''' checkbox. The Application is now ready to use.

Another way of deploying the CKFinderJava application is using JBoss Command Line Interface (CLI). It has to be first launched using the <code>jboss-cli.sh</code> or <code>jboss-cli.bat</code> script located in the <code>EAP_HOME/bin</code> directory. Once this is done, you can deploy applications as in the example given below:
* '''In standalone mode:''' <code>[standalone@localhost:9999 /] deploy ~/Desktop/CKFinderJava.war</code>
* '''In domain mode:''' <code>[domain@localhost:9999 /] deploy ~/Desktop/ CKFinderJava.war --all-server-groups</code>
'''NOTE:''' Either <code>--all-server-groups</code> or <code>--server-groups</code> with specified server groups must be used. 

To learn more about CLI please see this [https://access.redhat.com/documentation/en-US/JBoss_Enterprise_Application_Platform/6.4/html-single/Administration_and_Configuration_Guide/#sect-The_Management_CLI link].

If your Server is running in the standalone mode, then aside from using the administration console and CLI, JBoss can also work in manual and auto deployment mode (this depends on your settings). 
In the '''Auto-Deploy mode''' the scanner directly monitors the deployment content, available in <code><nowiki>EAP_HOME/standalone/deployments</nowiki></code> directory, automatically deploying new content and redeploying content whose timestamp has changed. It means that you can simply drop CKFinderJava.war into deployments folder and the application will be deployed. 
To undeploy CKFinderJava in auto mode simply remove war file from deploy directory. 
In the '''Manual deploy mode''' the scanner does not directly monitor the deployment content. Instead, the scanner relies on a system of marker files, which the user can add to or remove from deployment directory. These files serve as a sort of command telling the scanner to deploy, undeploy, or redeploy the content. You can learn more about marker files under this [https://access.redhat.com/documentation/en-US/JBoss_Enterprise_Application_Platform/6.4/html-single/Administration_and_Configuration_Guide/#Reference_for_Deployment_Scanner_Marker_Files1 link].

To deploy <code>CKFinderJava.war</code> in manual mode, copy this file into the <code>EAP_HOME/standalone/deployments</code> directory and create the <code>CKFinderJava.war.dodeploy</code> file. CKFinder will be deployed and the <code>CKFinderJava.war.deployed</code> marker file will be created. To undeploy CKFinderJava simply remove <code>CKFinderJava.war.deployed</code> file.

Please note that by default JBoss EAP allows auto-deployment of zipped content and prevents auto-deployment of exploded content. This is because exploded content is vulnerable to the scanner trying to auto-deploy partially copied content. However, if you wish to change this behaviour, you can go to the <code><nowiki>EAP_HOME/standalone/configuration/standalone.xml</nowiki></code> file, look for the '''deployment-scanner'' tag and change the deployment options as you like:

<source lang="xml">
<deployment-scanner scan-interval="5000" relative-to="jboss.server.base.dir" path="deployments"
auto-deploy-zipped="true" auto-deploy-exploded="false"/>
</source>

By default, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>
Please note that the HTTP <code>8080</code> port of the sample URL is the default JBoss EAP port. If you changed this value while configuring your EAP installation, you will need to use a modified port value to run the sample application.

If you want to use international files names with CKFinder please see [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Configuration/URI_Encoding URI Encoding section] which explains how to set UTF-8 on JBOSS EAP.

Go to the JBoss EAP [https://access.redhat.com/documentation/en-US/JBoss_Enterprise_Application_Platform/6.4/html-single/Getting_Started_Guide/ Getting Started] and [https://access.redhat.com/documentation/en-US/JBoss_Enterprise_Application_Platform/6.4/html-single/Administration_and_Configuration_Guide/ Administration Guide] for more information about using this server.

=== GlassFish ===
The GlassFish server can be started from the command line. Go to the server <code>bin</code> folder and run the <code>asadmin</code> 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 <code>start-domain</code> 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: 

* <code>deploy relativePath/CKFinderJava.war</code>

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

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

By default, Glassfish has ISO parameter-encoding set, which may cause problems if your users want to use filenames with non-ISO characters. If CKFinder in your application is to be used worldwide, it is recommended to set UTF-8 for Glassfish. Please refer to the [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Configuration/URI_Encoding URI Encoding] section for more details.

Go to the Oracle [http://docs.oracle.com/cd/E19798-01/821-1757/index.html GlassFish 3.0] or, [http://docs.oracle.com/cd/E18930_01/html/821-2432/ GlassFish 3.1] or [https://glassfish.java.net/getstarted.html GlassFish 4.x] Server Quick Start Guide for more information about using this server.

=== Weblogic ===
The Weblogic Server (WLS) can be started from the command line. Go to the <code><nowiki>weblogic_main_folder/user_projects/domains/your_domain/bin</nowiki></code> folder and run the following script:
* Windows: <code>startWeblogic.cmd</code> or <code>startManagedWebLogic.cmd</code>
* Linux: <code>startWeblogic.sh</code> or <code>startManagedWebLogic.sh</code>
If Weblogic is in production mode then please remember that you need to specify the user name and password in order to run it.

As you probably know, Weblogic Server uses domains which are logically related groups of server resources. A domain can consist of an Administration Server and one or more Managed Servers, or of a single standalone server that acts as an Administration Server and runs deployed applications. In this example we are going to use a single standalone Administration Server.

After starting Weblogic, log into the Administration Console and click '''Deployments''' in the '''Domain Structure''' upper left menu. If WLS is in production mode, you need to click '''Lock&Edit''' first. In main panel click the '''Install''' button, specify the path to <code>CKFinderJava.war</code>, and click the '''Next''' button. Select the '''"Install this deployment as an application"''' option and press the '''Next''' button. In the last panel you can change the name of your deployment, the security model and the source accessibility. Once you are done, click the '''Finish''' button and CKFinderJava will be deployed. If WLS works in production mode, you will need to confirm all changes by clicking the '''Activate Changes''' button and start the application manually by selecting it and pressing the '''Start''' button.

By deafult, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:7001/CKFinderJava/</nowiki></code>

The HTTP <code>7001</code> port of the sample URL is the default Weblogic Administration Server port. If you changed this value while configuring your Weblogic domain(s), you will need to use a modified port value to run the sample application.

Go to the [http://docs.oracle.com/cd/E17904_01/index.htm Weblogic 11g] or [http://docs.oracle.com/cd/E24329_01/index.htm Weblogic 12c] Documentation site for more information about using this server.

CKFinder 2.x/Developers Guide/Java/Installation

2015-11-03T15:46:44Z

J.swiderski:

__TOC__
{{#CUSTOMTITLE:CKFinder Installation}}
This article describes how to install CKFinder for Java.

== Installation Procedure ==
To install CKFinder, download the CKFinder for Java distribution package (a <code>.war</code> file) from the [http://ckfinder.com/download official download site]. 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 <code>_samples</code> folder of the distribution package. After the deployment open the <code>_samples/index.html</code> 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 <code>config.xml</code> file where you can customize your application. See the [[CKFinder_2.x/Developers Guide/Java/Configuration|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.
<source lang="xml">
<enabled>true</enabled>
</source>

== Deployment on a Server ==
The CKFinder Java connector supports the following servers:
* Tomcat 6-8,
* Jetty 9,
* WildFly (former JBoss AS) 8-9,
* JBoss EAP 6,
* GlassFish 3-4,
* Weblogic 11g-12c.
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 <code>.war</code> file in the Tomcat <code>webapps</code> folder. Go to Tomcat <code>bin</code> folder and run the startup script file for your operating system — <code>startup.bat</code> for Windows or <code>startup.sh</code> for Linux. When you are running Tomcat as a service, restart the server.

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

Go to the [http://wiki.apache.org/tomcat/FAQ Tomcat FAQ] and [http://tomcat.apache.org/tomcat-6.0-doc/index.html Tomcat 6], or [http://tomcat.apache.org/tomcat-7.0-doc/index.html Tomcat 7], or [http://tomcat.apache.org/tomcat-8.0-doc/index.html Tomcat 8] documentation for more information about using this server.

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

By default Jetty unpacks war files to folders like <code><nowiki>C:\Users\admin\AppData\Local\Temp\jetty-0.0.0.0-8080-CKFinderJava.war-_CKFinderJava-any-\webapp\</nowiki></code>. Information about this folder is displayed in the output console, when application is deployed. If you wish to change this folder, you can either put the unpacked <code>CKFinderJava.war</code> file in the webapps folder (Jetty will use the unpacked application folder) or go to <code><nowiki>jetty9\etc\jetty-deploy.xml</nowiki></code> and set the below parameter to the folder path of your choice:

<source lang="xml"><Set name="tempDir"><New class="java.io.File"><Arg>C:\tmp</Arg></New></Set></source>

Go to the [http://www.eclipse.org/jetty/documentation/current/quick-start.html Jetty 9] Quick Start guide for more information about using this server.

=== WildFly ===
The server can be started from the command line. Go to the WildFly bin folder and run the following command:
* Windows: <code>standalone.bat</code> or <code>domain.bat</code>
* Linux: <code>standalone.sh</code> or <code>domain.sh</code>

WildFly Application Server can run in two modes: standalone and domain. First one allows running a single standalone Server, while the latter is used to manage multiple physical (or virtual) machines from a single control point. 
'''NOTE:''' In this example we are going to work with a standalone server.

The above two commands start server with its default configurations. If one wishes to start the server with one of alternative configurations, one should pass the <code>--server-config</code> argument with the server configuration file to be used. The example below shows how to run the full profile configuration with high availability:
* Windows: <code>standalone.bat --server-config=standalone-ha.xml</code>
* Linux: <code>standalone.sh --server-config=standalone-ha.xml</code>
You can read more about available WildFly configurations [https://docs.jboss.org/author/display/WFLY9/Getting+Started+Guide#GettingStartedGuide-WildFly8Configurations here].

After the server was started, log into administration console, click '''Deployments''' link, next click the '''Add''' button, select '''Upload a new deployment''' radio button, click '''Next''' and select <code>CKFinderJava.war</code> file. Once CKFinderJava.war upload is finished, verify its runtime name, check the '''Enable''' checkbox. The Application is now ready to use.

Another way of deploying the CKFinderJava application is using WildFly Command Line Interface (CLI). It has to be first launched using the <code>jboss-cli.sh</code> or <code>jboss-cli.bat</code> script located in the WildFly <code>bin</code> directory. Once this is done, you can deploy applications as in the example given below:
* '''In standalone mode:''' <code>[standalone@localhost:9999 /] deploy ~/Desktop/CKFinderJava.war</code>
* '''In domain mode:''' <code>[domain@localhost:9999 /] deploy ~/Desktop/ CKFinderJava.war --all-server-groups</code>
'''NOTE:''' Either <code>--all-server-groups</code> or <code>--server-groups</code> with specified server groups must be used. 

To learn more about CLI please see this [https://docs.jboss.org/author/display/WFLY9/Admin+Guide#AdminGuide-CommandLineInterface link].

If your Server is running in the standalone mode, then aside from using the administration console and CLI, WildFly can also work in manual and auto deployment mode (this depends on your settings). 
In the '''Auto-Deploy mode''' the scanner directly monitors the deployment content, available in <code><nowiki>JBOSS_HOME/standalone/deployments</nowiki></code> directory, automatically deploying new content and redeploying content whose timestamp has changed. It means that you can simply drop CKFinderJava.war into deployments folder and the application will be deployed. 
To undeploy CKFinderJava in auto mode simply remove war file from deploy directory. 
In the '''Manual deploy mode''' the scanner does not directly monitor the deployment content. Instead, the scanner relies on a system of marker files, which the user can add to or remove from deployment directory. These files serve as a sort of command telling the scanner to deploy, undeploy, or redeploy the content. You can learn more about marker files in the "Marker Files" section available under this [https://docs.jboss.org/author/display/WFLY8/Application+deployment link].

To deploy <code>CKFinderJava.war</code> in manual mode, copy this file into the deployments directory and create the <code>CKFinderJava.war.dodeploy</code> file. CKFinder will be deployed and the <code>CKFinderJava.war.deployed</code> marker file will be created. To undeploy CKFinderJava simply remove <code>CKFinderJava.war.deployed</code> file.

Please note that by default WildFly allows auto-deployment of zipped content and prevents auto-deployment of exploded content. This is because exploded content is vulnerable to the scanner trying to auto-deploy partially copied content. However, if you wish to change this behavior, you can go to the <code><nowiki>JBOSS_HOME/standalone/configuration/standalone.xml</nowiki></code> file, look for the '''deployment-scanner'' tag and change the deployment options as you like:

<source lang="xml">
<deployment-scanner scan-interval="5000" relative-to="jboss.server.base.dir" path="deployments"
auto-deploy-zipped="true" auto-deploy-exploded="false"/>
</source>

By default, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>
Please note that the HTTP <code>8080</code> port of the sample URL is the default WildFly port. If you changed this value while configuring your WildFly installation, you will need to use a modified port value to run the sample application.

If you want to use international files names with CKFinder please see [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Configuration/URI_Encoding URI Encoding section] which explains how to set UTF-8 on WildFly.

Go to the WildFly [https://docs.jboss.org/author/display/WFLY9/Getting+Started+Guide Documentation] site for more information about using this server.

=== JBoss EAP 6 ===
The server can be started from the command line. Go to the JBoss Enterprise Application Platform (EAP) <code>bin</code> folder and run the following command:
* Windows: <code>standalone.bat</code> or <code>domain.bat</code>
* Linux: <code>standalone.sh</code> or <code>domain.sh</code>

JBoss EAP can run in two modes: standalone and domain. First one allows running a single standalone Server, while the latter is used to manage multiple physical (or virtual) machines from a single control point. 
'''NOTE:''' In this example we are going to work with a standalone server.

The above two commands start server with its default configurations. If one wishes to start the server with one of alternative configurations, one should pass the <code>--server-config</code> argument with the server configuration file to be used. The example below shows how to run the full profile configuration with high availability:
* Windows: <code>standalone.bat --server-config=standalone-ha.xml</code>
* Linux: <code>standalone.sh --server-config=standalone-ha.xml</code>
You can read more about available JBoss configurations [https://access.redhat.com/documentation/en-US/JBoss_Enterprise_Application_Platform/6.4/html-single/Administration_and_Configuration_Guide/#sect-Configuration_Files here].

After the server was started, log into administration console, click '''Deployments''' link, next click the '''Add''' button and select <code>CKFinderJava.war</code> file. Once CKFinderJava.war upload is finished, verify its runtime name, check the '''Enable''' checkbox. The Application is now ready to use.

Another way of deploying the CKFinderJava application is using JBoss Command Line Interface (CLI). It has to be first launched using the <code>jboss-cli.sh</code> or <code>jboss-cli.bat</code> script located in the JBoss EAP <code>bin</code> directory. Once this is done, you can deploy applications as in the example given below:
* '''In standalone mode:''' <code>[standalone@localhost:9999 /] deploy ~/Desktop/CKFinderJava.war</code>
* '''In domain mode:''' <code>[domain@localhost:9999 /] deploy ~/Desktop/ CKFinderJava.war --all-server-groups</code>
'''NOTE:''' Either <code>--all-server-groups</code> or <code>--server-groups</code> with specified server groups must be used. 

To learn more about CLI please see this [https://access.redhat.com/documentation/en-US/JBoss_Enterprise_Application_Platform/6.4/html-single/Administration_and_Configuration_Guide/#sect-The_Management_CLI link].

If your Server is running in the standalone mode, then aside from using the administration console and CLI, JBoss can also work in manual and auto deployment mode (this depends on your settings). 
In the '''Auto-Deploy mode''' the scanner directly monitors the deployment content, available in <code><nowiki>EAP_HOME/standalone/deployments</nowiki></code> directory, automatically deploying new content and redeploying content whose timestamp has changed. It means that you can simply drop CKFinderJava.war into deployments folder and the application will be deployed. 
To undeploy CKFinderJava in auto mode simply remove war file from deploy directory. 
In the '''Manual deploy mode''' the scanner does not directly monitor the deployment content. Instead, the scanner relies on a system of marker files, which the user can add to or remove from deployment directory. These files serve as a sort of command telling the scanner to deploy, undeploy, or redeploy the content. You can learn more about marker files under this [https://access.redhat.com/documentation/en-US/JBoss_Enterprise_Application_Platform/6.4/html-single/Administration_and_Configuration_Guide/#Reference_for_Deployment_Scanner_Marker_Files1 link].

To deploy <code>CKFinderJava.war</code> in manual mode, copy this file into the deployments directory and create the <code>CKFinderJava.war.dodeploy</code> file. CKFinder will be deployed and the <code>CKFinderJava.war.deployed</code> marker file will be created. To undeploy CKFinderJava simply remove <code>CKFinderJava.war.deployed</code> file.

Please note that by default JBoss EAP allows auto-deployment of zipped content and prevents auto-deployment of exploded content. This is because exploded content is vulnerable to the scanner trying to auto-deploy partially copied content. However, if you wish to change this behaviour, you can go to the <code><nowiki>EAP_HOME/standalone/configuration/standalone.xml</nowiki></code> file, look for the '''deployment-scanner'' tag and change the deployment options as you like:

<source lang="xml">
<deployment-scanner scan-interval="5000" relative-to="jboss.server.base.dir" path="deployments"
auto-deploy-zipped="true" auto-deploy-exploded="false"/>
</source>

By default, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>
Please note that the HTTP <code>8080</code> port of the sample URL is the default JBOSS EAP port. If you changed this value while configuring your EAP installation, you will need to use a modified port value to run the sample application.

If you want to use international files names with CKFinder please see [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Configuration/URI_Encoding URI Encoding section] which explains how to set UTF-8 on JBOSS EAP.

Go to the JBoss EAP [https://access.redhat.com/documentation/en-US/JBoss_Enterprise_Application_Platform/6.4/html-single/Getting_Started_Guide/ Getting Started] and [https://access.redhat.com/documentation/en-US/JBoss_Enterprise_Application_Platform/6.4/html-single/Administration_and_Configuration_Guide/ Administration] sites for more information about using this server.

=== GlassFish ===
The GlassFish server can be started from the command line. Go to the server <code>bin</code> folder and run the <code>asadmin</code> 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 <code>start-domain</code> 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: 

* <code>deploy relativePath/CKFinderJava.war</code>

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

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

By default, Glassfish has ISO parameter-encoding set, which may cause problems if your users want to use filenames with non-ISO characters. If CKFinder in your application is to be used worldwide, it is recommended to set UTF-8 for Glassfish. Please refer to the [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Configuration/URI_Encoding URI Encoding] section for more details.

Go to the Oracle [http://docs.oracle.com/cd/E19798-01/821-1757/index.html GlassFish 3.0] or, [http://docs.oracle.com/cd/E18930_01/html/821-2432/ GlassFish 3.1] or [https://glassfish.java.net/getstarted.html GlassFish 4.x] Server Quick Start Guide for more information about using this server.

=== Weblogic ===
The Weblogic Server (WLS) can be started from the command line. Go to the <code><nowiki>weblogic_main_folder/user_projects/domains/your_domain/bin</nowiki></code> folder and run the following script:
* Windows: <code>startWeblogic.cmd</code> or <code>startManagedWebLogic.cmd</code>
* Linux: <code>startWeblogic.sh</code> or <code>startManagedWebLogic.sh</code>
If Weblogic is in production mode then please remember that you need to specify the user name and password in order to run it.

As you probably know, Weblogic Server uses domains which are logically related groups of server resources. A domain can consist of an Administration Server and one or more Managed Servers, or of a single standalone server that acts as an Administration Server and runs deployed applications. In this example we are going to use a single standalone Administration Server.

After starting Weblogic, log into the Administration Console and click '''Deployments''' in the '''Domain Structure''' upper left menu. If WLS is in production mode, you need to click '''Lock&Edit''' first. In main panel click the '''Install''' button, specify the path to <code>CKFinderJava.war</code>, and click the '''Next''' button. Select the '''"Install this deployment as an application"''' option and press the '''Next''' button. In the last panel you can change the name of your deployment, the security model and the source accessibility. Once you are done, click the '''Finish''' button and CKFinderJava will be deployed. If WLS works in production mode, you will need to confirm all changes by clicking the '''Activate Changes''' button and start the application manually by selecting it and pressing the '''Start''' button.

By deafult, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:7001/CKFinderJava/</nowiki></code>

The HTTP <code>7001</code> port of the sample URL is the default Weblogic Administration Server port. If you changed this value while configuring your Weblogic domain(s), you will need to use a modified port value to run the sample application.

Go to the [http://docs.oracle.com/cd/E17904_01/index.htm Weblogic 11g] or [http://docs.oracle.com/cd/E24329_01/index.htm Weblogic 12c] Documentation site for more information about using this server.

CKFinder 2.x/Developers Guide/Java/Installation

2015-11-03T15:33:43Z

J.swiderski:

CKFinder 2.x/Developers Guide/Java/Installation

2015-11-02T22:43:59Z

J.swiderski:

CKFinder 2.x/Developers Guide/Java/Installation

2015-11-02T22:37:01Z

J.swiderski:

CKFinder 2.x/Developers Guide/Java/Installation

2015-11-02T22:32:35Z

J.swiderski:

CKFinder 2.x/Developers Guide/Java/Installation

2015-11-02T21:22:30Z

J.swiderski:

CKFinder 2.x/Developers Guide/Java/Configuration/URI Encoding

2015-11-02T16:43:46Z

J.swiderski:

By default some servers use the ISO-8859-1 encoding for request parameters and request body. What is more, changing the encoding for request body on such servers has no influence on the encoding of the request parameters. This may cause problems if you want to use international file names with '''CKFinder which expects request body and parameters to be encoded in UTF-8'''. To overcome this issue you can either set UTF-8 URI encoding on the server or if you do not have enough privileges to do that, you can adjust CKFinder to use same URI encoding as your server. 
You will find more detailed instructions below.

===JBOSS 7===
By default this server uses ISO-8859-1 for parameter encoding. To change this to UTF-8, you have to modify the configuration file appropriate for the mode and configuration used. 
As you probably know, JBOSS 7 can run in two modes ("domain" and "standalone") and can use various configurations.
To simplify the example let us assume that the server uses the standalone mode and default configuration. In order to set UTF-8 for URI encoding you have to edit the <code><nowiki>JBOSS_HOME/standalone/configuration/standalone.xml</nowiki></code> file and add a system property named <code>org.apache.catalina.connector.URI_ENCODING</code>,(with value set to UTF-8) to the <code>system-properties</code> element. 
Below is the code that needs to be added to the configuration file you use:

<source lang="xml">
<system-properties>
<property name="org.apache.catalina.connector.URI_ENCODING" value="UTF-8"/>
</system-properties>
</source>

===GlassFish 3.0===
According to Glassfish 3.0 [http://docs.oracle.com/cd/E19798-01/821-1752/beafu/index.html documentation] default parameter encoding for requests is ISO-8859-1. To change this encoding to UTF-8 you have to use the sun-web.xml [http://docs.oracle.com/cd/E19798-01/821-1750/beaql/index.html file] with xml <code>parameter-encoding</code> element. This file has to be placed in the <code>WEB-INF</code> folder of your web application. 
CKFinder sample web application comes with such a file. If you are using Glassfish 3.0, want to use UTF-8, and to integrate CKFinder in to your application then apart from files mentioned in the [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Integration Integration] section, copy <code>sun-web.xml</code> as well. 
Below is the code for the <code>sun-web.xml</code> file:

<source lang="xml">
<!DOCTYPE sun-web-app PUBLIC "-//Sun Microsystems, Inc.//DTD GlassFish Application Server 3.0 Servlet 3.0//EN"
"http://www.sun.com/software/appserver/dtds/sun-web-app_3_0-0.dtd">
<sun-web-app>
<parameter-encoding default-charset="UTF-8" />
</sun-web-app>
</source>

===GlassFish 3.1+===
By default this [http://docs.oracle.com/cd/E18930_01/html/821-2418/beaft.html#beafu server] uses ISO-8859-1 for parameter encoding. In order to change this to UTF-8, you have to use the <code>glassfish-web.xml</code> [http://docs.oracle.com/cd/E18930_01/html/821-2417/beaql.html#scrolltoc file] with xml <code>parameter-encoding</code> element. This file has to be placed in the <code>WEB-INF</code> folder of the web application. 
CKFinder sample web application comes with such a file. If you are using Glassfish 3.1 or 4.0, want to use UTF-8, and to integrate CKFinder in to your application then apart from files mentioned in the [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Integration Integration] section, copy <code>glassfish-web.xml</code> as well. 
Below is the code for the <code>glassfish-web.xml</code> file:
<source lang="xml">
<!DOCTYPE glassfish-web-app PUBLIC "-//GlassFish.org//DTD GlassFish Application Server 3.1 Servlet 3.0//EN"
"http://glassfish.org/dtds/glassfish-web-app_3_0-1.dtd">
<glassfish-web-app>
<parameter-encoding default-charset="UTF-8" />
</glassfish-web-app>
</source>

===Tomcat===
According to [http://wiki.apache.org/tomcat/FAQ/CharacterEncoding Tomcat FAQ], for handling HTTP requests by default Tomcat uses the ISO-8859-1 encoding.

Starting with version 5 for all <code>GET</code> requests, when the encoding type used is different from the default one, the query parameters are not encoded in the same way as the request body. To be more specific, if you want to use the encoding other than the default ISO-8859-1 (like UTF-8, for example), the <code>HttpServletRequest.setCharacterEncoding("UTF-8")</code> method will only be applied to the request body, and not the URI.

In order to encode the query parameters just like the requests, you should use the <code>URIEncoding="UTF-8"</code> attribute in the <code>Connector</code> element of the <code>Server.xml</code> file:
<source lang="xml">
<Connector port="8080" protocol="HTTP/1.1" connectionTimeout="20000" redirectPort="8443" URIEncoding="UTF-8" />
</source>

===Weblogic===
This server follows J2EE specification when it comes to encoding. This means that if no encoding is specified then default ISO-8859-1 is set for everything (Servlets, JSP, Tag Files) except for XML format files. 
Weblogic documentation provides a couple of ways for setting the encoding you want (UTF-8 in this case). There are server typical methods as well as general Servlet API methods. It seems the best way to set encoding in the WLS server is using [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html#setCharacterEncoding%28java.lang.String%29 setCharacterEncoding("UTF-8");] for requests and [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html#setCharacterEncoding%28java.lang.String%29 setCharacterEncoding("UTF-8");] or [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html#setContentType%28java.lang.String%29 setContentType("UTF-8");] for responses.

Please see this [http://otndnld.oracle.co.jp/document/products/wls/docs103/en/relnotes_ja.htmlotndnld.oracle.co.jp/document/products/wls/docs92/en/relnotes_ja.html link] (Web Components section) for more details on setting appropriate encoding on the server-side.

===Jetty===
The Jetty server uses UTF-8 by default. Jetty [http://wiki.eclipse.org/Jetty/Howto/International_Characters#Characters_included_in_HTTP_requests documentation] states if no overriding character encoding is set on a request, Jetty uses UTF-8 encoding.

===Alternative Solution (CKFinder Adjustment)===
'''By default, CKFinder uses the UTF-8 encoding, so you should stick to the guidelines presented above in order to make it work properly.'''

If you cannot or do not want to set this parameter in the server configuration file, CKFinder will try to address this problem for you. This is why the <code>uriEncoding</code> configuration element was created in the <code>config.xml<code> file. This parameter accepts the encoding of your query parameters. 
For example, for Tomcat, JBoss, Glassfish, and Weblogic with their default configuration set (which is ISO-8859-1) you should set uriEncoding to ISO-8859-1 and CKFinder will convert the query parameters for you.

<source lang="xml">
<uriEncoding>ISO-8859-1</uriEncoding>
</source>

CKFinder 2.x/Developers Guide/Java/Installation

2015-11-02T16:22:24Z

J.swiderski:

CKFinder 2.x/Developers Guide/Java/Installation

2015-11-02T15:49:47Z

J.swiderski:

CKFinder 2.x/Developers Guide/Java/Installation

2015-08-17T11:34:56Z

J.swiderski:

__TOC__
{{#CUSTOMTITLE:CKFinder Installation}}
This article describes how to install CKFinder for Java.

== Installation Procedure ==
To install CKFinder, download the CKFinder for Java distribution package (a <code>.war</code> file) from the [http://ckfinder.com/download official download site]. 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 <code>_samples</code> folder of the distribution package. After the deployment open the <code>_samples/index.html</code> 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 <code>config.xml</code> file where you can customize your application. See the [[CKFinder_2.x/Developers Guide/Java/Configuration|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.
<source lang="xml">
<enabled>true</enabled>
</source>

== Deployment on a Server ==
The CKFinder Java connector supports the following servers:
* Tomcat 5.5-8,
* Jetty 7-9,
* JBoss 6-7,
* GlassFish 3.0-4.0,
* Weblogic 11g-12c.
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 <code>.war</code> file in the Tomcat <code>webapps</code> folder. Go to Tomcat <code>bin</code> folder and run the startup script file for your operating system — <code>startup.bat</code> for Windows or <code>startup.sh</code> for Linux. When you are running Tomcat as a service, restart the server.

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

Go to the [http://wiki.apache.org/tomcat/FAQ Tomcat FAQ] and [http://tomcat.apache.org/tomcat-5.5-doc/index.html Tomcat 5.5] or [http://tomcat.apache.org/tomcat-6.0-doc/index.html Tomcat 6], or [http://tomcat.apache.org/tomcat-7.0-doc/index.html Tomcat 7], or [http://tomcat.apache.org/tomcat-8.0-doc/index.html Tomcat 8] documentation for more information about using this server.

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

By default Jetty unpacks war files to folders like <code><nowiki>C:\Users\admin\AppData\Local\Temp\jetty-0.0.0.0-8080-CKFinderJava.war-_CKFinderJava-any-\webapp\</nowiki></code>. Information about this folder is displayed in the output console, when the server is started. If you wish to change this folder, you can either put the unpacked <code>CKFinderJava.war</code> file in the webapps folder (Jetty will use the unpacked application folder) or go to <code><nowiki>jetty7(8)\etc\jetty-webapps.xml</nowiki></code> or <code><nowiki>jetty9\etc\jetty-deploy.xml</nowiki></code> and set the below parameter to the folder path of your choice:

<source lang="xml"><Set name="tempDir"><New class="java.io.File"><Arg>C:\tmp</Arg></New></Set></source>

Go to the [http://wiki.eclipse.org/Jetty/Starting/Installing_Jetty-7.0.x Jetty 7], [http://wiki.eclipse.org/Jetty/Starting/Quick_Start_Guide Jetty 8], or [http://www.eclipse.org/jetty/documentation/current/quick-start.html Jetty 9] Quick Start guide for more information about using this server.

=== JBoss 6===
The server can be started from the command line. Go to the JBoss <code>bin</code> folder and run the following command:
* Windows: <code>run.bat</code>
* Linux: <code> run.sh</code>

JBoss Application Server ships with five different server [http://docs.jboss.org/jbossas/docs/Installation_And_Getting_Started_Guide/5/html/The_JBoss_Server___A_Quick_Tour.html#The_JBoss_Server___A_Quick_Tour-Server_Configurations configurations]: all, default, standard, minimal and jbossweb-standalone. This is because one may want to start server with selected services only. The Above command will start the server in its '''default''' mode. However, if you want to use a different configuration, e.g. start the server with all services available, you would have to pass the <code>–c</code> parameter with an appropriate configuration. In this case use the <code>all</code> value:
* Windows: <code>run.bat -c all</code>
* Linux: <code> run.sh -c all</code>
'''NOTE:''' In this example we are going to work with a single standalone server.

After the server was started, log into administration console, 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 <code>.war</code> file, and optionally check one of the following options:

* '''Deploy Exploded''' – for most usage scenarios,
* '''Deploy Farm''' – when the server works in a cluster.
If you don't select any of the options above, JBoss will be instructed to deploy CKFinder for Java as a packed war file. The application will be deployed after you click the '''Continue''' button. 

Please bear in mind that JBoss has '''auto-deploy''' mode turned on by default so it is enough to drop the <code>CKFinderJava.war</code> file or <code>CKFinderJava</code> unpacked folder into an appropriate directory. If you started your server with standard configuration (<code>run –c standard</code>), please drop <code>CKFinderJava.war</code> or <code>CKFinderJava</code> folder to the <code><nowiki>JBOSS_HOME/server/standard/deploy</nowiki></code> directory and the server will do the rest. 
Dropping packed archive is advised for production while dropping exploded folder is advised for development since you can do partial redeployments of the application with the exploded directory.

By deafult, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>.
The HTTP <code>8080</code> 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 [http://www.jboss.org/jbossas/docs/6-x JBoss AS6 Documentation site] for more information about using this server.

=== JBoss 7===
The server can be started from the command line. Go to the JBoss bin folder and run the following command:
* Windows: <code>standalone.bat</code> or <code>domain.bat</code>
* Linux: <code>standalone.sh</code> or <code>domain.sh</code>

JBoss Application Server 7 can run in two modes: standalone and domain. First one allows running a single standalone Server, while the latter is used to manage multiple physical (or virtual) machines from a single control point. 
'''NOTE:''' In this example we are going to work with a standalone server.

The above two commands start servers with their default configurations. If one wishes to start the server with one of alternative configurations, one should pass the <code>--server-config</code> argument with the server configuration file to be used. The example below shows how to run the full profile configuration with high availability:
* Windows: <code>standalone.bat --server-config=standalone-ha.xml</code>
* Linux: <code>standalone.sh --server-config=standalone-ha.xml</code>
You can read more about available JBoss 7 configurations [https://docs.jboss.org/author/display/AS71/Getting+Started+Guide#GettingStartedGuide-JBossApplicationServer7Configurations here].

After the server was started, log into administration console, go to the '''Runtime''' Tab, select '''Managed Deployments''' menu, click the '''Add contents''' button and select <code>CKFinderJava.war</code> file. Once CKFinderJava.war upload is finished, press the '''Enable''' button. The Application is now ready to use.
Another way of deploying the CKFinderJava application is using JBOSS Command Line Interface (CLI):
* '''In standalone mode:''' <code>[standalone@localhost:9999 /] deploy ~/Desktop/CKFinderJava.war</code>
* '''In domain mode:''' <code>[domain@localhost:9999 /] deploy ~/Desktop/ CKFinderJava.war --all-server-groups</code>
'''NOTE:''' Either <code>--all-server-groups</code> or <code>--server-groups must be specified</code>. 

To learn more about CLI please see this [https://community.jboss.org/wiki/CommandLineInterface link].

If your Server is running in the standalone mode, then aside from using the administration console and CLI, JBOSS 7 can also work in manual and auto deployment mode (this depends on your settings). 
In the '''Auto-Deploy mode''' the scanner directly monitors the deployment content, available in <code><nowiki>JBOSS_HOME/standalone/deployments</nowiki></code> directory, automatically deploying new content and redeploying content whose timestamp has changed. It means that you can simply drop CKFinderJava.war into deployments folder and the application will be deployed. 
To undeploy CKFinderJava in auto mode simply remove war file from deploy directory. 
In the '''Manual deploy mode''' the scanner does not directly monitor the deployment content. Instead, the scanner relies on a system of marker files, which the user can add to or remove from deployment directory. These files serve as a sort of command telling the scanner to deploy, undeploy, or redeploy the content. You can learn more about marker files in the "Marker Files" section available under this [https://docs.jboss.org/author/display/AS7/Application+deploymen link].

To deploy <code>CKFinderJava.war</code> in manual mode, copy this file into the deployments directory and create the <code>CKFinderJava.war.dodeploy</code> file. CKFinder will be deployed and the <code>CKFinderJava.war.deployed</code> marker file will be created. To undeploy CKFinderJava simply remove <code>CKFinderJava.war.deployed</code> file.

Please note that by default JBOSS7 allows auto-deployment of zipped content and prevents auto-deployment of exploded content. This is because exploded content is vulnerable to the scanner trying to auto-deploy partially copied content. However, if you wish to change this behavior, you can go to the <code><nowiki>JBOSS_HOME/standalone/configuration/standalone.xml</nowiki></code> file, look for the '''deployment-scanner'' tag and change the deployment options as you like:

<source lang="xml">
<deployment-scanner scan-interval="5000" relative-to="jboss.server.base.dir" path="deployments"
auto-deploy-zipped="true" auto-deploy-exploded="false"/>
</source>

By default, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>
Please note that the HTTP <code>8080</code> 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.

If you want to use international files names with CKFinder please see [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Configuration/URI_Encoding URI Encoding section] which explains how to set UTF-8 on JBOSS.

Go to the JBoss AS7 [https://docs.jboss.org/author/display/AS7/Getting+Started+Guide Documentation] site for more information about using this server.

=== GlassFish ===
The GlassFish server can be started from the command line. Go to the server <code>bin</code> folder and run the <code>asadmin</code> 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 <code>start-domain</code> 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: 

* <code>deploy relativePath/CKFinderJava.war</code>

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

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

By default, Glassfish has ISO parameter-encoding set, which may cause problems if your users want to use filenames with non-ISO characters. If CKFinder in your application is to be used worldwide, it is recommended to set UTF-8 for Glassfish. Please refer to the [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Configuration/URI_Encodinglink URI Encoding] section for more details.

Go to the Oracle [http://docs.oracle.com/cd/E19798-01/821-1757/index.html GlassFish 3.0] or, [http://docs.oracle.com/cd/E18930_01/html/821-2432/ GlassFish 3.1] or [https://glassfish.java.net/getstarted.html GlassFish 4.0] Server Quick Start Guide for more information about using this server.

=== Weblogic ===
The Weblogic Server (WLS) can be started from the command line. Go to the <code><nowiki>weblogic_main_folder/user_projects/domains/your_domain/bin</nowiki></code> folder and run the following script:
* Windows: <code>startWeblogic.cmd</code> or <code>startManagedWebLogic.cmd</code>
* Linux: <code>startWeblogic.sh</code> or <code>startManagedWebLogic.sh</code>
If Weblogic is in production mode then please remember that you need to specify the user name and password in order to run it.

As you probably know, Weblogic Server uses domains which are logically related groups of server resources. A domain can consist of an Administration Server and one or more Managed Servers, or of a single standalone server that acts as an Administration Server and runs deployed applications. In this example we are going to use a single standalone Administration Server.

After starting Weblogic, log into the Administration Console and click '''Deployments''' in the '''Domain Structure''' upper left menu. If WLS is in production mode, you need to click '''Lock&Edit''' first. In main panel click the '''Install''' button, specify the path to <code>CKFinderJava.war</code>, and click the '''Next''' button. Select the '''"Install this deployment as an application"''' option and press the '''Next''' button. In the last panel you can change the name of your deployment, the security model and the source accessibility. Once you are done, click the '''Finish''' button and CKFinderJava will be deployed. If WLS works in production mode, you will need to confirm all changes by clicking the '''Activate Changes''' button and start the application manually by selecting it and pressing the '''Start''' button.

By deafult, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:7001/CKFinderJava/</nowiki></code>

The HTTP <code>7001</code> port of the sample URL is the default Weblogic Administration Server port. If you changed this value while configuring your Weblogic domain(s), you will need to use a modified port value to run the sample application.

Go to the [http://docs.oracle.com/cd/E17904_01/index.htm Weblogic 11g] or [http://docs.oracle.com/cd/E24329_01/index.htm Weblogic 12c] Documentation site for more information about using this server.

CKFinder 2.x/Developers Guide/Java/Installation

2015-08-17T11:33:51Z

J.swiderski:

__TOC__
{{#CUSTOMTITLE:CKFinder Installation}}
This article describes how to install CKFinder for Java.

== Installation Procedure ==
To install CKFinder, download the CKFinder for Java distribution package (a <code>.war</code> file) from the [http://ckfinder.com/download official download site]. 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 <code>_samples</code> folder of the distribution package. After the deployment open the <code>_samples/index.html</code> 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 <code>config.xml</code> file where you can customize your application. See the [[CKFinder_2.x/Developers Guide/Java/Configuration|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.
<source lang="xml">
<enabled>true</enabled>
</source>

== Deployment on a Server ==
The CKFinder Java connector supports the following servers:
* Tomcat 5.5-8,
* Jetty 7-9,
* JBoss 6-7,
* GlassFish 3.0-4.0,
* Weblogic 11g-12c.
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 <code>.war</code> file in the Tomcat <code>webapps</code> folder. Go to Tomcat <code>bin</code> folder and run the startup script file for your operating system — <code>startup.bat</code> for Windows or <code>startup.sh</code> for Linux. When you are running Tomcat as a service, restart the server.

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

Go to the [http://wiki.apache.org/tomcat/FAQ Tomcat FAQ] and [http://tomcat.apache.org/tomcat-5.5-doc/index.html Tomcat 5.5] or [http://tomcat.apache.org/tomcat-6.0-doc/index.html Tomcat 6], or [http://tomcat.apache.org/tomcat-7.0-doc/index.html Tomcat 7], or [http://tomcat.apache.org/tomcat-8.0-doc/index.html Tomcat 8] documentation for more information about using this server.

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

By default Jetty unpacks war files to folders like <code><nowiki>C:\Users\admin\AppData\Local\Temp\jetty-0.0.0.0-8080-CKFinderJava.war-_CKFinderJava-any-\webapp\</nowiki></code>. Information about this folder is displayed in the output console, when the server is started. If you wish to change this folder, you can either put the unpacked <code>CKFinderJava.war</code> file in the webapps folder (Jetty will use the unpacked application folder) or go to <code><nowiki>jetty7(8)\etc\jetty-webapps.xml</nowiki></code> or <code><nowiki>jetty9\etc\jetty-deploy.xml</nowiki></code> and set the below parameter to the folder path of your choice:

<source lang="xml"><Set name="tempDir"><New class="java.io.File"><Arg>C:\tmp</Arg></New></Set></source>

Go to the [http://wiki.eclipse.org/Jetty/Starting/Installing_Jetty-7.0.x Jetty 7], [http://wiki.eclipse.org/Jetty/Starting/Quick_Start_Guide Jetty 8], or [http://www.eclipse.org/jetty/documentation/current/quick-start.html Jetty 9] Quick Start guide for more information about using this server.

=== JBoss 6===
The server can be started from the command line. Go to the JBoss <code>bin</code> folder and run the following command:
* Windows: <code>run.bat</code>
* Linux: <code> run.sh</code>

JBoss Application Server ships with five different server [http://docs.jboss.org/jbossas/docs/Installation_And_Getting_Started_Guide/5/html/The_JBoss_Server___A_Quick_Tour.html#The_JBoss_Server___A_Quick_Tour-Server_Configurations configurations]: all, default, standard, minimal and jbossweb-standalone. This is because one may want to start server with selected services only. The Above command will start the server in its '''default''' mode. However, if you want to use a different configuration, e.g. start the server with all services available, you would have to pass the <code>–c</code> parameter with an appropriate configuration. In this case use the <code>all</code> value:
* Windows: <code>run.bat -c all</code>
* Linux: <code> run.sh -c all</code>
'''NOTE:''' In this example we are going to work with a single standalone server.

After the server was started, log into administration console, 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 <code>.war</code> file, and optionally check one of the following options:

* '''Deploy Exploded''' – for most usage scenarios,
* '''Deploy Farm''' – when the server works in a cluster.
If you don't select any of the options above, JBoss will be instructed to deploy CKFinder for Java as a packed war file. The application will be deployed after you click the '''Continue''' button. 

Please bear in mind that JBoss has '''auto-deploy''' mode turned on by default so it is enough to drop the <code>CKFinderJava.war</code> file or <code>CKFinderJava</code> unpacked folder into an appropriate directory. If you started your server with standard configuration (<code>run –c standard</code>), please drop <code>CKFinderJava.war</code> or <code>CKFinderJava</code> folder to the <code><nowiki>JBOSS_HOME/server/standard/deploy</nowiki></code> directory and the server will do the rest. 
Dropping packed archive is advised for production while dropping exploded folder is advised for development since you can do partial redeployments of the application with the exploded directory.

By deafult, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>.
The HTTP <code>8080</code> 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 [http://www.jboss.org/jbossas/docs/6-x JBoss AS6 Documentation site] for more information about using this server.

=== JBoss 7===
The server can be started from the command line. Go to the JBoss bin folder and run the following command:
* Windows: <code>standalone.bat</code> or <code>domain.bat</code>
* Linux: <code>standalone.sh</code> or <code>domain.sh</code>

JBoss Application Server 7 can run in two modes: standalone and domain. First one allows running a single standalone Server, while the latter is used to manage multiple physical (or virtual) machines from a single control point. 
'''NOTE:''' In this example we are going to work with a standalone server.

The above two commands start servers with their default configurations. If one wishes to start the server with one of alternative configurations, one should pass the <code>--server-config</code> argument with the server configuration file to be used. The example below shows how to run the full profile configuration with high availability:
* Windows: <code>standalone.bat --server-config=standalone-ha.xml</code>
* Linux: <code>standalone.sh --server-config=standalone-ha.xml</code>
You can read more about available JBoss 7 configurations [https://docs.jboss.org/author/display/AS71/Getting+Started+Guide#GettingStartedGuide-JBossApplicationServer7Configurations here].

After the server was started, log into administration console, go to the '''Runtime''' Tab, select '''Managed Deployments''' menu, click the '''Add contents''' button and select <code>CKFinderJava.war</code> file. Once CKFinderJava.war upload is finished, press the '''Enable''' button. The Application is now ready to use.
Another way of deploying the CKFinderJava application is using JBOSS Command Line Interface (CLI):
* '''In standalone mode:''' <code>[standalone@localhost:9999 /] deploy ~/Desktop/CKFinderJava.war</code>
* '''In domain mode:''' <code>[domain@localhost:9999 /] deploy ~/Desktop/ CKFinderJava.war --all-server-groups</code>
'''NOTE:''' Either <code>--all-server-groups</code> or <code>--server-groups must be specified</code>. 

To learn more about CLI please see this [https://community.jboss.org/wiki/CommandLineInterface link].

If your Server is running in the standalone mode, then aside from using the administration console and CLI, JBOSS 7 can also work in manual and auto deployment mode (this depends on your settings). 
In the '''Auto-Deploy mode''' the scanner directly monitors the deployment content, available in <code><nowiki>JBOSS_HOME/standalone/deployments</nowiki></code> directory, automatically deploying new content and redeploying content whose timestamp has changed. It means that you can simply drop CKFinderJava.war into deployments folder and the application will be deployed. 
To undeploy CKFinderJava in auto mode simply remove war file from deploy directory. 
In the '''Manual deploy mode''' the scanner does not directly monitor the deployment content. Instead, the scanner relies on a system of marker files, which the user can add to or remove from deployment directory. These files serve as a sort of command telling the scanner to deploy, undeploy, or redeploy the content. You can learn more about marker files in the "Marker Files" section available under this [https://docs.jboss.org/author/display/AS7/Application+deploymen link].

To deploy <code>CKFinderJava.war</code> in manual mode, copy this file into the deployments directory and create the <code>CKFinderJava.war.dodeploy</code> file. CKFinder will be deployed and the <code>CKFinderJava.war.deployed</code> marker file will be created. To undeploy CKFinderJava simply remove <code>CKFinderJava.war.deployed</code> file.

Please note that by default JBOSS7 allows auto-deployment of zipped content and prevents auto-deployment of exploded content. This is because exploded content is vulnerable to the scanner trying to auto-deploy partially copied content. However, if you wish to change this behavior, you can go to the <code><nowiki>JBOSS_HOME/standalone/configuration/standalone.xml</nowiki></code> file, look for the '''deployment-scanner'' tag and change the deployment options as you like:

<source lang="xml">
<deployment-scanner scan-interval="5000" relative-to="jboss.server.base.dir" path="deployments"
auto-deploy-zipped="true" auto-deploy-exploded="false"/>
</source>

By default, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>
Please note that the HTTP <code>8080</code> 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.

If you want to use international files names with CKFinder please see [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Configuration/URI_Encoding URI Encoding section] which explains how to set UTF-8 on JBOSS.

Go to the JBoss AS7 [https://docs.jboss.org/author/display/AS7/Getting+Started+Guide Documentation] site for more information about using this server.

=== GlassFish ===
The GlassFish server can be started from the command line. Go to the server <code>bin</code> folder and run the <code>asadmin</code> 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 <code>start-domain</code> 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: 

* <code>deploy relativePath/CKFinderJava.war</code>

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

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

By default, Glassfish has ISO parameter-encoding set, which may cause problems if your users want to use filenames with non-ISO characters. If CKFinder in your application is to be used worldwide, it is recommended to set UTF-8 for Glassfish. Please refer to the [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Configuration/URI_Encodinglink URI Encoding] section for more details.

Go to the Oracle [http://docs.oracle.com/cd/E19798-01/821-1757/index.html GlassFish 3.0] or, [http://docs.oracle.com/cd/E18930_01/html/821-2432/ GlassFish 3.1] or [https://glassfish.java.net/getstarted.html GlassFish 4.0] Server Quick Start Guide for more information about using this server.

=== Weblogic ===
The Weblogic Server (WLS) can be started from the command line. Go to the <code><nowiki>weblogic_main_folder/user_projects/domains/your_domain/bin</nowiki></code> folder and run the following script:
* Windows: <code>startWeblogic.cmd</code> or <code>startManagedWebLogic.cmd</code>
* Linux: <code>startWeblogic.sh</code> or <code>startWeblogicManagedServer.sh</code>
If Weblogic is in production mode then please remember that you need to specify the user name and password in order to run it.

As you probably know, Weblogic Server uses domains which are logically related groups of server resources. A domain can consist of an Administration Server and one or more Managed Servers, or of a single standalone server that acts as an Administration Server and runs deployed applications. In this example we are going to use a single standalone Administration Server.

After starting Weblogic, log into the Administration Console and click '''Deployments''' in the '''Domain Structure''' upper left menu. If WLS is in production mode, you need to click '''Lock&Edit''' first. In main panel click the '''Install''' button, specify the path to <code>CKFinderJava.war</code>, and click the '''Next''' button. Select the '''"Install this deployment as an application"''' option and press the '''Next''' button. In the last panel you can change the name of your deployment, the security model and the source accessibility. Once you are done, click the '''Finish''' button and CKFinderJava will be deployed. If WLS works in production mode, you will need to confirm all changes by clicking the '''Activate Changes''' button and start the application manually by selecting it and pressing the '''Start''' button.

By deafult, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:7001/CKFinderJava/</nowiki></code>

The HTTP <code>7001</code> port of the sample URL is the default Weblogic Administration Server port. If you changed this value while configuring your Weblogic domain(s), you will need to use a modified port value to run the sample application.

Go to the [http://docs.oracle.com/cd/E17904_01/index.htm Weblogic 11g] or [http://docs.oracle.com/cd/E24329_01/index.htm Weblogic 12c] Documentation site for more information about using this server.

Template:Drupal OS CKFinder

2015-07-14T12:59:54Z

J.swiderski:

CKFinder is an Ajax-based file manager created by CKEditor developers: http://ckfinder.com/. CKFinder support is already built into the CKEditor for Drupal module, but due to licensing issues you need to buy it separately, add the files to your Drupal site and then enable the file browser.

<note>Below instructions are valid for '''CKFinder 2.x only'''. Module as well as documentation will be adjusted to new CKFinder 3.x soon.</note>

<note>If you are looking for a simplified solution, try the [http://ckeditor.com/ckeditor-for-drupal Enterprise version of the module] that comes with a CKFinder license and the file browser already included in the module and working out-of-the-box. The Enterprise version of the component also includes professional assistance from the original CKEditor development team in the form of a '''dedicated e-mail support channel'''.</note>

If you want to install CKFinder on your Drupal {{{version}}} site, follow the steps described below.

First of all, download '''CKFinder for PHP''' from the [http://ckfinder.com/download official CKFinder website].

Unpack the contents of the installation package into the directory that contains the CKEditor module and place it in the <code>sites/all/modules/ckeditor/ckfinder</code> (or <code>sites/all/libraries/ckfinder</code>) folder. . When the files are unpacked, you should see the following file structure inside the <code>drupal/sites/all/modules</code> directory:
<source>
modules <dir>
ckeditor <dir>
ckeditor.css
ckeditor.info
...
ckeditor <dir>
_samples <dir>
_source <dir>
adapters <dir>
images <dir>
...
ckeditor.js
...
ckfinder <dir>
_samples <dir>
core <dir>
...
ckfinder.js
ckfinder.php
...
</source>

You will now need to grant the '''"{{{permission}}}"''' permission in the '''Administration panel''' > '''{{{path1}}}''' > '''Permissions''' section. Note: if you do not see this permission, it means that CKEditor did not find CKFinder and you have probably uploaded CKFinder into a wrong directory.

[[Image:Drupal_{{{version}}}_Enterprise_CKFinder_permission.png|frame|center|Granting CKFinder access permission in the Drupal Administration panel]]

Now open the CKFinder configuration file (<code>ckfinder/config.php</code>) and introduce the code changes described below.

Firstly, remove the <code>CheckAuthentication()</code> function (do not worry, this function is defined in <code>filemanager.config.php</code>, see below):
<source lang="php">
function CheckAuthentication() <- remove it
{ <- remove it
//WARNING : DO NOT simply... <- remove it
... <- remove it
return false; <- remove it
} <- remove it
</source>
For CKFinder installed in the <code>sites/all/modules/ckeditor/ckfinder</code> directory add:
<source lang="php">
require_once '../../../../includes/filemanager.config.php';
</source>
straight below the following line:
<source lang="php">
$baseDir = resolveUrl($baseUrl);
</source>
For CKFinder installed in the <code>sites/all/libraries/ckfinder</code> directory add:
<source lang="php">
require_once '../../../../../modules/ckeditor/includes/filemanager.config.php';
</source>
straight below the following line:
<source lang="php">
$baseDir = resolveUrl($baseUrl);
</source>

Now open the Drupal settings file (<code>sites/default/settings.php</code>) and do the following:
* Uncomment the <code>$base_url</code> variable and set the base URL of your website (without the trailing slash).
* Uncomment the <code>$cookie_domain</code> variable and set the domain name of your website.

Select CKFinder as a preferred file browser in the '''Administration panel''' > '''{{{path2}}}''' > '''CKEditor''' section (for a selected CKEditor profile scroll down to the '''File browser settings''' section).

[[Image:Drupal_{{{version}}}_OS_enable_CKFinder.png|frame|center|Selecting CKFinder as a preferred file browser in the Drupal Administration panel]]

You can now [[CKEditor_for_Drupal/Open Source/Drupal_{{{version}}}/Configuration|configure]] CKFinder settings in the '''File browser settings''' section for the CKEditor profile that you want to use. You may also change destination folders for files uploaded with CKFinder.

CKFinder 2.x/Developers Guide/Java/Installation

2015-06-28T21:48:32Z

J.swiderski:

__TOC__
{{#CUSTOMTITLE:CKFinder Installation}}
This article describes how to install CKFinder for Java.

== Installation Procedure ==
To install CKFinder, download the CKFinder for Java distribution package (a <code>.war</code> file) from the [http://ckfinder.com/download official download site]. 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 <code>_samples</code> folder of the distribution package. After the deployment open the <code>_samples/index.html</code> 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 <code>config.xml</code> file where you can customize your application. See the [[CKFinder_2.x/Developers Guide/Java/Configuration|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.
<source lang="xml">
<enabled>true</enabled>
</source>

== Deployment on a Server ==
The CKFinder Java connector supports the following servers:
* Tomcat 5.5-8,
* Jetty 7-9,
* JBoss 6-7,
* GlassFish 3.0-4.0,
* Weblogic 11g-12c.
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 <code>.war</code> file in the Tomcat <code>webapps</code> folder. Go to Tomcat <code>bin</code> folder and run the startup script file for your operating system — <code>startup.bat</code> for Windows or <code>startup.sh</code> for Linux. When you are running Tomcat as a service, restart the server.

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

Go to the [http://wiki.apache.org/tomcat/FAQ Tomcat FAQ] and [http://tomcat.apache.org/tomcat-5.5-doc/index.html Tomcat 5.5] or [http://tomcat.apache.org/tomcat-6.0-doc/index.html Tomcat 6], or [http://tomcat.apache.org/tomcat-7.0-doc/index.html Tomcat 7], or [http://tomcat.apache.org/tomcat-8.0-doc/index.html Tomcat 8] documentation for more information about using this server.

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

By default Jetty unpacks war files to folders like <code><nowiki>C:\Users\admin\AppData\Local\Temp\jetty-0.0.0.0-8080-CKFinderJava.war-_CKFinderJava-any-\webapp\</nowiki></code>. Information about this folder is displayed in the output console, when the server is started. If you wish to change this folder, you can either put the unpacked <code>CKFinderJava.war</code> file in the webapps folder (Jetty will use the unpacked application folder) or go to <code><nowiki>jetty7(8)\etc\jetty-webapps.xml</nowiki></code> or <code><nowiki>jetty9\etc\jetty-deploy.xml</nowiki></code> and set the below parameter to the folder path of your choice:

<source lang="xml"><Set name="tempDir"><New class="java.io.File"><Arg>C:\tmp</Arg></New></Set></source>

Go to the [http://wiki.eclipse.org/Jetty/Starting/Installing_Jetty-7.0.x Jetty 7], [http://wiki.eclipse.org/Jetty/Starting/Quick_Start_Guide Jetty 8], or [http://www.eclipse.org/jetty/documentation/current/quick-start.html Jetty 9] Quick Start guide for more information about using this server.

=== JBoss 6===
The server can be started from the command line. Go to the JBoss <code>bin</code> folder and run the following command:
* Windows: <code>run.bat</code>
* Linux: <code> run.sh</code>

JBoss Application Server ships with five different server [http://docs.jboss.org/jbossas/docs/Installation_And_Getting_Started_Guide/5/html/The_JBoss_Server___A_Quick_Tour.html#The_JBoss_Server___A_Quick_Tour-Server_Configurations configurations]: all, default, standard, minimal and jbossweb-standalone. This is because one may want to start server with selected services only. The Above command will start the server in its '''default''' mode. However, if you want to use a different configuration, e.g. start the server with all services available, you would have to pass the <code>–c</code> parameter with an appropriate configuration. In this case use the <code>all</code> value:
* Windows: <code>run.bat -c all</code>
* Linux: <code> run.sh -c all</code>
'''NOTE:''' In this example we are going to work with a single standalone server.

After the server was started, log into administration console, 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 <code>.war</code> file, and optionally check one of the following options:

* '''Deploy Exploded''' – for most usage scenarios,
* '''Deploy Farm''' – when the server works in a cluster.
If you don't select any of the options above, JBoss will be instructed to deploy CKFinder for Java as a packed war file. The application will be deployed after you click the '''Continue''' button. 

Please bear in mind that JBoss has '''auto-deploy''' mode turned on by default so it is enough to drop the <code>CKFinderJava.war</code> file or <code>CKFinderJava</code> unpacked folder into an appropriate directory. If you started your server with standard configuration (<code>run –c standard</code>), please drop <code>CKFinderJava.war</code> or <code>CKFinderJava</code> folder to the <code><nowiki>JBOSS_HOME/server/standard/deploy</nowiki></code> directory and the server will do the rest. 
Dropping packed archive is advised for production while dropping exploded folder is advised for development since you can do partial redeployments of the application with the exploded directory.

By deafult, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>.
The HTTP <code>8080</code> 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 [http://www.jboss.org/jbossas/docs/6-x JBoss AS6 Documentation site] for more information about using this server.

=== JBoss 7===
The server can be started from the command line. Go to the JBoss bin folder and run the following command:
* Windows: <code>standalone.bat</code> or <code>domain.bat</code>
* Linux: <code>standalone.sh</code> or <code>domain.sh</code>

JBoss Application Server 7 can run in two modes: standalone and domain. First one allows running a single standalone Server, while the latter is used to manage multiple physical (or virtual) machines from a single control point. 
'''NOTE:''' In this example we are going to work with a standalone server.

The above two commands start servers with their default configurations. If one wishes to start the server with one of alternative configurations, one should pass the <code>--server-config</code> argument with the server configuration file to be used. The example below shows how to run the full profile configuration with high availability:
* Windows: <code>standalone.bat --server-config=standalone-ha.xml</code>
* Linux: <code>standalone.sh --server-config=standalone-ha.xml</code>
You can read more about available JBoss 7 configurations [https://docs.jboss.org/author/display/AS71/Getting+Started+Guide#GettingStartedGuide-JBossApplicationServer7Configurations here].

After the server was started, log into administration console, go to the '''Runtime''' Tab, select '''Managed Deployments''' menu, click the '''Add contents''' button and select <code>CKFinderJava.war</code> file. Once CKFinderJava.war upload is finished, press the '''Enable''' button. The Application is now ready to use.
Another way of deploying the CKFinderJava application is using JBOSS Command Line Interface (CLI):
* '''In standalone mode:''' <code>[standalone@localhost:9999 /] deploy ~/Desktop/CKFinderJava.war</code>
* '''In domain mode:''' <code>[domain@localhost:9999 /] deploy ~/Desktop/ CKFinderJava.war --all-server-groups</code>
'''NOTE:''' Either <code>--all-server-groups</code> or <code>--server-groups must be specified</code>. 

To learn more about CLI please see this [https://community.jboss.org/wiki/CommandLineInterface link].

If your Server is running in the standalone mode, then aside from using the administration console and CLI, JBOSS 7 can also work in manual and auto deployment mode (this depends on your settings). 
In the '''Auto-Deploy mode''' the scanner directly monitors the deployment content, available in <code><nowiki>JBOSS_HOME/standalone/deployments</nowiki></code> directory, automatically deploying new content and redeploying content whose timestamp has changed. It means that you can simply drop CKFinderJava.war into deployments folder and the application will be deployed. 
To undeploy CKFinderJava in auto mode simply remove war file from deploy directory. 
In the '''Manual deploy mode''' the scanner does not directly monitor the deployment content. Instead, the scanner relies on a system of marker files, which the user can add to or remove from deployment directory. These files serve as a sort of command telling the scanner to deploy, undeploy, or redeploy the content. You can learn more about marker files in the "Marker Files" section available under this [https://docs.jboss.org/author/display/AS7/Application+deploymen link].

To deploy <code>CKFinderJava.war</code> in manual mode, copy this file into the deployments directory and create the <code>CKFinderJava.war.dodeploy</code> file. CKFinder will be deployed and the <code>CKFinderJava.war.deployed</code> marker file will be created. To undeploy CKFinderJava simply remove <code>CKFinderJava.war.deployed</code> file.

Please note that by default JBOSS7 allows auto-deployment of zipped content and prevents auto-deployment of exploded content. This is because exploded content is vulnerable to the scanner trying to auto-deploy partially copied content. However, if you wish to change this behavior, you can go to the <code><nowiki>JBOSS_HOME/standalone/configuration/standalone.xml</nowiki></code> file, look for the '''deployment-scanner'' tag and change the deployment options as you like:

<source lang="xml">
<deployment-scanner scan-interval="5000" relative-to="jboss.server.base.dir" path="deployments"
auto-deploy-zipped="true" auto-deploy-exploded="false"/>
</source>

By default, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>
Please note that the HTTP <code>8080</code> 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.

If you want to use international files names with CKFinder please see [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Configuration/URI_Encoding URI Encoding section] which explains how to set UTF-8 on JBOSS.

Go to the JBoss AS7 [https://docs.jboss.org/author/display/AS7/Getting+Started+Guide Documentation] site for more information about using this server.

=== GlassFish ===
The GlassFish server can be started from the command line. Go to the server <code>bin</code> folder and run the <code>asadmin</code> 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 <code>start-domain</code> 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: 

* <code>deploy relativePath/CKFinderJava.war</code>

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

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

By default, Glassfish has ISO parameter-encoding set, which may cause problems if your users want to use filenames with non-ISO characters. If CKFinder in your application is to be used worldwide, it is recommended to set UTF-8 for Glassfish. Please refer to the [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Configuration/URI_Encodinglink URI Encoding] section for more details.

Go to the Oracle [http://docs.oracle.com/cd/E19798-01/821-1757/index.html GlassFish 3.0] or, [http://docs.oracle.com/cd/E18930_01/html/821-2432/ GlassFish 3.1] or [https://glassfish.java.net/getstarted.html GlassFish 4.0] Server Quick Start Guide for more information about using this server.

=== Weblogic ===
The Weblogic Server (WLS) can be started from the command line. Go to the <code><nowiki>weblogic_main_folder/user_projects/domains/your_domain/bin</nowiki></code> folder and run the following script:
* Windows: <code>startWeblogic.bat</code> or <code>startWeblogicManagedServer.bat</code>
* Linux: <code>startWeblogic.sh</code> or <code>startWeblogicManagedServer.sh</code>
If Weblogic is in production mode then please remember that you need to specify the user name and password in order to run it.

As you probably know, Weblogic Server uses domains which are logically related groups of server resources. A domain can consist of an Administration Server and one or more Managed Servers, or of a single standalone server that acts as an Administration Server and runs deployed applications. In this example we are going to use a single standalone Administration Server.

After starting Weblogic, log into the Administration Console and click '''Deployments''' in the '''Domain Structure''' upper left menu. If WLS is in production mode, you need to click '''Lock&Edit''' first. In main panel click the '''Install''' button, specify the path to <code>CKFinderJava.war</code>, and click the '''Next''' button. Select the '''"Install this deployment as an application"''' option and press the '''Next''' button. In the last panel you can change the name of your deployment, the security model and the source accessibility. Once you are done, click the '''Finish''' button and CKFinderJava will be deployed. If WLS works in production mode, you will need to confirm all changes by clicking the '''Activate Changes''' button and start the application manually by selecting it and pressing the '''Start''' button.

By deafult, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:7001/CKFinderJava/</nowiki></code>

The HTTP <code>7001</code> port of the sample URL is the default Weblogic Administration Server port. If you changed this value while configuring your Weblogic domain(s), you will need to use a modified port value to run the sample application.

Go to the [http://docs.oracle.com/cd/E17904_01/index.htm Weblogic 11g] or [http://docs.oracle.com/cd/E24329_01/index.htm Weblogic 12c] Documentation site for more information about using this server.

CKFinder 2.x/Developers Guide/Java/Installation

2015-06-14T00:01:54Z

J.swiderski:

__TOC__
{{#CUSTOMTITLE:CKFinder Installation}}
This article describes how to install CKFinder for Java.

== Installation Procedure ==
To install CKFinder, download the CKFinder for Java distribution package (a <code>.war</code> file) from the [http://ckfinder.com/download official download site]. 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 <code>_samples</code> folder of the distribution package. After the deployment open the <code>_samples/index.html</code> 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 <code>config.xml</code> file where you can customize your application. See the [[CKFinder_2.x/Developers Guide/Java/Configuration|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.
<source lang="xml">
<enabled>true</enabled>
</source>

== Deployment on a Server ==
The CKFinder Java connector supports the following servers:
* Tomcat 5.5-8,
* Jetty 7-9,
* JBoss 6-7,
* GlassFish 3.0-4.0,
* Weblogic 11g-12c.
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 <code>.war</code> file in the Tomcat <code>webapps</code> folder. Go to Tomcat <code>bin</code> folder and run the startup script file for your operating system — <code>startup.bat</code> for Windows or <code>startup.sh</code> for Linux. When you are running Tomcat as a service, restart the server.

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

Go to the [http://wiki.apache.org/tomcat/FAQ Tomcat FAQ] and [http://tomcat.apache.org/tomcat-5.5-doc/index.html Tomcat 5.5] or [http://tomcat.apache.org/tomcat-6.0-doc/index.html Tomcat 6], or [http://tomcat.apache.org/tomcat-7.0-doc/index.html Tomcat 7], or [http://tomcat.apache.org/tomcat-8.0-doc/index.html Tomcat 8] documentation for more information about using this server.

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

By default Jetty unpacks war files to folders like <code><nowiki>C:\Users\admin\AppData\Local\Temp\jetty-0.0.0.0-8080-CKFinderJava.war-_CKFinderJava-any-\webapp\</nowiki></code>. Information about this folder is displayed in the output console, when the server is started. If you wish to change this folder, you can either put the unpacked <code>CKFinderJava.war</code> file in the webapps folder (Jetty will use the unpacked application folder) or go to <code><nowiki>jetty7(8)\etc\jetty-webapps.xml</nowiki></code> or <code><nowiki>jetty9\etc\jetty-deploy.xml</nowiki></code> and set the below parameter to the folder path of your choice:

<source lang="xml"><Set name="tempDir"><New class="java.io.File"><Arg>C:\tmp</Arg></New></Set></source>

Go to the [http://wiki.eclipse.org/Jetty/Starting/Installing_Jetty-7.0.x Jetty 7], [http://wiki.eclipse.org/Jetty/Starting/Quick_Start_Guide Jetty 8], or [http://www.eclipse.org/jetty/documentation/current/quick-start.html Jetty 9] Quick Start guide for more information about using this server.

=== JBoss 6===
The server can be started from the command line. Go to the JBoss <code>bin</code> folder and run the following command:
* Windows: <code>run.bat</code>
* Linux: <code> run.sh</code>

JBoss Application Server ships with five different server [http://docs.jboss.org/jbossas/docs/Installation_And_Getting_Started_Guide/5/html/The_JBoss_Server___A_Quick_Tour.html#The_JBoss_Server___A_Quick_Tour-Server_Configurations configurations]: all, default, standard, minimal and jbossweb-standalone. This is because one may want to start server with selected services only. The Above command will start the server in its '''default''' mode. However, if you want to use a different configuration, e.g. start the server with all services available, you would have to pass the <code>–c</code> parameter with an appropriate configuration. In this case use the <code>all</code> value:
* Windows: <code>run.bat -c all</code>
* Linux: <code> run.sh -c all</code>
'''NOTE:''' In this example we are going to work with a single standalone server.

After the server was started, log into administration console, 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 <code>.war</code> file, and optionally check one of the following options:

* '''Deploy Exploded''' – for most usage scenarios,
* '''Deploy Farm''' – when the server works in a cluster.
If you don't select any of the options above, JBoss will be instructed to deploy CKFinder for Java as a packed war file. The application will be deployed after you click the '''Continue''' button. 

Please bear in mind that JBoss has '''auto-deploy''' mode turned on by default so it is enough to drop the <code>CKFinderJava.war</code> file into an appropriate directory. If you started your server with standard configuration (<code>run –c standard</code>), please drop <code>CKFinderJava.war</code> to the <code><nowiki>JBOSS_HOME/server/standard/deploy</nowiki></code> folder and the server will do the rest.

By deafult, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>.
The HTTP <code>8080</code> 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 [http://www.jboss.org/jbossas/docs/6-x JBoss AS6 Documentation site] for more information about using this server.

=== JBoss 7===
The server can be started from the command line. Go to the JBoss bin folder and run the following command:
* Windows: <code>standalone.bat</code> or <code>domain.bat</code>
* Linux: <code>standalone.sh</code> or <code>domain.sh</code>

JBoss Application Server 7 can run in two modes: standalone and domain. First one allows running a single standalone Server, while the latter is used to manage multiple physical (or virtual) machines from a single control point. 
'''NOTE:''' In this example we are going to work with a standalone server.

The above two commands start servers with their default configurations. If one wishes to start the server with one of alternative configurations, one should pass the <code>--server-config</code> argument with the server configuration file to be used. The example below shows how to run the full profile configuration with high availability:
* Windows: <code>standalone.bat --server-config=standalone-ha.xml</code>
* Linux: <code>standalone.sh --server-config=standalone-ha.xml</code>
You can read more about available JBoss 7 configurations [https://docs.jboss.org/author/display/AS71/Getting+Started+Guide#GettingStartedGuide-JBossApplicationServer7Configurations here].

After the server was started, log into administration console, go to the '''Runtime''' Tab, select '''Managed Deployments''' menu, click the '''Add contents''' button and select <code>CKFinderJava.war</code> file. Once CKFinderJava.war upload is finished, press the '''Enable''' button. The Application is now ready to use.
Another way of deploying the CKFinderJava application is using JBOSS Command Line Interface (CLI):
* '''In standalone mode:''' <code>[standalone@localhost:9999 /] deploy ~/Desktop/CKFinderJava.war</code>
* '''In domain mode:''' <code>[domain@localhost:9999 /] deploy ~/Desktop/ CKFinderJava.war --all-server-groups</code>
'''NOTE:''' Either <code>--all-server-groups</code> or <code>--server-groups must be specified</code>. 

To learn more about CLI please see this [https://community.jboss.org/wiki/CommandLineInterface link].

If your Server is running in the standalone mode, then aside from using the administration console and CLI, JBOSS 7 can also work in manual and auto deployment mode (this depends on your settings). 
In the '''Auto-Deploy mode''' the scanner directly monitors the deployment content, available in <code><nowiki>JBOSS_HOME/standalone/deployments</nowiki></code> directory, automatically deploying new content and redeploying content whose timestamp has changed. It means that you can simply drop CKFinderJava.war into deployments folder and the application will be deployed. 
To undeploy CKFinderJava in auto mode simply remove war file from deploy directory. 
In the '''Manual deploy mode''' the scanner does not directly monitor the deployment content. Instead, the scanner relies on a system of marker files, which the user can add to or remove from deployment directory. These files serve as a sort of command telling the scanner to deploy, undeploy, or redeploy the content. You can learn more about marker files in the "Marker Files" section available under this [https://docs.jboss.org/author/display/AS7/Application+deploymen link].

To deploy <code>CKFinderJava.war</code> in manual mode, copy this file into the deployments directory and create the <code>CKFinderJava.war.dodeploy</code> file. CKFinder will be deployed and the <code>CKFinderJava.war.deployed</code> marker file will be created. To undeploy CKFinderJava simply remove <code>CKFinderJava.war.deployed</code> file.

Please note that by default JBOSS7 allows auto-deployment of zipped content and prevents auto-deployment of exploded content. This is because exploded content is vulnerable to the scanner trying to auto-deploy partially copied content. However, if you wish to change this behavior, you can go to the <code><nowiki>JBOSS_HOME/standalone/configuration/standalone.xml</nowiki></code> file, look for the '''deployment-scanner'' tag and change the deployment options as you like:

<source lang="xml">
<deployment-scanner scan-interval="5000" relative-to="jboss.server.base.dir" path="deployments"
auto-deploy-zipped="true" auto-deploy-exploded="false"/>
</source>

By default, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>
Please note that the HTTP <code>8080</code> 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.

If you want to use international files names with CKFinder please see [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Configuration/URI_Encoding URI Encoding section] which explains how to set UTF-8 on JBOSS.

Go to the JBoss AS7 [https://docs.jboss.org/author/display/AS7/Getting+Started+Guide Documentation] site for more information about using this server.

=== GlassFish ===
The GlassFish server can be started from the command line. Go to the server <code>bin</code> folder and run the <code>asadmin</code> 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 <code>start-domain</code> 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: 

* <code>deploy relativePath/CKFinderJava.war</code>

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

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

By default, Glassfish has ISO parameter-encoding set, which may cause problems if your users want to use filenames with non-ISO characters. If CKFinder in your application is to be used worldwide, it is recommended to set UTF-8 for Glassfish. Please refer to the [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Configuration/URI_Encodinglink URI Encoding] section for more details.

Go to the Oracle [http://docs.oracle.com/cd/E19798-01/821-1757/index.html GlassFish 3.0] or, [http://docs.oracle.com/cd/E18930_01/html/821-2432/ GlassFish 3.1] or [https://glassfish.java.net/getstarted.html GlassFish 4.0] Server Quick Start Guide for more information about using this server.

=== Weblogic ===
The Weblogic Server (WLS) can be started from the command line. Go to the <code><nowiki>weblogic_main_folder/user_projects/domains/your_domain/bin</nowiki></code> folder and run the following script:
* Windows: <code>startWeblogic.bat</code> or <code>startWeblogicManagedServer.bat</code>
* Linux: <code>startWeblogic.sh</code> or <code>startWeblogicManagedServer.sh</code>
If Weblogic is in production mode then please remember that you need to specify the user name and password in order to run it.

As you probably know, Weblogic Server uses domains which are logically related groups of server resources. A domain can consist of an Administration Server and one or more Managed Servers, or of a single standalone server that acts as an Administration Server and runs deployed applications. In this example we are going to use a single standalone Administration Server.

After starting Weblogic, log into the Administration Console and click '''Deployments''' in the '''Domain Structure''' upper left menu. If WLS is in production mode, you need to click '''Lock&Edit''' first. In main panel click the '''Install''' button, specify the path to <code>CKFinderJava.war</code>, and click the '''Next''' button. Select the '''"Install this deployment as an application"''' option and press the '''Next''' button. In the last panel you can change the name of your deployment, the security model and the source accessibility. Once you are done, click the '''Finish''' button and CKFinderJava will be deployed. If WLS works in production mode, you will need to confirm all changes by clicking the '''Activate Changes''' button and start the application manually by selecting it and pressing the '''Start''' button.

By deafult, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:7001/CKFinderJava/</nowiki></code>

The HTTP <code>7001</code> port of the sample URL is the default Weblogic Administration Server port. If you changed this value while configuring your Weblogic domain(s), you will need to use a modified port value to run the sample application.

Go to the [http://docs.oracle.com/cd/E17904_01/index.htm Weblogic 11g] or [http://docs.oracle.com/cd/E24329_01/index.htm Weblogic 12c] Documentation site for more information about using this server.

CKFinder 2.x/Developers Guide/Java/Configuration/baseURL and baseDir

2015-01-21T09:43:09Z

J.swiderski:

CKFinder 2.x/Developers Guide/Java/System Requirements

2014-02-06T08:52:45Z

J.swiderski:

{{Ckfinder_2.x Requirements Description}}

== Server ==
Minimum CKFinder requirements for Java:
* JRE 1.5 and a Servlet 2.5/JSP 2.1 compliant server.

CKFinder 2.x/Developers Guide/Java/Installation

2013-11-22T20:47:31Z

J.swiderski:

__TOC__
{{#CUSTOMTITLE:CKFinder Installation}}
This article describes how to install CKFinder for Java.

== Installation Procedure ==
To install CKFinder, download the CKFinder for Java distribution package (a <code>.war</code> file) from the [http://ckfinder.com/download official download site]. 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 <code>_samples</code> folder of the distribution package. After the deployment open the <code>_samples/index.html</code> 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 <code>config.xml</code> file where you can customize your application. See the [[CKFinder_2.x/Developers Guide/Java/Configuration|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.
<source lang="xml">
<enabled>true</enabled>
</source>

== Deployment on a Server ==
The CKFinder Java connector supports the following servers:
* Tomcat 5.5-7,
* Jetty 7-9,
* JBoss 6-7,
* GlassFish 3.0-4.0,
* Weblogic 11g-12c.
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 <code>.war</code> file in the Tomcat <code>webapps</code> folder. Go to Tomcat <code>bin</code> folder and run the startup script file for your operating system — <code>startup.bat</code> for Windows or <code>startup.sh</code> for Linux. When you are running Tomcat as a service, restart the server.

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

Go to the [http://wiki.apache.org/tomcat/FAQ Tomcat FAQ] and [http://tomcat.apache.org/tomcat-5.5-doc/index.html Tomcat 5.5] or [http://tomcat.apache.org/tomcat-6.0-doc/index.html Tomcat 6], or [http://tomcat.apache.org/tomcat-7.0-doc/index.html Tomcat 7] documentation for more information about using this server.

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

By default Jetty unpacks war files to folders like <code><nowiki>C:\Users\admin\AppData\Local\Temp\jetty-0.0.0.0-8080-CKFinderJava.war-_CKFinderJava-any-\webapp\</nowiki></code>. Information about this folder is displayed in the output console, when the server is started. If you wish to change this folder, you can either put the unpacked <code>CKFinderJava.war</code> file in the webapps folder (Jetty will use the unpacked application folder) or go to <code><nowiki>jetty7(8)\etc\jetty-webapps.xml</nowiki></code> or <code><nowiki>jetty9\etc\jetty-deploy.xml</nowiki></code> and set the below parameter to the folder path of your choice:

<source lang="xml"><Set name="tempDir"><New class="java.io.File"><Arg>C:\tmp</Arg></New></Set></source>

Go to the [http://wiki.eclipse.org/Jetty/Starting/Installing_Jetty-7.0.x Jetty 7], [http://wiki.eclipse.org/Jetty/Starting/Quick_Start_Guide Jetty 8], or [http://www.eclipse.org/jetty/documentation/current/quick-start.html Jetty 9] Quick Start guide for more information about using this server.

=== JBoss 6===
The server can be started from the command line. Go to the JBoss <code>bin</code> folder and run the following command:
* Windows: <code>run.bat</code>
* Linux: <code> run.sh</code>

JBoss Application Server ships with five different server [http://docs.jboss.org/jbossas/docs/Installation_And_Getting_Started_Guide/5/html/The_JBoss_Server___A_Quick_Tour.html#The_JBoss_Server___A_Quick_Tour-Server_Configurations configurations]: all, default, standard, minimal and jbossweb-standalone. This is because one may want to start server with selected services only. The Above command will start the server in its '''default''' mode. However, if you want to use a different configuration, e.g. start the server with all services available, you would have to pass the <code>–c</code> parameter with an appropriate configuration. In this case use the <code>all</code> value:
* Windows: <code>run.bat -c all</code>
* Linux: <code> run.sh -c all</code>
'''NOTE:''' In this example we are going to work with a single standalone server.

After the server was started, log into administration console, 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 <code>.war</code> file, and optionally check one of the following options:

* '''Deploy Exploded''' – for most usage scenarios,
* '''Deploy Farm''' – when the server works in a cluster.
If you don't select any of the options above, JBoss will be instructed to deploy CKFinder for Java as a packed war file. The application will be deployed after you click the '''Continue''' button. 

Please bear in mind that JBoss has '''auto-deploy''' mode turned on by default so it is enough to drop the <code>CKFinderJava.war</code> file into an appropriate directory. If you started your server with standard configuration (<code>run –c standard</code>), please drop <code>CKFinderJava.war</code> to the <code><nowiki>JBOSS_HOME/server/standard/deploy</nowiki></code> folder and the server will do the rest.

By deafult, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>.
The HTTP <code>8080</code> 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 [http://www.jboss.org/jbossas/docs/6-x JBoss AS6 Documentation site] for more information about using this server.

=== JBoss 7===
The server can be started from the command line. Go to the JBoss bin folder and run the following command:
* Windows: <code>standalone.bat</code> or <code>domain.bat</code>
* Linux: <code>standalone.sh</code> or <code>domain.sh</code>

JBoss Application Server 7 can run in two modes: standalone and domain. First one allows running a single standalone Server, while the latter is used to manage multiple physical (or virtual) machines from a single control point. 
'''NOTE:''' In this example we are going to work with a standalone server.

The above two commands start servers with their default configurations. If one wishes to start the server with one of alternative configurations, one should pass the <code>--server-config</code> argument with the server configuration file to be used. The example below shows how to run the full profile configuration with high availability:
* Windows: <code>standalone.bat --server-config=standalone-ha.xml</code>
* Linux: <code>standalone.sh --server-config=standalone-ha.xml</code>
You can read more about available JBoss 7 configurations [https://docs.jboss.org/author/display/AS71/Getting+Started+Guide#GettingStartedGuide-JBossApplicationServer7Configurations here].

After the server was started, log into administration console, go to the '''Runtime''' Tab, select '''Managed Deployments''' menu, click the '''Add contents''' button and select <code>CKFinderJava.war</code> file. Once CKFinderJava.war upload is finished, press the '''Enable''' button. The Application is now ready to use.
Another way of deploying the CKFinderJava application is using JBOSS Command Line Interface (CLI):
* '''In standalone mode:''' <code>[standalone@localhost:9999 /] deploy ~/Desktop/CKFinderJava.war</code>
* '''In domain mode:''' <code>[domain@localhost:9999 /] deploy ~/Desktop/ CKFinderJava.war --all-server-groups</code>
'''NOTE:''' Either <code>--all-server-groups</code> or <code>--server-groups must be specified</code>. 

To learn more about CLI please see this [https://community.jboss.org/wiki/CommandLineInterface link].

If your Server is running in the standalone mode, then aside from using the administration console and CLI, JBOSS 7 can also work in manual and auto deployment mode (this depends on your settings). 
In the '''Auto-Deploy mode''' the scanner directly monitors the deployment content, available in <code><nowiki>JBOSS_HOME/standalone/deployments</nowiki></code> directory, automatically deploying new content and redeploying content whose timestamp has changed. It means that you can simply drop CKFinderJava.war into deployments folder and the application will be deployed. 
To undeploy CKFinderJava in auto mode simply remove war file from deploy directory. 
In the '''Manual deploy mode''' the scanner does not directly monitor the deployment content. Instead, the scanner relies on a system of marker files, which the user can add to or remove from deployment directory. These files serve as a sort of command telling the scanner to deploy, undeploy, or redeploy the content. You can learn more about marker files in the "Marker Files" section available under this [https://docs.jboss.org/author/display/AS7/Application+deploymen link].

To deploy <code>CKFinderJava.war</code> in manual mode, copy this file into the deployments directory and create the <code>CKFinderJava.war.dodeploy</code> file. CKFinder will be deployed and the <code>CKFinderJava.war.deployed</code> marker file will be created. To undeploy CKFinderJava simply remove <code>CKFinderJava.war.deployed</code> file.

Please note that by default JBOSS7 allows auto-deployment of zipped content and prevents auto-deployment of exploded content. This is because exploded content is vulnerable to the scanner trying to auto-deploy partially copied content. However, if you wish to change this behavior, you can go to the <code><nowiki>JBOSS_HOME/standalone/configuration/standalone.xml</nowiki></code> file, look for the '''deployment-scanner'' tag and change the deployment options as you like:

<source lang="xml">
<deployment-scanner scan-interval="5000" relative-to="jboss.server.base.dir" path="deployments"
auto-deploy-zipped="true" auto-deploy-exploded="false"/>
</source>

By default, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>
Please note that the HTTP <code>8080</code> 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.

If you want to use international files names with CKFinder please see [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Configuration/URI_Encoding URI Encoding section] which explains how to set UTF-8 on JBOSS.

Go to the JBoss AS7 [https://docs.jboss.org/author/display/AS7/Getting+Started+Guide Documentation] site for more information about using this server.

=== GlassFish ===
The GlassFish server can be started from the command line. Go to the server <code>bin</code> folder and run the <code>asadmin</code> 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 <code>start-domain</code> 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: 

* <code>deploy relativePath/CKFinderJava.war</code>

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

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

By default, Glassfish has ISO parameter-encoding set, which may cause problems if your users want to use filenames with non-ISO characters. If CKFinder in your application is to be used worldwide, it is recommended to set UTF-8 for Glassfish. Please refer to the [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Configuration/URI_Encodinglink URI Encoding] section for more details.

Go to the Oracle [http://docs.oracle.com/cd/E19798-01/821-1757/index.html GlassFish 3.0] or, [http://docs.oracle.com/cd/E18930_01/html/821-2432/ GlassFish 3.1] or [https://glassfish.java.net/getstarted.html GlassFish 4.0] Server Quick Start Guide for more information about using this server.

=== Weblogic ===
The Weblogic Server (WLS) can be started from the command line. Go to the <code><nowiki>weblogic_main_folder/user_projects/domains/your_domain/bin</nowiki></code> folder and run the following script:
* Windows: <code>startWeblogic.bat</code> or <code>startWeblogicManagedServer.bat</code>
* Linux: <code>startWeblogic.sh</code> or <code>startWeblogicManagedServer.sh</code>
If Weblogic is in production mode then please remember that you need to specify the user name and password in order to run it.

As you probably know, Weblogic Server uses domains which are logically related groups of server resources. A domain can consist of an Administration Server and one or more Managed Servers, or of a single standalone server that acts as an Administration Server and runs deployed applications. In this example we are going to use a single standalone Administration Server.

After starting Weblogic, log into the Administration Console and click '''Deployments''' in the '''Domain Structure''' upper left menu. If WLS is in production mode, you need to click '''Lock&Edit''' first. In main panel click the '''Install''' button, specify the path to <code>CKFinderJava.war</code>, and click the '''Next''' button. Select the '''"Install this deployment as an application"''' option and press the '''Next''' button. In the last panel you can change the name of your deployment, the security model and the source accessibility. Once you are done, click the '''Finish''' button and CKFinderJava will be deployed. If WLS works in production mode, you will need to confirm all changes by clicking the '''Activate Changes''' button and start the application manually by selecting it and pressing the '''Start''' button.

By deafult, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:7001/CKFinderJava/</nowiki></code>

The HTTP <code>7001</code> port of the sample URL is the default Weblogic Administration Server port. If you changed this value while configuring your Weblogic domain(s), you will need to use a modified port value to run the sample application.

Go to the [http://docs.oracle.com/cd/E17904_01/index.htm Weblogic 11g] or [http://docs.oracle.com/cd/E24329_01/index.htm Weblogic 12c] Documentation site for more information about using this server.

CKFinder 2.x/Developers Guide/Java/Configuration/URI Encoding

2013-11-22T20:45:51Z

J.swiderski:

By default some servers use the ISO-8859-1 encoding for request parameters and request body. What is more, changing the encoding for request body on such servers has no influence on the encoding of the request parameters. This may cause problems if you want to use international file names with '''CKFinder which expects request body and parameters to be encoded in UTF-8'''. To overcome this issue you can either set UTF-8 URI encoding on the server or if you do not have enough privileges to do that, you can adjust CKFinder to use same URI encoding as your server. 
You will find more detailed instructions below.

===JBOSS 6===
JBOSS 6 is one of the servers that use ISO-8859-1 for parameter encoding. In order to change this value to UTF-8 you have to modify the <code>server.xml</code> file for the configuration you use. 
As you probably know, JBOSS 6 comes with five different server configurations. To simplify the example let us assume that configuration '''<code>"all"</code>''' is used and you want to set UTF-8 only for that particular configuration. To achieve that you have to edit the <code><nowiki>JBOSS_HOME/server/all/deploy/jbossweb.sar/server.xml</nowiki></code> file and add the <code>URIEncoding="UTF-8"</code> attribute in the <code>Connector</code> element.

<source lang="xml">
<Connector URIEncoding="UTF-8" protocol="HTTP/1.1" port="${jboss.web.http.port}"
address="${jboss.bind.address}" redirectPort="${jboss.web.https.port}" />
</source>

===JBOSS 7===
By default this server uses ISO-8859-1 for parameter encoding. To change this to UTF-8, you have to modify the configuration file appropriate for the mode and configuration used. 
As you probably know, JBOSS 7 can run in two modes ("domain" and "standalone") and can use various configurations.
To simplify the example let us assume that the server uses the standalone mode and default configuration. In order to set UTF-8 for URI encoding you have to edit the <code><nowiki>JBOSS_HOME/standalone/configuration/standalone.xml</nowiki></code> file and add a system property named <code>org.apache.catalina.connector.URI_ENCODING</code>,(with value set to UTF-8) to the <code>system-properties</code> element. 
Below is the code that needs to be added to the configuration file you use:

<source lang="xml">
<system-properties>
<property name="org.apache.catalina.connector.URI_ENCODING" value="UTF-8"/>
</system-properties>
</source>

===GlassFish 3.0===
According to Glassfish 3.0 [http://docs.oracle.com/cd/E19798-01/821-1752/beafu/index.html documentation] default parameter encoding for requests is ISO-8859-1. To change this encoding to UTF-8 you have to use the sun-web.xml [http://docs.oracle.com/cd/E19798-01/821-1750/beaql/index.html file] with xml <code>parameter-encoding</code> element. This file has to be placed in the <code>WEB-INF</code> folder of your web application. 
CKFinder sample web application comes with such a file. If you are using Glassfish 3.0, want to use UTF-8, and to integrate CKFinder in to your application then apart from files mentioned in the [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Integration Integration] section, copy <code>sun-web.xml</code> as well. 
Below is the code for the <code>sun-web.xml</code> file:

<source lang="xml">
<!DOCTYPE sun-web-app PUBLIC "-//Sun Microsystems, Inc.//DTD GlassFish Application Server 3.0 Servlet 3.0//EN"
"http://www.sun.com/software/appserver/dtds/sun-web-app_3_0-0.dtd">
<sun-web-app>
<parameter-encoding default-charset="UTF-8" />
</sun-web-app>
</source>

===GlassFish 3.1+===
By default this [http://docs.oracle.com/cd/E18930_01/html/821-2418/beaft.html#beafu server] uses ISO-8859-1 for parameter encoding. In order to change this to UTF-8, you have to use the <code>glassfish-web.xml</code> [http://docs.oracle.com/cd/E18930_01/html/821-2417/beaql.html#scrolltoc file] with xml <code>parameter-encoding</code> element. This file has to be placed in the <code>WEB-INF</code> folder of the web application. 
CKFinder sample web application comes with such a file. If you are using Glassfish 3.1 or 4.0, want to use UTF-8, and to integrate CKFinder in to your application then apart from files mentioned in the [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Integration Integration] section, copy <code>glassfish-web.xml</code> as well. 
Below is the code for the <code>glassfish-web.xml</code> file:
<source lang="xml">
<!DOCTYPE glassfish-web-app PUBLIC "-//GlassFish.org//DTD GlassFish Application Server 3.1 Servlet 3.0//EN"
"http://glassfish.org/dtds/glassfish-web-app_3_0-1.dtd">
<glassfish-web-app>
<parameter-encoding default-charset="UTF-8" />
</glassfish-web-app>
</source>

===Tomcat===
According to [http://wiki.apache.org/tomcat/FAQ/CharacterEncoding Tomcat FAQ], for handling HTTP requests by default Tomcat uses the ISO-8859-1 encoding.

Starting with version 5 for all <code>GET</code> requests, when the encoding type used is different from the default one, the query parameters are not encoded in the same way as the request body. To be more specific, if you want to use the encoding other than the default ISO-8859-1 (like UTF-8, for example), the <code>HttpServletRequest.setCharacterEncoding("UTF-8")</code> method will only be applied to the request body, and not the URI.

In order to encode the query parameters just like the requests, you should use the <code>URIEncoding="UTF-8"</code> attribute in the <code>Connector</code> element of the <code>Server.xml</code> file:
<source lang="xml">
<Connector port="8080" protocol="HTTP/1.1" connectionTimeout="20000" redirectPort="8443" URIEncoding="UTF-8" />
</source>

===Weblogic===
This server follows J2EE specification when it comes to encoding. This means that if no encoding is specified then default ISO-8859-1 is set for everything (Servlets, JSP, Tag Files) except for XML format files. 
Weblogic documentation provides a couple of ways for setting the encoding you want (UTF-8 in this case). There are server typical methods as well as general Servlet API methods. It seems the best way to set encoding in the WLS server is using [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html#setCharacterEncoding%28java.lang.String%29 setCharacterEncoding("UTF-8");] for requests and [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html#setCharacterEncoding%28java.lang.String%29 setCharacterEncoding("UTF-8");] or [http://docs.oracle.com/javaee/7/api/javax/servlet/ServletResponse.html#setContentType%28java.lang.String%29 setContentType("UTF-8");] for responses.

Please see this [http://otndnld.oracle.co.jp/document/products/wls/docs103/en/relnotes_ja.htmlotndnld.oracle.co.jp/document/products/wls/docs92/en/relnotes_ja.html link] (Web Components section) for more details on setting appropriate encoding on the server-side.

===Jetty===
All supported Jetty versions (7,8 and 9) use UTF-8 by default. Jetty [http://wiki.eclipse.org/Jetty/Howto/International_Characters#Characters_included_in_HTTP_requests documentation] states if no overriding character encoding is set on a request, Jetty uses UTF-8 encoding.

===Alternative Solution (CKFinder Adjustment)===
'''By default, CKFinder uses the UTF-8 encoding, so you should stick to the guidelines presented above in order to make it work properly.'''

If you cannot or do not want to set this parameter in the server configuration file, CKFinder will try to address this problem for you. This is why the <code>uriEncoding</code> configuration element was created in the <code>config.xml<code> file. This parameter accepts the encoding of your query parameters. 
For example, for Tomcat, JBoss, Glassfish, and Weblogic with their default configuration set (which is ISO-8859-1) you should set uriEncoding to ISO-8859-1 and CKFinder will convert the query parameters for you.

<source lang="xml">
<uriEncoding>ISO-8859-1</uriEncoding>
</source>

CKFinder 2.x/Developers Guide/Java/Installation

2013-11-22T19:59:51Z

J.swiderski:

__TOC__
{{#CUSTOMTITLE:CKFinder Installation}}
This article describes how to install CKFinder for Java.

== Installation Procedure ==
To install CKFinder, download the CKFinder for Java distribution package (a <code>.war</code> file) from the [http://ckfinder.com/download official download site]. 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 <code>_samples</code> folder of the distribution package. After the deployment open the <code>_samples/index.html</code> 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 <code>config.xml</code> file where you can customize your application. See the [[CKFinder_2.x/Developers Guide/Java/Configuration|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.
<source lang="xml">
<enabled>true</enabled>
</source>

== Deployment on a Server ==
The CKFinder Java connector supports the following servers:
* Tomcat 5.5-7,
* Jetty 7-9,
* JBoss 6-7,
* GlassFish 3.0-4.0,
* Weblogic 11g-12c.
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 <code>.war</code> file in the Tomcat <code>webapps</code> folder. Go to Tomcat <code>bin</code> folder and run the startup script file for your operating system — <code>startup.bat</code> for Windows or <code>startup.sh</code> for Linux. When you are running Tomcat as a service, restart the server.

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

Go to the [http://wiki.apache.org/tomcat/FAQ Tomcat FAQ] and [http://tomcat.apache.org/tomcat-5.5-doc/index.html Tomcat 5.5] or [http://tomcat.apache.org/tomcat-6.0-doc/index.html Tomcat 6], or [http://tomcat.apache.org/tomcat-7.0-doc/index.html Tomcat 7] documentation for more information about using this server.

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

By default Jetty unpacks war files to folders like <code><nowiki>C:\Users\admin\AppData\Local\Temp\jetty-0.0.0.0-8080-CKFinderJava.war-_CKFinderJava-any-\webapp\</nowiki></code>. Information about this folder is displayed in the output console, when the server is started. If you wish to change this folder, you can either put the unpacked <code>CKFinderJava.war</code> file in the webapps folder (Jetty will use the unpacked application folder) or go to <code><nowiki>jetty7(8)\etc\jetty-webapps.xml</nowiki></code> or <code><nowiki>jetty9\etc\jetty-deploy.xml</nowiki></code> and set the below parameter to the folder path of your choice:

<source><Set name="tempDir"><New class="java.io.File"><Arg>C:\tmp</Arg></New></Set></source>

Go to the [http://wiki.eclipse.org/Jetty/Starting/Installing_Jetty-7.0.x Jetty 7], [http://wiki.eclipse.org/Jetty/Starting/Quick_Start_Guide Jetty 8], or [http://www.eclipse.org/jetty/documentation/current/quick-start.html Jetty 9] Quick Start guide for more information about using this server.

=== JBoss 6===
The server can be started from the command line. Go to the JBoss <code>bin</code> folder and run the following command:
* Windows: <code>run.bat</code>
* Linux: <code> run.sh</code>

JBoss Application Server ships with five different server [http://docs.jboss.org/jbossas/docs/Installation_And_Getting_Started_Guide/5/html/The_JBoss_Server___A_Quick_Tour.html#The_JBoss_Server___A_Quick_Tour-Server_Configurations configurations]: all, default, standard, minimal and jbossweb-standalone. This is because one may want to start server with selected services only. The Above command will start the server in its '''default''' mode. However, if you want to use a different configuration, e.g. start the server with all services available, you would have to pass the <code>–c</code> parameter with an appropriate configuration. In this case use the <code>all</code> value:
* Windows: <code>run.bat -c all</code>
* Linux: <code> run.sh -c all</code>
'''NOTE:''' In this example we are going to work with a single standalone server.

After the server was started, log into administration console, 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 <code>.war</code> file, and optionally check one of the following options:

* '''Deploy Exploded''' – for most usage scenarios,
* '''Deploy Farm''' – when the server works in a cluster.
If you don't select any of the options above, JBoss will be instructed to deploy CKFinder for Java as a packed war file. The application will be deployed after you click the '''Continue''' button. 

Please bear in mind that JBoss has '''auto-deploy''' mode turned on by default so it is enough to drop the <code>CKFinderJava.war</code> file into an appropriate directory. If you started your server with standard configuration (<code>run –c standard</code>), please drop <code>CKFinderJava.war</code> to the <code><nowiki>JBOSS_HOME/server/standard/deploy</nowiki></code> folder and the server will do the rest.

By deafult, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>.
The HTTP <code>8080</code> 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 [http://www.jboss.org/jbossas/docs/6-x JBoss AS6 Documentation site] for more information about using this server.

=== JBoss 7===
The server can be started from the command line. Go to the JBoss bin folder and run the following command:
* Windows: <code>standalone.bat</code> or <code>domain.bat</code>
* Linux: <code>standalone.sh</code> or <code>domain.sh</code>

JBoss Application Server 7 can run in two modes: standalone and domain. First one allows running a single standalone Server, while the latter is used to manage multiple physical (or virtual) machines from a single control point. 
'''NOTE:''' In this example we are going to work with a standalone server.

The above two commands start servers with their default configurations. If one wishes to start the server with one of alternative configurations, one should pass the <code>--server-config</code> argument with the server configuration file to be used. The example below shows how to run the full profile configuration with high availability:
* Windows: <code>standalone.bat --server-config=standalone-ha.xml</code>
* Linux: <code>standalone.sh --server-config=standalone-ha.xml</code>
You can read more about available JBoss 7 configurations [https://docs.jboss.org/author/display/AS71/Getting+Started+Guide#GettingStartedGuide-JBossApplicationServer7Configurations here].

After the server was started, log into administration console, go to the '''Runtime''' Tab, select '''Managed Deployments''' menu, click the '''Add contents''' button and select <code>CKFinderJava.war</code> file. Once CKFinderJava.war upload is finished, press the '''Enable''' button. The Application is now ready to use.
Another way of deploying the CKFinderJava application is using JBOSS Command Line Interface (CLI):
* '''In standalone mode:''' <code>[standalone@localhost:9999 /] deploy ~/Desktop/CKFinderJava.war</code>
* '''In domain mode:''' <code>[domain@localhost:9999 /] deploy ~/Desktop/ CKFinderJava.war --all-server-groups</code>
'''NOTE:''' Either <code>--all-server-groups</code> or <code>--server-groups must be specified</code>. 

To learn more about CLI please see this [https://community.jboss.org/wiki/CommandLineInterface link].

If your Server is running in the standalone mode, then aside from using the administration console and CLI, JBOSS 7 can also work in manual and auto deployment mode (this depends on your settings). 
In the '''Auto-Deploy mode''' the scanner directly monitors the deployment content, available in <code><nowiki>JBOSS_HOME/standalone/deployments</nowiki></code> directory, automatically deploying new content and redeploying content whose timestamp has changed. It means that you can simply drop CKFinderJava.war into deployments folder and the application will be deployed. 
To undeploy CKFinderJava in auto mode simply remove war file from deploy directory. 
In the '''Manual deploy mode''' the scanner does not directly monitor the deployment content. Instead, the scanner relies on a system of marker files, which the user can add to or remove from deployment directory. These files serve as a sort of command telling the scanner to deploy, undeploy, or redeploy the content. You can learn more about marker files in the "Marker Files" section available under this [https://docs.jboss.org/author/display/AS7/Application+deploymen link].

To deploy <code>CKFinderJava.war</code> in manual mode, copy this file into the deployments directory and create the <code>CKFinderJava.war.dodeploy</code> file. CKFinder will be deployed and the <code>CKFinderJava.war.deployed</code> marker file will be created. To undeploy CKFinderJava simply remove <code>CKFinderJava.war.deployed</code> file.

Please note that by default JBOSS7 allows auto-deployment of zipped content and prevents auto-deployment of exploded content. This is because exploded content is vulnerable to the scanner trying to auto-deploy partially copied content. However, if you wish to change this behavior, you can go to the <code><nowiki>JBOSS_HOME/standalone/configuration/standalone.xml</nowiki></code> file, look for the '''deployment-scanner'' tag and change the deployment options as you like:

<source>
<deployment-scanner scan-interval="5000" relative-to="jboss.server.base.dir" path="deployments"
auto-deploy-zipped="true" auto-deploy-exploded="false"/>
</source>

By default, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>
Please note that the HTTP <code>8080</code> 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.

If you want to use international files names with CKFinder please see [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Configuration/URI_Encoding URI Encoding section] which explains how to set UTF-8 on JBOSS.

Go to the JBoss AS7 [https://docs.jboss.org/author/display/AS7/Getting+Started+Guide Documentation] site for more information about using this server.

=== GlassFish ===
The GlassFish server can be started from the command line. Go to the server <code>bin</code> folder and run the <code>asadmin</code> 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 <code>start-domain</code> 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: 

* <code>deploy relativePath/CKFinderJava.war</code>

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

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

By default, Glassfish has ISO parameter-encoding set, which may cause problems if your users want to use filenames with non-ISO characters. If CKFinder in your application is to be used worldwide, it is recommended to set UTF-8 for Glassfish. Please refer to the [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Configuration/URI_Encodinglink URI Encoding] section for more details.

Go to the Oracle [http://docs.oracle.com/cd/E19798-01/821-1757/index.html GlassFish 3.0] or, [http://docs.oracle.com/cd/E18930_01/html/821-2432/ GlassFish 3.1] or [https://glassfish.java.net/getstarted.html GlassFish 4.0] Server Quick Start Guide for more information about using this server.

=== Weblogic ===
The Weblogic Server (WLS) can be started from the command line. Go to the <code><nowiki>weblogic_main_folder/user_projects/domains/your_domain/bin</nowiki></code> folder and run the following script:
* Windows: <code>startWeblogic.bat</code> or <code>startWeblogicManagedServer.bat</code>
* Linux: <code>startWeblogic.sh</code> or <code>startWeblogicManagedServer.sh</code>
If Weblogic is in production mode then please remember that you need to specify the user name and password in order to run it.

As you probably know, Weblogic Server uses domains which are logically related groups of server resources. A domain can consist of an Administration Server and one or more Managed Servers, or of a single standalone server that acts as an Administration Server and runs deployed applications. In this example we are going to use a single standalone Administration Server.

After starting Weblogic, log into the Administration Console and click '''Deployments''' in the '''Domain Structure''' upper left menu. If WLS is in production mode, you need to click '''Lock&Edit''' first. In main panel click the '''Install''' button, specify the path to <code>CKFinderJava.war</code>, and click the '''Next''' button. Select the '''"Install this deployment as an application"''' option and press the '''Next''' button. In the last panel you can change the name of your deployment, the security model and the source accessibility. Once you are done, click the '''Finish''' button and CKFinderJava will be deployed. If WLS works in production mode, you will need to confirm all changes by clicking the '''Activate Changes''' button and start the application manually by selecting it and pressing the '''Start''' button.

By deafult, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:7001/CKFinderJava/</nowiki></code>

The HTTP <code>7001</code> port of the sample URL is the default Weblogic Administration Server port. If you changed this value while configuring your Weblogic domain(s), you will need to use a modified port value to run the sample application.

Go to the [http://docs.oracle.com/cd/E17904_01/index.htm Weblogic 11g] or [http://docs.oracle.com/cd/E24329_01/index.htm Weblogic 12c] Documentation site for more information about using this server.

CKFinder 2.x/Developers Guide/Java/Installation

2013-11-22T19:54:29Z

J.swiderski:

__TOC__
{{#CUSTOMTITLE:CKFinder Installation}}
This article describes how to install CKFinder for Java.

== Installation Procedure ==
To install CKFinder, download the CKFinder for Java distribution package (a <code>.war</code> file) from the [http://ckfinder.com/download official download site]. 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 <code>_samples</code> folder of the distribution package. After the deployment open the <code>_samples/index.html</code> 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 <code>config.xml</code> file where you can customize your application. See the [[CKFinder_2.x/Developers Guide/Java/Configuration|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.
<source lang="xml">
<enabled>true</enabled>
</source>

== Deployment on a Server ==
The CKFinder Java connector supports the following servers:
* Tomcat 5.5-7,
* Jetty 7-9,
* JBoss 6-7,
* GlassFish 3.0-4.0,
* Weblogic 11g-12c.
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 <code>.war</code> file in the Tomcat <code>webapps</code> folder. Go to Tomcat <code>bin</code> folder and run the startup script file for your operating system — <code>startup.bat</code> for Windows or <code>startup.sh</code> for Linux. When you are running Tomcat as a service, restart the server.

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

Go to the [http://wiki.apache.org/tomcat/FAQ Tomcat FAQ] and [http://tomcat.apache.org/tomcat-5.5-doc/index.html Tomcat 5.5] or [http://tomcat.apache.org/tomcat-6.0-doc/index.html Tomcat 6], or [http://tomcat.apache.org/tomcat-7.0-doc/index.html Tomcat 7] documentation for more information about using this server.

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

By default Jetty unpacks war files to folders like <code><nowiki>C:\Users\admin\AppData\Local\Temp\jetty-0.0.0.0-8080-CKFinderJava.war-_CKFinderJava-any-\webapp\</nowiki></code>. Information about this folder is displayed in the output console, when the server is started. If you wish to change this folder, you can either put the unpacked <code>CKFinderJava.war</code> file in the webapps folder (Jetty will use the unpacked application folder) or go to <code><nowiki>jetty7(8)\etc\jetty-webapps.xml</nowiki></code> or <code><nowiki>jetty9\etc\jetty-deploy.xml</nowiki></code> and set the below parameter to the folder path of your choice:

<source><Set name="tempDir"><New class="java.io.File"><Arg>C:\tmp</Arg></New></Set></source>

Go to the [http://wiki.eclipse.org/Jetty/Starting/Installing_Jetty-7.0.x Jetty 7], [http://wiki.eclipse.org/Jetty/Starting/Quick_Start_Guide Jetty 8], or [http://www.eclipse.org/jetty/documentation/current/quick-start.html Jetty 9] Quick Start guide for more information about using this server.

=== JBoss 6===
The server can be started from the command line. Go to the JBoss <code>bin</code> folder and run the following command:
* Windows: <code>run.bat</code>
* Linux: <code> run.sh</code>

JBoss Application Server ships with five different server [http://docs.jboss.org/jbossas/docs/Installation_And_Getting_Started_Guide/5/html/The_JBoss_Server___A_Quick_Tour.html#The_JBoss_Server___A_Quick_Tour-Server_Configurations configurations]: all, default, standard, minimal and jbossweb-standalone. This is because one may want to start server with selected services only. The Above command will start the server in its default mode. However, if you want to use a different configuration, e.g. start the server with all services available, you would have to pass the <code>–c</code> parameter with an appropriate configuration. In this case use the <code>all</code> value:
* Windows: <code>run.bat -c all</code>
* Linux: <code> run.sh -c all</code>
'''NOTE:''' In this example we are going to work with a single standalone server.

After the server was started, log into administration console, 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 <code>.war</code> file, and optionally check one of the following options:

* '''Deploy Exploded''' – for most usage scenarios,
* '''Deploy Farm''' – when the server works in a cluster.
If you don't select any of the options above, JBoss will be instructed to deploy CKFinder for Java as a packed war file. The application will be deployed after you click the '''Continue''' button. 

Please bear in mind that JBoss has '''auto-deploy''' mode turned on by default so it is enough to drop the <code>CKFinderJava.war</code> file into an appropriate directory. If you started your server with standard configuration (<code>run –c standard</code>), please drop <code>CKFinderJava.war</code> to the <code><nowiki>JBOSS_HOME/server/standard/deploy</nowiki></code> folder and the server will do the rest.

By deafult, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>.
The HTTP <code>8080</code> 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 [http://www.jboss.org/jbossas/docs/6-x JBoss AS6 Documentation site] for more information about using this server.

=== JBoss 7===
The server can be started from the command line. Go to the JBoss bin folder and run the following command:
* Windows: <code>standalone.bat</code> or <code>domain.bat</code>
* Linux: <code>standalone.sh</code> or <code>domain.sh</code>

JBoss Application Server 7 can run in two modes: standalone and domain. First one allows running a single standalone Server, while the latter is used to manage multiple physical (or virtual) machines from a single control point. 
'''NOTE:''' In this example we are going to work with a standalone server.

The above two commands start servers with their default configurations. If one wishes to start the server with one of alternative configurations, one should pass the <code>--server-config</code> argument with the server configuration file to be used. The example below shows how to run the full profile configuration with high availability:
* Windows: <code>standalone.bat --server-config=standalone-ha.xml</code>
* Linux: <code>standalone.sh --server-config=standalone-ha.xml</code>
You can read more about available JBoss 7 configurations [https://docs.jboss.org/author/display/AS71/Getting+Started+Guide#GettingStartedGuide-JBossApplicationServer7Configurations here].

After the server was started, log into administration console, go to the '''Runtime''' Tab, select '''Managed Deployments''' menu, click the '''Add contents''' button and select <code>CKFinderJava.war</code> file. Once CKFinderJava.war upload is finished, press the '''Enable''' button. The Application is now ready to use.
Another way of deploying the CKFinderJava application is using JBOSS Command Line Interface (CLI):
* '''In standalone mode:''' <code>[standalone@localhost:9999 /] deploy ~/Desktop/CKFinderJava.war</code>
* '''In domain mode:''' <code>[domain@localhost:9999 /] deploy ~/Desktop/ CKFinderJava.war --all-server-groups</code>
'''NOTE:''' Either <code>--all-server-groups</code> or <code>--server-groups must be specified</code>. 

To learn more about CLI please see this [https://community.jboss.org/wiki/CommandLineInterface link].

If your Server is running in the standalone mode, then aside from using the administration console and CLI, JBOSS 7 can also work in manual and auto deployment mode (this depends on your settings). 
In the '''Auto-Deploy mode''' the scanner directly monitors the deployment content, available in <code><nowiki>JBOSS_HOME/standalone/deployments</nowiki></code> directory, automatically deploying new content and redeploying content whose timestamp has changed. It means that you can simply drop CKFinderJava.war into deployments folder and the application will be deployed. 
To undeploy CKFinderJava in auto mode simply remove war file from deploy directory. 
In the '''Manual deploy mode''' the scanner does not directly monitor the deployment content. Instead, the scanner relies on a system of marker files, which the user can add to or remove from deployment directory. These files serve as a sort of command telling the scanner to deploy, undeploy, or redeploy the content. You can learn more about marker files in the "Marker Files" section available under this [https://docs.jboss.org/author/display/AS7/Application+deploymen link].

To deploy <code>CKFinderJava.war</code> in manual mode, copy this file into the deployments directory and create the <code>CKFinderJava.war.dodeploy</code> file. CKFinder will be deployed and the <code>CKFinderJava.war.deployed</code> marker file will be created. To undeploy CKFinderJava simply remove <code>CKFinderJava.war.deployed</code> file.

Please note that by default JBOSS7 allows auto-deployment of zipped content and prevents auto-deployment of exploded content. This is because exploded content is vulnerable to the scanner trying to auto-deploy partially copied content. However, if you wish to change this behavior, you can go to the <code><nowiki>JBOSS_HOME/standalone/configuration/standalone.xml</nowiki></code> file, look for the '''deployment-scanner'' tag and change the deployment options as you like:

<source>
<deployment-scanner scan-interval="5000" relative-to="jboss.server.base.dir" path="deployments"
auto-deploy-zipped="true" auto-deploy-exploded="false"/>
</source>

By default, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>
Please note that the HTTP <code>8080</code> 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.

If you want to use international files names with CKFinder please see [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Configuration/URI_Encoding URI Encoding section] which explains how to set UTF-8 on JBOSS.

Go to the JBoss AS7 [https://docs.jboss.org/author/display/AS7/Getting+Started+Guide Documentation] site for more information about using this server.

=== GlassFish ===
The GlassFish server can be started from the command line. Go to the server <code>bin</code> folder and run the <code>asadmin</code> 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 <code>start-domain</code> 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: 

* <code>deploy relativePath/CKFinderJava.war</code>

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

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

By default, Glassfish has ISO parameter-encoding set, which may cause problems if your users want to use filenames with non-ISO characters. If CKFinder in your application is to be used worldwide, it is recommended to set UTF-8 for Glassfish. Please refer to the [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Configuration/URI_Encodinglink URI Encoding] section for more details.

Go to the Oracle [http://docs.oracle.com/cd/E19798-01/821-1757/index.html GlassFish 3.0] or, [http://docs.oracle.com/cd/E18930_01/html/821-2432/ GlassFish 3.1] or [https://glassfish.java.net/getstarted.html GlassFish 4.0] Server Quick Start Guide for more information about using this server.

=== Weblogic ===
The Weblogic Server (WLS) can be started from the command line. Go to the <code><nowiki>weblogic_main_folder/user_projects/domains/your_domain/bin</nowiki></code> folder and run the following script:
* Windows: <code>startWeblogic.bat</code> or <code>startWeblogicManagedServer.bat</code>
* Linux: <code>startWeblogic.sh</code> or <code>startWeblogicManagedServer.sh</code>
If Weblogic is in production mode then please remember that you need to specify the user name and password in order to run it.

As you probably know, Weblogic Server uses domains which are logically related groups of server resources. A domain can consist of an Administration Server and one or more Managed Servers, or of a single standalone server that acts as an Administration Server and runs deployed applications. In this example we are going to use a single standalone Administration Server.

After starting Weblogic, log into the Administration Console and click '''Deployments''' in the '''Domain Structure''' upper left menu. If WLS is in production mode, you need to click '''Lock&Edit''' first. In main panel click the '''Install''' button, specify the path to <code>CKFinderJava.war</code>, and click the '''Next''' button. Select the '''"Install this deployment as an application"''' option and press the '''Next''' button. In the last panel you can change the name of your deployment, the security model and the source accessibility. Once you are done, click the '''Finish''' button and CKFinderJava will be deployed. If WLS works in production mode, you will need to confirm all changes by clicking the '''Activate Changes''' button and start the application manually by selecting it and pressing the '''Start''' button.

By deafult, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:7001/CKFinderJava/</nowiki></code>

The HTTP <code>7001</code> port of the sample URL is the default Weblogic Administration Server port. If you changed this value while configuring your Weblogic domain(s), you will need to use a modified port value to run the sample application.

Go to the [http://docs.oracle.com/cd/E17904_01/index.htm Weblogic 11g] or [http://docs.oracle.com/cd/E24329_01/index.htm Weblogic 12c] Documentation site for more information about using this server.

CKFinder 2.x/Developers Guide/Java/Installation

2013-11-22T15:56:05Z

J.swiderski:

__TOC__
{{#CUSTOMTITLE:CKFinder Installation}}
This article describes how to install CKFinder for Java.

== Installation Procedure ==
To install CKFinder, download the CKFinder for Java distribution package (a <code>.war</code> file) from the [http://ckfinder.com/download official download site]. 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 <code>_samples</code> folder of the distribution package. After the deployment open the <code>_samples/index.html</code> 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 <code>config.xml</code> file where you can customize your application. See the [[CKFinder_2.x/Developers Guide/Java/Configuration|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.
<source lang="xml">
<enabled>true</enabled>
</source>

== Deployment on a Server ==
The CKFinder Java connector supports the following servers:
* Tomcat 5.5-7,
* Jetty 7-9,
* JBoss 6-7,
* GlassFish 3.0-4.0,
* Weblogic 11g-12c.
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 <code>.war</code> file in the Tomcat <code>webapps</code> folder. Go to Tomcat <code>bin</code> folder and run the startup script file for your operating system — <code>startup.bat</code> for Windows or <code>startup.sh</code> for Linux. When you are running Tomcat as a service, restart the server.

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

Go to the [http://wiki.apache.org/tomcat/FAQ Tomcat FAQ] and [http://tomcat.apache.org/tomcat-5.5-doc/index.html Tomcat 5.5] or [http://tomcat.apache.org/tomcat-6.0-doc/index.html Tomcat 6], or [http://tomcat.apache.org/tomcat-7.0-doc/index.html Tomcat 7] documentation for more information about using this server.

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

By default Jetty unpacks war files to folders like <code><nowiki>C:\Users\admin\AppData\Local\Temp\jetty-0.0.0.0-8080-CKFinderJava.war-_CKFinderJava-any-\webapp\</nowiki></code>. Information about this folder is displayed in the output console, when the server is started. If you wish to change this folder, you can either put the unpacked <code>CKFinderJava.war</code> file in the webapps folder (Jetty will use the unpacked application folder) or go to <code><nowiki>jetty7(8)\etc\jetty-webapps.xml</nowiki></code> or <code><nowiki>jetty9\etc\jetty-deploy.xml</nowiki></code> and set the below parameter to the folder path of your choice:

<source><Set name="tempDir"><New class="java.io.File"><Arg>C:\tmp</Arg></New></Set></source>

Go to the [http://wiki.eclipse.org/Jetty/Starting/Installing_Jetty-7.0.x Jetty 7], [http://wiki.eclipse.org/Jetty/Starting/Quick_Start_Guide Jetty 8], or [http://www.eclipse.org/jetty/documentation/current/quick-start.html Jetty 9] Quick Start guide for more information about using this server.

=== JBoss 6===
The server can be started from the command line. Go to the JBoss <code>bin</code> folder and run the following command:
* Windows: <code>run.bat</code>
* Linux: <code> run.sh</code>

JBoss Application Server ships with five different server [http://docs.jboss.org/jbossas/docs/Installation_And_Getting_Started_Guide/5/html/The_JBoss_Server___A_Quick_Tour.html#The_JBoss_Server___A_Quick_Tour-Server_Configurations configurations]: all, default, standard, minimal and jbossweb-standalone. This is because one may want to start server with selected services only. The Above command will start the server in its default mode. However, if you want to use a different configuration, e.g. start the server with all services available, you would have to pass the <code>–c</code> parameter with an appropriate configuration. In this case use the <code>all</code> value:
* Windows: <code>run.bat -c all</code>
* Linux: <code> run.sh -c all</code>
'''NOTE:''' In this example we are going to work with a single standalone server.

After the server was started, log into administration console, 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 <code>.war</code> file, and optionally check one of the following options:

* '''Deploy Exploded''' – for most usage scenarios,
* '''Deploy Farm''' – when the server works in a cluster.
If you don't select any of the options above, JBoss will be instructed to deploy CKFinder for Java as a packed war file. The application will be deployed after you click the '''Continue''' button. 

Please bear in mind that JBoss has '''auto-deploy''' mode turned on by default so it is enough to drop the <code>CKFinderJava.war</code> file into an appropriate directory. If you started your server with standard configuration (<code>run –c standard</code>), please drop <code>CKFinderJava.war</code> to the <code><nowiki>JBOSS_HOME/server/standard/deploy</nowiki></code> folder and the server will do the rest.

By deafult, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>.
The HTTP <code>8080</code> 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 [http://www.jboss.org/jbossas/docs/6-x JBoss AS6 Documentation site] for more information about using this server.

=== JBoss 7===
The server can be started from the command line. Go to the JBoss bin folder and run the following command:
* Windows: <code>standalone.bat</code> or <code>domain.bat</code>
* Linux: <code>standalone.sh</code> or <code>domain.sh</code>

JBoss Application Server 7 can run in two modes: standalone and domain. First one allows running a single standalone Server, while the latter is used to manage multiple physical (or virtual) machines from a single control point. 
'''NOTE:''' In this example we are going to work with a standalone server.

The above two commands start servers with their default configurations. If one wishes to start the server with one of alternative configurations, one should pass the <code>--server-config</code> argument with the server configuration file to be used. The example below shows how to run the full profile configuration with high availability:
* Windows: <code>standalone.bat --server-config=standalone-ha.xml</code>
* Linux: <code>standalone.sh --server-config=standalone-ha.xml</code>
You can read more about available JBoss 7 configurations [https://docs.jboss.org/author/display/AS71/Getting+Started+Guide#GettingStartedGuide-JBossApplicationServer7Configurations here].

After the server was started, log into administration console, go to the '''Runtime''' Tab, select '''Managed Deployments''' menu, click the '''Add contents''' button and select <code>CKFinderJava.war</code> file. Once CKFinderJava.war upload is finished, press the '''Enable''' button. The Application is now ready to use.
Another way of deploying the CKFinderJava application is using JBOSS Command Line Interface (CLI):
* '''In standalone mode:''' <code>[standalone@localhost:9999 /] deploy ~/Desktop/CKFinderJava.war</code>
* '''In domain mode:''' <code>[domain@localhost:9999 /] deploy ~/Desktop/ CKFinderJava.war --all-server-groups</code>
'''NOTE:''' Either <code>--all-server-groups</code> or <code>--server-groups must be specified</code>. 

To learn more about CLI please see this [https://community.jboss.org/wiki/CommandLineInterface link].

If your Server is running in the standalone mode, then aside from using the administration console and CLI, JBOSS 7 can also work in manual and auto deployment mode (this depends on your settings). 
In the '''Auto-Deploy mode''' the scanner directly monitors the deployment content, available in <code><nowiki>JBOSS_HOME/standalone/deployments</nowiki></code> directory, automatically deploying new content and redeploying content whose timestamp has changed. It means that you can simply drop CKFinderJava.war into deployments folder and the application will be deployed. 
To undeploy CKFinderJava in auto mode simply remove war file from deploy directory. 
In the '''Manual deploy mode''' the scanner does not directly monitor the deployment content. Instead, the scanner relies on a system of marker files, which the user can add to or remove from deployment directory. These files serve as a sort of command telling the scanner to deploy, undeploy, or redeploy the content. You can learn more about marker files in the "Marker Files" section available under this [https://docs.jboss.org/author/display/AS7/Application+deploymen link].

To deploy <code>CKFinderJava.war</code> in manual mode, copy this file into the deployments directory and create the <code>CKFinderJava.war.dodeploy</code> file. CKFinder will be deployed and the <code>CKFinderJava.war.deployed</code> marker file will be created. To undeploy CKFinderJava simply remove <code>CKFinderJava.war.deployed</code> file.

Please note that by default JBOSS7 allows auto-deployment of zipped content and prevents auto-deployment of exploded content. This is because exploded content is vulnerable to the scanner trying to auto-deploy partially copied content. However, if you wish to change this behavior, you can go to the <code><nowiki>JBOSS_HOME/standalone/configuration/standalone.xml</nowiki></code> file, look for the '''deployment-scanner'' tag and change the deployment options as you like:

<source>
<deployment-scanner scan-interval="5000" relative-to="jboss.server.base.dir" path="deployments"
auto-deploy-zipped="true" auto-deploy-exploded="false"/>
</source>

By default, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>
Please note that the HTTP <code>8080</code> 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.

If you want to use international files names with CKFinder please see [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Configuration/URI_Encoding URI Encoding section] which explains how to set UTF-8 on JBOSS.

=== GlassFish ===
The GlassFish server can be started from the command line. Go to the server <code>bin</code> folder and run the <code>asadmin</code> 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 <code>start-domain</code> 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: 

* <code>deploy relativePath/CKFinderJava.war</code>

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

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

By default, Glassfish has ISO parameter-encoding set, which may cause problems if your users want to use filenames with non-ISO characters. If CKFinder in your application is to be used worldwide, it is recommended to set UTF-8 for Glassfish. Please refer to the [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Configuration/URI_Encodinglink URI Encoding] section for more details.

Go to the Oracle [http://docs.oracle.com/cd/E19798-01/821-1757/index.html GlassFish 3.0] or, [http://docs.oracle.com/cd/E18930_01/html/821-2432/ GlassFish 3.1] or [https://glassfish.java.net/getstarted.html GlassFish 4.0] Server Quick Start Guide for more information about using this server.

=== Weblogic ===
The Weblogic Server (WLS) can be started from the command line. Go to the <code><nowiki>weblogic_main_folder/user_projects/domains/your_domain/bin</nowiki></code> folder and run the following script:
* Windows: <code>startWeblogic.bat</code> or <code>startWeblogicManagedServer.bat</code>
* Linux: <code>startWeblogic.sh</code> or <code>startWeblogicManagedServer.sh</code>
If Weblogic is in production mode then please remember that you need to specify the user name and password in order to run it.

As you probably know, Weblogic Server uses domains which are logically related groups of server resources. A domain can consist of an Administration Server and one or more Managed Servers, or of a single standalone server that acts as an Administration Server and runs deployed applications. In this example we are going to use a single standalone Administration Server.

After starting Weblogic, log into the Administration Console and click '''Deployments''' in the '''Domain Structure''' upper left menu. If WLS is in production mode, you need to click '''Lock&Edit''' first. In main panel click the '''Install''' button, specify the path to <code>CKFinderJava.war</code>, and click the '''Next''' button. Select the '''"Install this deployment as an application"''' option and press the '''Next''' button. In the last panel you can change the name of your deployment, the security model and the source accessibility. Once you are done, click the '''Finish''' button and CKFinderJava will be deployed. If WLS works in production mode, you will need to confirm all changes by clicking the '''Activate Changes''' button and start the application manually by selecting it and pressing the '''Start''' button.

By deafult, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:7001/CKFinderJava/</nowiki></code>

The HTTP <code>7001</code> port of the sample URL is the default Weblogic Administration Server port. If you changed this value while configuring your Weblogic domain(s), you will need to use a modified port value to run the sample application.

Go to the [http://docs.oracle.com/cd/E17904_01/index.htm Weblogic 11g] or [http://docs.oracle.com/cd/E24329_01/index.htm Weblogic 12c] Documentation site for more information about using this server.

CKFinder 2.x/Developers Guide/Java/Installation

2013-11-22T15:53:25Z

J.swiderski:

__TOC__
{{#CUSTOMTITLE:CKFinder Installation}}
This article describes how to install CKFinder for Java.

== Installation Procedure ==
To install CKFinder, download the CKFinder for Java distribution package (a <code>.war</code> file) from the [http://ckfinder.com/download official download site]. 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 <code>_samples</code> folder of the distribution package. After the deployment open the <code>_samples/index.html</code> 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 <code>config.xml</code> file where you can customize your application. See the [[CKFinder_2.x/Developers Guide/Java/Configuration|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.
<source lang="xml">
<enabled>true</enabled>
</source>

== Deployment on a Server ==
The CKFinder Java connector supports the following servers:
* Tomcat 5.5-7,
* Jetty 7-9,
* JBoss 6-7,
* GlassFish 3.0-4.0,
* Weblogic 11g-12c.
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 <code>.war</code> file in the Tomcat <code>webapps</code> folder. Go to Tomcat <code>bin</code> folder and run the startup script file for your operating system — <code>startup.bat</code> for Windows or <code>startup.sh</code> for Linux. When you are running Tomcat as a service, restart the server.

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

Go to the [http://wiki.apache.org/tomcat/FAQ Tomcat FAQ] and [http://tomcat.apache.org/tomcat-5.5-doc/index.html Tomcat 5.5] or [http://tomcat.apache.org/tomcat-6.0-doc/index.html Tomcat 6], or [http://tomcat.apache.org/tomcat-7.0-doc/index.html Tomcat 7] documentation for more information about using this server.

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

By default Jetty unpacks war files to folders like <code><nowiki>C:\Users\admin\AppData\Local\Temp\jetty-0.0.0.0-8080-CKFinderJava.war-_CKFinderJava-any-\webapp\</nowiki></code>. Information about this folder is displayed in the output console, when the server is started. If you wish to change this folder, you can either put the unpacked <code>CKFinderJava.war</code> file in the webapps folder (Jetty will use the unpacked application folder) or go to <code><nowiki>jetty7(8)\etc\jetty-webapps.xml</nowiki></code> or <code><nowiki>jetty9\etc\jetty-deploy.xml</nowiki></code> and set the below parameter to the folder path of your choice:

<source><Set name="tempDir"><New class="java.io.File"><Arg>C:\tmp</Arg></New></Set></source>

Go to the [http://wiki.eclipse.org/Jetty/Starting/Installing_Jetty-7.0.x Jetty 7], [http://wiki.eclipse.org/Jetty/Starting/Quick_Start_Guide Jetty 8], or [http://www.eclipse.org/jetty/documentation/current/quick-start.html Jetty 9] Quick Start guide for more information about using this server.

=== JBoss 6===
The server can be started from the command line. Go to the JBoss <code>bin</code> folder and run the following command:
* Windows: <code>run.bat</code>
* Linux: <code> run.sh</code>

JBoss Application Server ships with five different server [http://docs.jboss.org/jbossas/docs/Installation_And_Getting_Started_Guide/5/html/The_JBoss_Server___A_Quick_Tour.html#The_JBoss_Server___A_Quick_Tour-Server_Configurations configurations]: all, default, standard, minimal and jbossweb-standalone. This is because one may want to start server with selected services only. The Above command will start the server in its default mode. However, if you want to use a different configuration, e.g. start the server with all services available, you would have to pass the <code>–c</code> parameter with an appropriate configuration. In this case use the <code>all</code> value:
* Windows: <code>run.bat -c all</code>
* Linux: <code> run.sh -c all</code>
'''NOTE:''' In this example we are going to work with a single standalone server.

After the server was started, log into administration console, 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 <code>.war</code> file, and optionally check one of the following options:

* '''Deploy Exploded''' – for most usage scenarios,
* '''Deploy Farm''' – when the server works in a cluster.
If you don't select any of the options above, JBoss will be instructed to deploy CKFinder for Java as a packed war file. The application will be deployed after you click the '''Continue''' button. 

Please bear in mind that JBoss has '''auto-deploy''' mode turned on by default so it is enough to drop the <code>CKFinderJava.war</code> file into an appropriate directory. If you started your server with standard configuration (<code>run –c standard</code>), please drop <code>CKFinderJava.war</code> to the <code><nowiki>JBOSS_HOME/server/standard/deploy</nowiki></code> folder and the server will do the rest.

By deafult, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>.
The HTTP <code>8080</code> 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 [http://www.jboss.org/jbossas/docs/6-x JBoss AS6 Documentation site] for more information about using this server.

=== JBoss 7===
The server can be started from the command line. Go to the JBoss bin folder and run the following command:
* Windows: <code>standalone.bat</code> or <code>domain.bat</code>
* Linux: <code>standalone.sh</code> or <code>domain.sh</code>

JBoss Application Server 7 can run in two modes: standalone and domain. First one allows running a single standalone Server, while the latter is used to manage multiple physical (or virtual) machines from a single control point. 
'''NOTE:''' In this example we are going to work with a standalone server.

The above two commands start servers with their default configurations. If one wishes to start the server with one of alternative configurations, one should pass the <code>--server-config</code> argument with the server configuration file to be used. The example below shows how to run the full profile configuration with high availability:
* Windows: <code>standalone.bat --server-config=standalone-ha.xml</code>
* Linux: <code>standalone.sh --server-config=standalone-ha.xml</code>
You can read more about available JBoss 7 configurations [https://docs.jboss.org/author/display/AS71/Getting+Started+Guide#GettingStartedGuide-JBossApplicationServer7Configurations here].

After the server was started, log into administration console, go to the '''Runtime''' Tab, select '''Managed Deployments''' menu, click the '''Add contents''' button and select <code>CKFinderJava.war</code> file. Once CKFinderJava.war upload is finished, press the '''Enable''' button. The Application is now ready to use.
Another way of deploying the CKFinderJava application is using JBOSS Command Line Interface (CLI):
* '''In standalone mode:''' <code>[standalone@localhost:9999 /] deploy ~/Desktop/CKFinderJava.war</code>
* '''In domain mode:''' <code>[domain@localhost:9999 /] deploy ~/Desktop/ CKFinderJava.war --all-server-groups</code>
'''NOTE:''' Either <code>--all-server-groups</code> or <code>--server-groups must be specified</code>. 

To learn more about CLI please see this [https://community.jboss.org/wiki/CommandLineInterface link].

If your Server is running in the standalone mode, then aside from using the administration console and CLI, JBOSS 7 can also work in manual and auto deployment mode (this depends on your settings). 
In the '''Auto-Deploy mode''' the scanner directly monitors the deployment content, available in <code><nowiki>JBOSS_HOME/standalone/deployments</nowiki></code> directory, automatically deploying new content and redeploying content whose timestamp has changed. It means that you can simply drop CKFinderJava.war into deployments folder and the application will be deployed. 
To undeploy CKFinderJava in auto mode simply remove war file from deploy directory. 
In the '''Manual deploy mode''' the scanner does not directly monitor the deployment content. Instead, the scanner relies on a system of marker files, which the user can add to or remove from deployment directory. These files serve as a sort of command telling the scanner to deploy, undeploy, or redeploy the content. You can learn more about marker files in the “Marker Files” section available under this [https://docs.jboss.org/author/display/AS7/Application+deploymen link].

To deploy <code>CKFinderJava.war</code> in manual mode, copy this file into the deployments directory and create the <code>CKFinderJava.war.dodeploy</code> file. CKFinder will be deployed and the <code>CKFinderJava.war.deployed</code> marker file will be created. To undeploy CKFinderJava simply remove <code>CKFinderJava.war.deployed</code> file.

Please note that by default JBOSS7 allows auto-deployment of zipped content and prevents auto-deployment of exploded content. This is because exploded content is vulnerable to the scanner trying to auto-deploy partially copied content. However, if you wish to change this behavior, you can go to the <code><nowiki>JBOSS_HOME/standalone/configuration/standalone.xml</nowiki></code> file, look for the '''deployment-scanner'' tag and change the deployment options as you like:

<source>
<deployment-scanner scan-interval="5000" relative-to="jboss.server.base.dir" path="deployments"
auto-deploy-zipped="true" auto-deploy-exploded="false"/>
</source>

By default, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>
Please note that the HTTP <code>8080</code> 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.

If you want to use international files names with CKFinder please see [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Configuration/URI_Encoding URI Encoding section] which explains how to set UTF-8 on JBOSS.

=== GlassFish ===
The GlassFish server can be started from the command line. Go to the server <code>bin</code> folder and run the <code>asadmin</code> 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 <code>start-domain</code> 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: 

<source>deploy relativePath/CKFinderJava.war</source>

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

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

By default, Glassfish has ISO parameter-encoding set, which may cause problems if your users want to use filenames with non-ISO characters. If CKFinder in your application is to be used worldwide, it is recommended to set UTF-8 for Glassfish. Please refer to the [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Configuration/URI_Encodinglink URI Encoding] section for more details.

Go to the Oracle [http://docs.oracle.com/cd/E19798-01/821-1757/index.html GlassFish 3.0] or, [http://docs.oracle.com/cd/E18930_01/html/821-2432/ GlassFish 3.1] or [https://glassfish.java.net/getstarted.html GlassFish 4.0] Server Quick Start Guide for more information about using this server.

=== Weblogic ===
The Weblogic Server (WLS) can be started from the command line. Go to the <code><nowiki>weblogic_main_folder/user_projects/domains/your_domain/bin</nowiki></code> folder and run the following script:
* Windows: <code>startWeblogic.bat</code> or <code>startWeblogicManagedServer.bat</code>
* Linux: <code>startWeblogic.sh</code> or <code>startWeblogicManagedServer.sh</code>
If Weblogic is in production mode then please remember that you need to specify the user name and password in order to run it.

As you probably know, Weblogic Server uses domains which are logically related groups of server resources. A domain can consist of an Administration Server and one or more Managed Servers, or of a single standalone server that acts as an Administration Server and runs deployed applications. In this example we are going to use a single standalone Administration Server.

After starting Weblogic, log into the Administration Console and click '''Deployments''' in the '''Domain Structure''' upper left menu. If WLS is in production mode, you need to click '''Lock&Edit''' first. In main panel click the '''Install''' button, specify the path to <code>CKFinderJava.war</code>, and click the '''Next''' button. Select the '''"Install this deployment as an application"''' option and press the '''Next''' button. In the last panel you can change the name of your deployment, the security model and the source accessibility. Once you are done, click the '''Finish''' button and CKFinderJava will be deployed. If WLS works in production mode, you will need to confirm all changes by clicking the '''Activate Changes''' button and start the application manually by selecting it and pressing the '''Start''' button.

By deafult, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:7001/CKFinderJava/</nowiki></code>

The HTTP <code>7001</code> port of the sample URL is the default Weblogic Administration Server port. If you changed this value while configuring your Weblogic domain(s), you will need to use a modified port value to run the sample application.

Go to the [http://docs.oracle.com/cd/E17904_01/index.htm Weblogic 11g] or [http://docs.oracle.com/cd/E24329_01/index.htm Weblogic 12c] Documentation site for more information about using this server.

CKFinder 2.x/Developers Guide/Java/Installation

2013-11-22T15:36:24Z

J.swiderski:

__TOC__
{{#CUSTOMTITLE:CKFinder Installation}}
This article describes how to install CKFinder for Java.

== Installation Procedure ==
To install CKFinder, download the CKFinder for Java distribution package (a <code>.war</code> file) from the [http://ckfinder.com/download official download site]. 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 <code>_samples</code> folder of the distribution package. After the deployment open the <code>_samples/index.html</code> 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 <code>config.xml</code> file where you can customize your application. See the [[CKFinder_2.x/Developers Guide/Java/Configuration|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.
<source lang="xml">
<enabled>true</enabled>
</source>

== Deployment on a Server ==
The CKFinder Java connector supports the following servers:
* Tomcat 5.5-7,
* Jetty 7-9,
* JBoss 6-7,
* GlassFish 3.0-4.0,
* Weblogic 11g-12c.
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 <code>.war</code> file in the Tomcat <code>webapps</code> folder. Go to Tomcat <code>bin</code> folder and run the startup script file for your operating system — <code>startup.bat</code> for Windows or <code>startup.sh</code> for Linux. When you are running Tomcat as a service, restart the server.

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

Go to the [http://wiki.apache.org/tomcat/FAQ Tomcat FAQ] and [http://tomcat.apache.org/tomcat-5.5-doc/index.html Tomcat 5.5] or [http://tomcat.apache.org/tomcat-6.0-doc/index.html Tomcat 6], or [http://tomcat.apache.org/tomcat-7.0-doc/index.html Tomcat 7] documentation for more information about using this server.

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

By default Jetty unpacks war files to folders like <code><nowiki>C:\Users\admin\AppData\Local\Temp\jetty-0.0.0.0-8080-CKFinderJava.war-_CKFinderJava-any-\webapp\</nowiki></code>. Information about this folder is displayed in the output console, when the server is started. If you wish to change this folder, you can either put the unpacked CKFinderJava war file in the webapps folder (Jetty will use the unpacked application folder) or go to <code><nowiki>jetty7(8)\etc\jetty-webapps.xml</nowiki></code> or <code><nowiki>jetty9\etc\jetty-deploy.xml</nowiki></code> and set the below parameter to the folder path of your choice:

<source><Set name="tempDir"><New class="java.io.File"><Arg>C:\tmp</Arg></New></Set></source>

Go to the [http://wiki.eclipse.org/Jetty/Starting/Installing_Jetty-7.0.x Jetty 7], [http://wiki.eclipse.org/Jetty/Starting/Quick_Start_Guide Jetty 8], or [http://www.eclipse.org/jetty/documentation/current/quick-start.html Jetty 9] Quick Start guide for more information about using this server.

=== JBoss 6===
The server can be started from the command line. Go to the JBoss <code>bin</code> folder and run the following command:
* Windows: <code>run.bat</code>
* Linux: <code> run.sh</code>

JBoss Application Server ships with five different server [http://docs.jboss.org/jbossas/docs/Installation_And_Getting_Started_Guide/5/html/The_JBoss_Server___A_Quick_Tour.html#The_JBoss_Server___A_Quick_Tour-Server_Configurations configurations]: all, default, standard, minimal and jbossweb-standalone. This is because one may want to start server with selected services only. The Above command will start the server in its default mode. However, if you want to use a different configuration, e.g. start the server with all services available, you would have to pass the <code>–c</code> parameter with an appropriate configuration. In this case use the <code>all</code> value:
* Windows: <code>run.bat -c all</code>
* Linux: <code> run.sh -c all</code>

After the server was started, log into administration console, 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 <code>.war</code> file, and optionally check one of the following options:

* '''Deploy Exploded''' – for most usage scenarios,
* '''Deploy Farm''' – when the server works in a cluster.
If you don't select any of the options above, JBoss will be instructed to deploy CKFinder for Java as a packed war file. The application will be deployed after you click the '''Continue''' button. 
'''NOTE:''' In this example we are going to work with a single standalone server.

Please bear in mind that JBoss has '''auto-deploy''' mode turned on by default so it is enough to drop the <code>CKFinderJava.war</code> file into an appropriate directory. If you started your server with standard configuration (<code>run –c standard</code>), please drop <code>CKFinderJava.war</code> to the <code><nowiki>JBOSS_HOME/server/standard/deploy</nowiki></code> folder and the server will do the rest.

By deafult, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>.
The HTTP <code>8080</code> 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 [http://www.jboss.org/jbossas/docs/6-x JBoss AS6 Documentation site] for more information about using this server.

=== JBoss 7===
The server can be started from the command line. Go to the JBoss bin folder and run the following command:
* Windows: <code>standalone.bat</code> or <code>domain.bat</code>
* Linux: <code>standalone.sh</code> or <code>domain.sh</code>

JBoss Application Server 7 can run in two modes: standalone and domain. First one allows running a single standalone Server, while the latter is used to manage multiple physical (or virtual) machines from a single control point. 
'''NOTE:''' In this example we are going to work with a standalone server.

The above two commands start servers with their default configurations. If one wishes to start the server with one of alternative configurations, one should pass the <code>--server-config</code> argument with the server configuration file to be used. The example below shows how to run the full profile configuration with high availability:
* Windows: <code>standalone.bat --server-config=standalone-ha.xml</code>
* Linux: <code>standalone.sh --server-config=standalone-ha.xml</code>
You can read more about available JBoss 7 configurations [https://docs.jboss.org/author/display/AS71/Getting+Started+Guide#GettingStartedGuide-JBossApplicationServer7Configurations here].

After the server was started, log into administration console, go to the '''Runtime''' Tab, select '''Managed Deployments''' menu, click the '''Add contents''' button and select <code>CKFinderJava.war</code> file. Once CKFinderJava.war upload is finished, press the '''Enable''' button. The Application is now ready to use.
Another way of deploying the CKFinderJava application is using JBOSS Command Line Interface (CLI):
* '''In standalone mode:''' <ocde>[standalone@localhost:9999 /] deploy ~/Desktop/CKFinderJava.war</code>
* '''In domain mode:''' <code>[domain@localhost:9999 /] deploy ~/Desktop/ CKFinderJava.war --all-server-groups</code>
'''NOTE:''' Either <code>--all-server-groups</code> or <code>--server-groups must be specified</code>. 

To learn more about CLI please see this [https://community.jboss.org/wiki/CommandLineInterface link].

If your Server is running in the standalone mode, then aside from using the administration console and CLI, JBOSS 7 can also work in manual and auto deployment mode (this depends on your settings).
In the '''Auto-Deploy mode''' the scanner directly monitors the deployment content, available in <code><nowiki>JBOSS_HOME/standalone/deployments</nowiki></code> directory, automatically deploying new content and redeploying content whose timestamp has changed. It means that you can simply drop CKFinderJava.war into deployments folder and the application will be deployed. 
To undeploy CKFinderJava in auto mode simply remove war file from deploy directory. 
In the '''Manual deploy mode''' the scanner does not directly monitor the deployment content. Instead, the scanner relies on a system of marker files, which the user can add to or remove from deployment directory. These files serve as a sort of command telling the scanner to deploy, undeploy, or redeploy the content. You can learn more about marker files in the “Marker Files” section available under this [https://docs.jboss.org/author/display/AS7/Application+deploymen link].

To deploy <code>CKFinderJava.war</code> in manual mode, copy this file into the deployments directory and create the <code>CKFinderJava.war.dodeploy</code> file. CKFinder will be deployed and the <code>CKFinderJava.war.deployed</code> marker file will be created. To undeploy CKFinderJava simply remove <code>CKFinderJava.war.deployed</code> file.

Please note that by default JBOSS7 allows auto-deployment of zipped content and prevents auto-deployment of exploded content. This is because exploded content is vulnerable to the scanner trying to auto-deploy partially copied content. However, if you wish to change this behavior, you can go to the <code><nowiki>JBOSS_HOME/standalone/configuration/standalone.xml</nowiki></code> file, look for the '''deployment-scanner'' tag and change the deployment options as you like:

<source><deployment-scanner scan-interval="5000" relative-to="jboss.server.base.dir" path="deployments" auto-deploy-zipped="true" auto-deploy-exploded="false"/></source>

By default, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>
Please note that the HTTP <code>8080</code> 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.

If you want to use international files names with CKFinder please see [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Configuration/URI_Encoding URI Encoding section] which explains how to set UTF-8 on JBOSS.

=== GlassFish ===
The GlassFish server can be started from the command line. Go to the server <code>bin</code> folder and run the <code>asadmin</code> 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 <code>start-domain</code> 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: 

<source>deploy relativePath/CKFinderJava.war</source>

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

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

By deafult, the application should be available under the following URL in your browser:
<code><nowiki>http://localhost:8080/CKFinderJava/</nowiki></code>

Please note that the HTTP <code>8080</code> 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.

By default, Glassfish has ISO parameter-encoding set, which may cause problems if your users want to use filenames with non-ISO characters. If CKFinder in your application is to be used worldwide, it is recommended to set UTF-8 for Glassfish. Please refer to the [http://docs.cksource.com/CKFinder_2.x/Developers_Guide/Java/Configuration/URI_Encodinglink URI Encoding] section for more details.

Go to the Oracle [http://docs.oracle.com/cd/E19798-01/821-1757/index.html GlassFish 3.0] or, [http://docs.oracle.com/cd/E18930_01/html/821-2432/ GlassFish 3.1] or [https://glassfish.java.net/getstarted.html GlassFish 4.0] Server Quick Start Guide for more information about using this server.

=== Weblogic ===
The Weblogic Server (WLS) can be started from the command line. Go to the <code><nowiki>weblogic_main_folder/user_projects/domains/your_domain/bin</nowiki></code> folder and run the following script:
* Windows: <code>startWeblogic.bat</code> or <code>startWeblogicManagedServer.bat</code>
* Linux: <code>startWeblogic.sh</code> or <code>startWeblogicManagedServer.sh</code>
If Weblogic is in production mode then please remember that you need to specify the user name and password in order to run it.

As you probably know, Weblogic Server uses domains which are logically related groups of server resources. A domain can consist of an Administration Server and one or more Managed Servers, or of a single standalone server that acts as an Administration Server and runs deployed applications. In this example we are going to use a single standalone Administration Server.

After starting Weblogic, log into the Administration Console and click '''Deployments''' in the '''Domain Structure''' upper left menu. If WLS is in production mode, you need to click '''Lock&Edit''' first. In main panel click the '''Install''' button, specify the path to <code>CKFinderJava.war</code>, and click the '''Next''' button. Select the '''"Install this deployment as an application"''' option and press the '''Next''' button. In the last panel you can change the name of your deployment, the security model and the source accessibility. Once you are done, click the '''Finish''' button and CKFinderJava will be deployed. If WLS works in production mode, you will need to confirm all changes by clicking the '''Activate Changes''' button and start the application manually by selecting it and pressing the '''Start''' button.

By deafult, the application should be available under the following URL in your browser: <code><nowiki>http://localhost:7001/CKFinderJava/</nowiki></code>

The HTTP <code>7001</code> port of the sample URL is the default Weblogic Administration Server port. If you changed this value while configuring your Weblogic domain(s), you will need to use a modified port value to run the sample application.

Go to the [http://docs.oracle.com/cd/E17904_01/index.htm Weblogic 11g] or [http://docs.oracle.com/cd/E24329_01/index.htm Weblogic 12c] Documentation site for more information about using this server.

CKFinder 2.x/Developers Guide

2013-07-19T06:38:38Z

J.swiderski:

{{#CUSTOMTITLE:CKFinder 2.x Developer's Guide}}
__NOTOC__
== CKFinder for ASP ==
* [[/ASP/System Requirements|System Requirements]]
* [[/ASP/Installation|Installation]]
* [[/Upgrading|Upgrading]]
* [[/ASP/Configuration|Configuration]]
* [[/ASP/Integration|Integration]]
* [[/ASP/Plugins|Plugins]]
* [[/ASP/Troubleshooting|Troubleshooting]]
* [[/ASP/CKEditor Integration|CKEditor Integration]]
* [[/ASP/FCKeditor Integration|FCKeditor Integration]]

== CKFinder for ASP.NET ==
* [[/ASP.NET/System Requirements|System Requirements]]
* [[/ASP.NET/Installation|Installation]]
* [[/Upgrading|Upgrading]]
* [[/ASP.NET/Configuration|Configuration]]
* [[/ASP.NET/Integration|Integration]]
* [[/ASP.NET/Plugins|Plugins]]
* [[/ASP.NET/Troubleshooting|Troubleshooting]]
* [[/ASP.NET/CKEditor Integration|CKEditor Integration]]
* [[/ASP.NET/FCKeditor Integration|FCKeditor Integration]]

== CKFinder for ColdFusion ==
* [[/ColdFusion/System Requirements|System Requirements]]
* [[/ColdFusion/Installation|Installation]]
* [[/Upgrading|Upgrading]]
* [[/ColdFusion/Configuration|Configuration]]
* [[/ColdFusion/Integration|Integration]]
* [[/ColdFusion/Plugins|Plugins]]
* [[/ColdFusion/CKEditor Integration|CKEditor Integration]]
* [[/ColdFusion/FCKeditor Integration|FCKeditor Integration]]

== CKFinder for Java ==
* [[/Java/System Requirements|System Requirements]]
* [[/Java/Installation|Installation]]

* [[/Java/Configuration|Configuration]]
* [[/Java/Integration|Integration]]
* [[/Java/Plugins|Plugins]]
* [[/Java/Troubleshooting|Troubleshooting]]
* [[/Java/CKEditor Integration|CKEditor Integration]]
* [[/Java/FCKeditor Integration|FCKeditor Integration]]

== CKFinder for PHP ==
* [[/PHP/System Requirements|System Requirements]]
* [[/PHP/Installation|Installation]]
* [[/Upgrading|Upgrading]]
* [[/PHP/Configuration|Configuration]]
* [[/PHP/Integration|Integration]]
* [[/PHP/Plugins|Plugins]]
* [[/PHP/CKEditor Integration|CKEditor Integration]]
* [[/PHP/FCKeditor Integration|FCKeditor Integration]]

== Advanced ==
* [http://docs.cksource.com/ckfinder_2.x_api/ JavaScript API documentation] ([http://docs.cksource.com/ckfinder_2.x_api/ckfinder_2.x_api.zip download as .zip])
* [[CKFinder_2.x/Localization|Interface Localization]] – how to localize the CKFinder interface to your native language.
* [[CKFinder_2.x/Server Side Integration|Server Side Integration]] (for developers interested in modifying the core of CKFinder only)

== License ==
* [http://ckfinder.com/license CKFinder License]

CKFinder 2.x/Developers Guide/ASP

2013-07-19T06:37:34Z

J.swiderski:

* [[/System Requirements|System Requirements]]
* [[/Installation|Installation]]
* [[CKFinder_2.x/Developers_Guide/Upgrading|Upgrading]]
* [[/Configuration|Configuration]]
* [[/Integration|Integration]]
* [[/Plugins|Plugins]]
* [[/Troubleshooting|Troubleshooting]]
* [[/CKEditor Integration|CKEditor Integration]]
* [[/FCKeditor Integration|FCKeditor Integration]]
{{#CUSTOMTITLE:Developer's Guide (ASP)}}

CKFinder 2.x/Developers Guide/ColdFusion/Configuration/Access Control

2013-03-07T15:03:59Z

J.swiderski:

{{Ckfinder_2.x_Access_Control_Description|file=<code>config.cfm</code>|AccessControl=config.accessControl}}

<source lang="cfm">
config.accessControl[1] = structNew();
config.accessControl[1].role = '*';
config.accessControl[1].resourceType = '*';
config.accessControl[1].folder = '/';

config.accessControl[1].folderView = true;
config.accessControl[1].folderCreate = true;
config.accessControl[1].folderRename = true;
config.accessControl[1].folderDelete = true;

config.accessControl[1].fileView = true;
config.accessControl[1].fileUpload = true;
config.accessControl[1].fileRename = true;
config.accessControl[1].fileDelete = true;
</source>

{{ckfinder_acl_explanation}}

{{Ckfinder_2.x_ACL_Examples|example1=
<source lang="cfm">
config.accessControl[2] = structNew();
config.accessControl[2].role = '*';
config.accessControl[2].resourceType = 'Images';
config.accessControl[2].folder = '/Logos';

config.accessControl[2].folderView = true;
config.accessControl[2].folderCreate = true;
config.accessControl[2].folderRename = true;
config.accessControl[2].folderDelete = true;

config.accessControl[2].fileView = true;
config.accessControl[2].fileUpload = false;
config.accessControl[2].fileRename = false;
config.accessControl[2].fileDelete = false;
</source>|example2=
<source lang="cfm">config.accessControl[3] = structNew();
config.accessControl[3].role = '*';
config.accessControl[3].resourceType = 'Images';
config.accessControl[3].folder = '/';

config.accessControl[3].folderView = true;
config.accessControl[3].folderCreate = true;
config.accessControl[3].folderRename = false;
config.accessControl[3].folderDelete = false;

config.accessControl[3].fileView = true;
config.accessControl[3].fileUpload = true;
config.accessControl[3].fileRename = true;
config.accessControl[3].fileDelete = true;
</source>|wildcard_resource=(config.accessControl[1].resourceType = '*')}}

{{CKFinder_2.x Sessions|lang=ColdFusion|roleSessionVar=roleSessionVar|file=<code>config.cfm</code>|code1=<source lang="cfm">config.roleSessionVar = 'CKFinder_UserRole';</source>|code2=
<source lang="cfm"><CFLOCK TIMEOUT="30" NAME="#session.sessionID#" TYPE="Exclusive">
<CFSET session.CKFinder_UserRole="#newrole#">
</CFLOCK></source>|code3=
<source lang="cfm">config.accessControl[1] = structNew();
config.accessControl[1].role = '*';
config.accessControl[1].resourceType = '*';
config.accessControl[1].folder = '/';
config.accessControl[1].folderView = true;
config.accessControl[1].folderCreate = false;
config.accessControl[1].folderRename = false;
config.accessControl[1].folderDelete = false;
config.accessControl[1].fileView = true;
config.accessControl[1].fileUpload = false;
config.accessControl[1].fileRename = false;
config.accessControl[1].fileDelete = false;</source>|code4=
<source lang="cfm">config.accessControl[2] = structNew();
config.accessControl[2].role = 'registered';
config.accessControl[2].resourceType = '*';
config.accessControl[2].folder = '/';
config.accessControl[2].folderView = true;
config.accessControl[2].folderCreate = true;
config.accessControl[2].folderRename = false;
config.accessControl[2].folderDelete = false;
config.accessControl[2].fileView = true;
config.accessControl[2].fileUpload = true;
config.accessControl[2].fileRename = false;
config.accessControl[2].fileDelete = false;</source>|code5=
<source lang="cfm">config.accessControl[3] = structNew();
config.accessControl[3].role = 'admin';
config.accessControl[3].resourceType = '*';
config.accessControl[3].folder = '/';
config.accessControl[3].folderView = true;
config.accessControl[3].folderCreate = true;
config.accessControl[3].folderRename = true;
config.accessControl[3].folderDelete = true;
config.accessControl[3].fileView = true;
config.accessControl[3].fileUpload = true;
config.accessControl[3].fileRename = true;
config.accessControl[3].fileDelete = true;</source>}} In this file, you assign one of the pre-defined roles to the user — using the admin role:
{{CKFinder_2.x Sessions_Details|code1=
<source lang="cfm"><CFLOCK TIMEOUT="30" NAME="#session.sessionID#" TYPE="Exclusive">
<CFSET session.CKFinder_UserRole="#admin#">
</CFLOCK></source>|code2=
<source lang="cfm"><CFLOCK TIMEOUT="30" NAME="#session.sessionID#" TYPE="Exclusive">
<CFSET session.CKFinder_UserRole="#registered#">
</CFLOCK></source>|code3=
<source lang="cfm"><CFLOCK TIMEOUT="30" NAME="#session.sessionID#" TYPE="Exclusive">
<CFSET session.CKFinder_UserRole="#guest#">
</CFLOCK></source>|code4=
<source lang="cfm"><CFLOCK TIMEOUT="30" NAME="#session.sessionID#" TYPE="Exclusive">
<CFSET session.CKFinder_UserRole="#any_other_value#">
</CFLOCK></source>}}

CKFinder 2.x/Developers Guide/Java/Configuration/Access Control

2013-03-07T15:03:13Z

J.swiderski:

{{Ckfinder_2.x_Access_Control_Description|file=<code>config.xml</code>|AccessControl=accessControl}}
<source lang="xml">
<accessControls>
<accessControl>
<role>*</role>
<resourceType>*</resourceType>
<folder>/</folder>
<folderView>true</folderView>
<folderCreate>true</folderCreate>
<folderRename>true</folderRename>
<folderDelete>true</folderDelete>
<fileView>true</fileView>
<fileUpload>true</fileUpload>
<fileRename>true</fileRename>
<fileDelete>true</fileDelete>
</accessControl>
</accessControls>
</source>

{{ckfinder_acl_explanation}}

{{Ckfinder_2.x_ACL_Examples|example1=
<source lang="xml">
<accessControl>
<role>*</role>
<resourceType>Images</resourceType>
<folder>/Logos</folder>
<folderView>true</folderView>
<folderCreate>true</folderCreate>
<folderRename>true</folderRename>
<folderDelete>true</folderDelete>
<fileView>true</fileView>
<fileUpload>false</fileUpload>
<fileRename>false</fileRename>
<fileDelete>false</fileDelete>
</accessControl>
</source>|example2=
<source lang="xml">
<accessControl>
<role>*</role>
<resourceType>Images</resourceType>
<folder>/</folder>
<folderView>true</folderView>
<folderCreate>true</folderCreate>
<folderRename>false</folderRename>
<folderDelete>false</folderDelete>
<fileView>true</fileView>
<fileUpload>true</fileUpload>
<fileRename>true</fileRename>
<fileDelete>true</fileDelete>
</accessControl>
</source>|wildcard_resource=(<resourceType>*</resourceType>)}}

{{CKFinder_2.x Sessions|lang=Java|roleSessionVar=userRoleSessionVar|file=<code>config.xml</code>|code1=<source lang="xml"><userRoleSessionVar>CKFinder_UserRole</userRoleSessionVar></source>|code2=
<source lang="java">
HttpSession session = request.getSession(true);
session.setAttribute("CKFinder_UserRole", "admin");
</source>|code3=
<source lang="xml">
<accessControl>
<role>*</role>
<resourceType>*</resourceType>
<folder>/</folder>
<folderView>true</folderView>
<folderCreate>false</folderCreate>
<folderRename>false</folderRename>
<folderDelete>false</folderDelete>
<fileView>true</fileView>
<fileUpload>false</fileUpload>
<fileRename>false</fileRename>
<fileDelete>false</fileDelete>
</accessControl>
</source>|code4=
<source lang="xml">
<accessControl>
<role>registered</role>
<resourceType>*</resourceType>
<folder>/</folder>
<folderView>true</folderView>
<folderCreate>true</folderCreate>
<folderRename>false</folderRename>
<folderDelete>false</folderDelete>
<fileView>true</fileView>
<fileUpload>true</fileUpload>
<fileRename>false</fileRename>
<fileDelete>false</fileDelete>
</accessControl>
</source>|code5=
<source lang="xml">
<accessControl>
<role>admin</role>
<resourceType>*</resourceType>
<folder>/</folder>
<folderView>true</folderView>
<folderCreate>true</folderCreate>
<folderRename>true</folderRename>
<folderDelete>true</folderDelete>
<fileView>true</fileView>
<fileUpload>true</fileUpload>
<fileRename>true</fileRename>
<fileDelete>true</fileDelete>
</accessControl>
</source>}} In this file you assign one of the pre-defined roles to the user in the following way — using the admin role:
{{CKFinder_2.x Sessions_Details|code1=
<source lang="java">session.setAttribute("CKFinder_UserRole", "admin");</source>|code2=
<source lang="java">session.setAttribute("CKFinder_UserRole", "registered");</source>|code3=
<source lang="java">session.setAttribute("CKFinder_UserRole", "guest");</source>|code4=
<source lang="java">session.setAttribute("CKFinder_UserRole", "any_other_value");</source>}}

CKFinder 2.x/Developers Guide/PHP/Configuration/Access Control

2013-03-07T15:02:37Z

J.swiderski:

{{Ckfinder_2.x_Access_Control_Description|file=<code>config.php</code>|AccessControl=$config['AccessControl']}}
<source lang="php">
$config['AccessControl'][] = Array(
'role' => '*',
'resourceType' => '*',
'folder' => '/',

'folderView' => true,
'folderCreate' => true,
'folderRename' => true,
'folderDelete' => true,

'fileView' => true,
'fileUpload' => true,
'fileRename' => true,
'fileDelete' => true);
</source>

{{ckfinder_acl_explanation}}

{{Ckfinder_2.x_ACL_Examples|example1=
<source lang="php">$config['AccessControl'][] = Array(
'role' => '*',
'resourceType' => 'Images',
'folder' => '/Logos',

'folderView' => true,
'folderCreate' => true,
'folderRename' => true,
'folderDelete' => true,

'fileView' => true,
'fileUpload' => false,
'fileRename' => false,
'fileDelete' => false);
</source>|example2=
<source lang="php">$config['AccessControl'][] = Array(
'role' => '*',
'resourceType' => 'Images',
'folder' => '/',

'folderView' => true,
'folderCreate' => true,
'folderRename' => false,
'folderDelete' => false

'fileView' => true,
'fileUpload' => true,
'fileRename' => true,
'fileDelete' => true);</source>||wildcard_resource=('resourceType' => '*')}}

{{CKFinder_2.x Sessions|lang=PHP|roleSessionVar=RoleSessionVar|file=<code>config.php</code>|code1=<source lang="php">$config['RoleSessionVar'] = 'CKFinder_UserRole';</source>|code2=<source lang="php">$_SESSION['CKFinder_UserRole'] = "admin";</source>|code3=
<source lang="php">$config['AccessControl'][] = Array(
'role' => '*',
'resourceType' => '*',
'folder' => '/',

'folderView' => true,
'folderCreate' => false,
'folderRename' => false,
'folderDelete' => false,

'fileView' => true,
'fileUpload' => false,
'fileRename' => false,
'fileDelete' => false);
</source>|code4=
<source lang="php">$config['AccessControl'][] = Array(
'role' => 'registered',
'resourceType' => '*',
'folder' => '/',

'folderView' => true,
'folderCreate' => true,
'folderRename' => false,
'folderDelete' => false,

'fileView' => true,
'fileUpload' => true,
'fileRename' => false,
'fileDelete' => false);
</source>|code5=
<source lang="php">$config['AccessControl'][] = Array(
'role' => 'admin',
'resourceType' => '*',
'folder' => '/',

'folderView' => true,
'folderCreate' => true,
'folderRename' => true,
'folderDelete' => true,

'fileView' => true,
'fileUpload' => true,
'fileRename' => true,
'fileDelete' => true);</source>}} In this file you initialize the session with the <code>session_start();</code> command and assign one of the pre-defined roles to the user in the following way — using the admin role:
{{CKFinder_2.x Sessions_Details|code1=
<source lang="php">$_SESSION['CKFinder_UserRole'] ='admin';</source>|code2=
<source lang="php">$_SESSION['CKFinder_UserRole'] ='registered';</source>|code3=
<source lang="php">$_SESSION['CKFinder_UserRole'] = 'guest';</source>|code4=
<source lang="php">$_SESSION['CKFinder_UserRole'] = 'any_other_value';</source>}}

CKFinder 2.x/Developers Guide/ASP/Configuration/Access Control

2013-03-07T15:02:14Z

J.swiderski:

{{Ckfinder_2.x_Access_Control_Description|file=<code>config.asp</code>|AccessControl=accessControl(0)}}
<source lang="asp">Set accessControl(0) = DefineAccessControlItem("*", "*", "/", true, true, true, true, true, true, true, true)</source>
The parameters are definied in the following order:
<source lang="asp">Function DefineAccessControlItem( role, resourceType, folder, folderView, folderCreate, folderRename, folderDelete,
fileView, fileUpload, fileRename, fileDelete )</source>

{{ckfinder_acl_explanation}}

{{Ckfinder_2.x_ACL_Examples|example1=
<source lang="asp">Set accessControl(1) = DefineAccessControlItem("*", "Images", "/Logos", true, true, true, true, true, false, false, false)</source>|example2=
<source lang="asp">Set accessControl(1) = DefineAccessControlItem("*", "Images", "/", true, true, false, false, true, false, false, false)</source>|wildcard_resource=(DefineAccessControlItem("*"...))}}

<note>Remember to adjust <code>Dim accessControl(0)</code> to <code>Dim accessControl(1)</code> as necessary.
</note>

{{CKFinder_2.x Sessions|lang=ASP|roleSessionVar=RoleSessionVar|file=<code>config.asp</code>|code1=
<source lang="asp">CKFinder_Config.Add "RoleSessionVar", "CKFinder_UserRole"</source>|code2=
<source lang="asp"><% Session("CKFinder_UserRole")="admin" %></source>|code3=
<source lang="asp">Set accessControl(1) = DefineAccessControlItem("*", "*", "/", true, false, false, false, true, false, false, false)</source>|code4=
<source lang="asp">Set accessControl(2) = DefineAccessControlItem("registered", "*", "/", true, true, false, false, true, true, false, false)</source>|code5=
<source lang="asp">Set accessControl(3) = DefineAccessControlItem("admin", "*", "/", true, true, true, true, true, true, true, true)</source>}} You can assign one of the pre-defined roles to the user — using the admin role:
{{CKFinder_2.x Sessions_Details|code1=
<source lang="asp"><% Session("CKFinder_UserRole")="admin" %></source>|code2=
<source lang="asp"><% Session("CKFinder_UserRole")="registered" %></source>|code3=
<source lang="asp"><% Session("CKFinder_UserRole")="guest" %></source>|code4=
<source lang="asp"><% Session("CKFinder_UserRole")="any_other_value" %></source>}}

CKFinder 2.x/Developers Guide/ColdFusion/Configuration/Access Control

2013-03-07T15:00:01Z

J.swiderski:

{{Ckfinder_2.x_Access_Control_Description|file=<code>config.cfm</code>|AccessControl=config.accessControl}}

<source lang="cfm">
config.accessControl[1] = structNew();
config.accessControl[1].role = '*';
config.accessControl[1].resourceType = '*';
config.accessControl[1].folder = '/';

config.accessControl[1].folderView = true;
config.accessControl[1].folderCreate = true;
config.accessControl[1].folderRename = true;
config.accessControl[1].folderDelete = true;

config.accessControl[1].fileView = true;
config.accessControl[1].fileUpload = true;
config.accessControl[1].fileRename = true;
config.accessControl[1].fileDelete = true;
</source>

{{ckfinder_acl_explanation}}

{{Ckfinder_2.x_ACL_Examples|example1=
<source lang="cfm">
config.accessControl[2] = structNew();
config.accessControl[2].role = '*';
config.accessControl[2].resourceType = 'Images';
config.accessControl[2].folder = '/Logos';

config.accessControl[2].folderView = true;
config.accessControl[2].folderCreate = true;
config.accessControl[2].folderRename = true;
config.accessControl[2].folderDelete = true;

config.accessControl[2].fileView = true;
config.accessControl[2].fileUpload = false;
config.accessControl[2].fileRename = false;
config.accessControl[2].fileDelete = false;
</source>|example2=
<source lang="cfm">config.accessControl[3] = structNew();
config.accessControl[3].role = '*';
config.accessControl[3].resourceType = 'Images';
config.accessControl[3].folder = '/';

config.accessControl[3].folderView = true;
config.accessControl[3].folderCreate = true;
config.accessControl[3].folderRename = false;
config.accessControl[3].folderDelete = false;

config.accessControl[3].fileView = true;
config.accessControl[3].fileUpload = true;
config.accessControl[3].fileRename = true;
config.accessControl[3].fileDelete = true;
</source>|wildcard_resource=config.accessControl[1].resourceType = '*'}}

{{CKFinder_2.x Sessions|lang=ColdFusion|roleSessionVar=roleSessionVar|file=<code>config.cfm</code>|code1=<source lang="cfm">config.roleSessionVar = 'CKFinder_UserRole';</source>|code2=
<source lang="cfm"><CFLOCK TIMEOUT="30" NAME="#session.sessionID#" TYPE="Exclusive">
<CFSET session.CKFinder_UserRole="#newrole#">
</CFLOCK></source>|code3=
<source lang="cfm">config.accessControl[1] = structNew();
config.accessControl[1].role = '*';
config.accessControl[1].resourceType = '*';
config.accessControl[1].folder = '/';
config.accessControl[1].folderView = true;
config.accessControl[1].folderCreate = false;
config.accessControl[1].folderRename = false;
config.accessControl[1].folderDelete = false;
config.accessControl[1].fileView = true;
config.accessControl[1].fileUpload = false;
config.accessControl[1].fileRename = false;
config.accessControl[1].fileDelete = false;</source>|code4=
<source lang="cfm">config.accessControl[2] = structNew();
config.accessControl[2].role = 'registered';
config.accessControl[2].resourceType = '*';
config.accessControl[2].folder = '/';
config.accessControl[2].folderView = true;
config.accessControl[2].folderCreate = true;
config.accessControl[2].folderRename = false;
config.accessControl[2].folderDelete = false;
config.accessControl[2].fileView = true;
config.accessControl[2].fileUpload = true;
config.accessControl[2].fileRename = false;
config.accessControl[2].fileDelete = false;</source>|code5=
<source lang="cfm">config.accessControl[3] = structNew();
config.accessControl[3].role = 'admin';
config.accessControl[3].resourceType = '*';
config.accessControl[3].folder = '/';
config.accessControl[3].folderView = true;
config.accessControl[3].folderCreate = true;
config.accessControl[3].folderRename = true;
config.accessControl[3].folderDelete = true;
config.accessControl[3].fileView = true;
config.accessControl[3].fileUpload = true;
config.accessControl[3].fileRename = true;
config.accessControl[3].fileDelete = true;</source>}} In this file, you assign one of the pre-defined roles to the user — using the admin role:
{{CKFinder_2.x Sessions_Details|code1=
<source lang="cfm"><CFLOCK TIMEOUT="30" NAME="#session.sessionID#" TYPE="Exclusive">
<CFSET session.CKFinder_UserRole="#admin#">
</CFLOCK></source>|code2=
<source lang="cfm"><CFLOCK TIMEOUT="30" NAME="#session.sessionID#" TYPE="Exclusive">
<CFSET session.CKFinder_UserRole="#registered#">
</CFLOCK></source>|code3=
<source lang="cfm"><CFLOCK TIMEOUT="30" NAME="#session.sessionID#" TYPE="Exclusive">
<CFSET session.CKFinder_UserRole="#guest#">
</CFLOCK></source>|code4=
<source lang="cfm"><CFLOCK TIMEOUT="30" NAME="#session.sessionID#" TYPE="Exclusive">
<CFSET session.CKFinder_UserRole="#any_other_value#">
</CFLOCK></source>}}