Quick Start"

This website contains links to software which is either no longer maintained or will be supported only until the end of 2019 (CKFinder 2). For the latest documentation about current CKSource projects, including software like CKEditor 4/CKEditor 5, CKFinder 3, Cloud Services, Letters, Accessibility Checker, please visit the new documentation website.

If you look for an information about very old versions of CKEditor, FCKeditor and CKFinder check also the CKEditor forum, which was closed in 2015. If not, please head to StackOverflow for support.

(New page: === Enabling === The first step you should take in order to configure your CKFinder is enabling it. This option is essential for the program to work properly.<br>You should enable this op...)
 
Line 5: Line 5:
 
=== License ===
 
=== License ===
  
If you purchased CKFinder you should put your license key in the config.php file:
+
If you purchased CKFinder you should put your license key in the config.cfm file:
 
<pre>config.licenseName = 'put your license name here';
 
<pre>config.licenseName = 'put your license name here';
 
config.licenseKey = 'put your license key here';</pre>  
 
config.licenseKey = 'put your license key here';</pre>  

Revision as of 10:31, 11 January 2008

Enabling

The first step you should take in order to configure your CKFinder is enabling it. This option is essential for the program to work properly.
You should enable this option by setting it to true:

config.enabled = true;

License

If you purchased CKFinder you should put your license key in the config.cfm file:

config.licenseName = 'put your license name here';
config.licenseKey = 'put your license key here';

If you leave this fields blank CKFinder will be fully functional but it will be ruining in demo mode.

baseUrl

The baseUrl is the base path used to build the final URL for the resources handled in CKFinder. Examples:

config.baseUrl = 'http://example.com/ckfinder/files/';
config.baseUrl = '/userfiles/';

If you leave this field empty the default value (/userfiles/) will be used. Notice that the trailing slash is required.

baseDir

The baseDir is the path to the local directory (in the server) which points to the above baseUrl URL. This is the path used by CKFinder to handle the files in the server. Full write permissions must be granted to this directory. Examples:

You may point it to a directory directly:

config.baseDir = '/home/login/public_html/ckfinder/files/';
config.baseDir = 'C:/SiteDir/CKFinder/userfiles/';

Or you may let CKFinder discover the path, based on baseUrl:

config.baseDir = APPLICATION.CreateCFC("Utils.FileSystem").resolveUrl(config.baseUrl);

Remember that CKFinder will only discover the path when the base url is a local web path ( relative to document root ).
Example:

config.baseUrl = '/userfiles/';

If it is a full URL address.
Example:

config.baseUrl = 'http://example.com/ckfinder/files/';

the path won't be discovered. Notice that the trailing slash is required.