Upgrading

Latest CKFinder is always the greatest CKFinder. Each new release brings plenty of bug fixes and new features, so it is highly recommended to upgrade often.

important note
Please note that each CKFinder license grants you one year of free upgrades. If you want to take advantage of new CKFinder releases after that time, you can renew your license at any time for a discounted price.


Upgrading CKFinder is an easy task. See the complete upgrade instructions below.

Contents

Upgrade Instructions

If you want to upgrade your CKFinder installation, proceed as described below.

  1. Download the latest CKFinder version from the official CKFinder website.
  2. Backup your old copy of CKFinder to a safe place.
  3. Temporarily disable access to CKFinder for all users of your application.
  4. Delete all files from the CKFinder folder (remember to not delete the userfiles folder if you configured CKFinder to store files there).
  5. Unpack the new CKFinder version to the folder where old CKFinder was previously installed.
  6. Apply changes from the old configuration file to the new configuration file shipped with CKFinder (most of the time, you can simply use the old configuration file).
  7. (Optional) In you application add a timestamp to the path to ckfinder.js to help browsers recognize that the new version of the file is available, e.g.:

    <script type="text/javascript" src="/ckfinder/ckfinder.js?t=20100601"></script>
  8. Perform some simple tests to ensure that CKFinder is running fine.
  9. Enable access to CKFinder for all users of your application.

Upgrading from CKFinder 1.x

When using the server side integration method, no code changes are required when upgrading from CKFinder 1.x to 2.x. However, when using JavaScript integration, some small modifications are needed, please read below.

Method 1

In CKFinder 2.x we have made a small changes to the JavaScript API to conform to CKEditor coding standards. The JavaScript methods now begin with a lower case letter. The following code used in CKFinder 1.x:

var finder = new CKFinder();
finder.BasePath = '/ckfinder/';
finder.SelectFunction = ShowFileInfo;
finder.Create();

should be changed in CKFinder 2.x into:

var finder = new CKFinder();
finder.basePath = '/ckfinder/';
finder.selectFunction = ShowFileInfo;
finder.create();

Method 2

Alternatively, you may simply include ckfinder_v1.js instead of ckfinder.js in your application to not worry about changes in the API . ckfinder_v1.js contains a comptibility pack that makes ugrading from 1.x even easier thanks to bringing back old function names used in CKFinder 1.x.

This method of upgrading is not the same as the first method. When using ckfinder_v1.js, an extra file named ckfinder.html is used to create CKFinder instance, for better performance the first method should be used instead.

Method 3

Please make sure that you're using CKFinder downloaded after May 31th, 2010 to be able to follow this method.

This method is similar to method (2), but does not require any changes in existing applications. Instead, we just rename some files from CKFinder package.

  1. Rename ckfinder.js to ckfinder_v2.js
  2. Rename ckfinder_v1.js to ckfinder.js
  3. In ckfinder.html change:

    <script type="text/javascript" src="ckfinder.js"></script>
    into

    <script type="text/javascript" src="ckfinder_v2.js"></script>

Note: this method is not recommended, because you'll have to repeat steps above everytime you download a newer version of CKFinder.

This page was last modified on 5 January 2012, at 14:29.