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.

Enabling

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

$config['Enabled'] = true;

License

If you purchesed CKFinder you should put your license key in the config.php 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 bu it will be runing in demo mode.

baseUrl

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

$baseUrl = 'http://example.com/ckfinder/files/';
$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:

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

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

$baseDir = resolveUrl($baseUrl);

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

$baseUrl = '/userfiles/'

If it is a full URL adress.
Example:

$baseUrl = 'http://example.com/ckfinder/files/'

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