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...)
 
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
=== Enabling ===
+
== The CheckAuthentication() function<br> ==
  
−
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 option by setting it to '''true''':
+
By default, CKFinder will not work due to authentication restrictions. You must first be sure that you have configured it properly, and then enable it.
−
<pre>enabled = "true"</pre>
 
−
=== License ===
 
  
−
If you purchased CKFinder you should put your license key in the ckfinder.config file:
+
Once you have completely configured CKFinder, you are ready to enable it for use. The CheckAuthentication() function is used for that. In this function, you must implement the code that ensures that the requests are coming from an authenticated user. This is usually done by assigning a session variable when the user logs on your system.
−
<pre>licenseName = "put your license name here"
 
−
licenseKey = "put your license key here"</pre>
 
−
If you leave this fields blank CKFinder will be fully functional but it will be ruining in demo mode.
 
  
−
=== BaseDirectory ===
+
Return "true" if the user is properly authenticated. We strongly recommend you to NOT simply return "true" from this function without implementing authentication checks. Anonymous users would be able to use CKFinder, including uploading and deleting files from your server.
  
−
The '''url''' is the base path used to build the final URL for the resources handled in CKFinder. Examples:
+
The following is a sample implementation for it:
−
<pre>url = "/ckfinder/userfiles/"</pre>  
+
<pre>public override bool CheckAuthentication()
 +
{
 +
    if ( Session[ "IsAuthenticated" ] &amp;&amp; (bool)Session[ "IsAuthenticated" ] == true )
 +
    {
 +
        return true;
 +
    }
 +
 
 +
    return false;
 +
}
 +
</pre>
 +
 
 +
== License ==
 +
 
 +
The license information for CKFinder must be pasted inside the LicenseName and LicenseKey variables:
 +
<pre>LicenseName = "put your license name here";
 +
LicenseKey = "put your license key here";</pre>
 +
If these fields are blank or an invalid license key information is set, CKFinder will still be fully functional but it will be ruining in demo mode.
 +
 
 +
== Base URL and Directory ==
 +
 
 +
The&nbsp;'''BaseUrl''' setting is the base path used to build the final URL for the resources handled in CKFinder. For example:
 +
<pre>BaseUrl = "/ckfinder/userfiles/";</pre>  
 
Notice that the trailing slash is required.
 
Notice that the trailing slash is required.
  
−
The '''serverPath''' is the path to the local directory (in the server) which points to the above '''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:
+
The '''BaseDir''' is the path to the local directory (in the server) which points to the above '''URL'''. This is the path used by CKFinder to handle the files in the server. Full write permissions must be granted to this directory.
 +
 
 +
You may point it to a directory directly. For example:
 +
<pre>BaseDir = "C:/SiteDir/CKFinder/userfiles/";</pre>
 +
By leaving BaseDir empty, CKFinder will automatically attempt to resolve the path, based on '''BaseUrl''' (like Server.MapPath). For example:
 +
<pre>BaseDir = "";</pre>
 +
 
 +
=== Full URLs<br> ===
 +
 
 +
CKFinder is able to resolve the BaseUrl path only when setting it to an absolute URL path, starting from the document root. For example:
 +
<pre>BaseUrl = "/userfiles/";
 +
BaseDir = "";
 +
</pre>
 +
If you need CKFinder to return full URL address for the resources, the you are explicetelly required to set the BaseDir setting. For example:<br>
 +
<pre>// THIS IS WRONG:
 +
BaseUrl = "http://example.com/ckfinder/files/";
 +
BaseDir = "";
  
−
You may point it to a directory directly:
+
// THIS IS GOOD:
−
<pre>serverPath = "/home/login/public_html/ckfinder/files/"
+
BaseUrl = "http://example.com/ckfinder/files/";
−
serverPath = "C:/SiteDir/CKFinder/userfiles/"</pre>
+
BaseDir = "C:/InetPub/MySite/ckfinder/files/";
−
Or you may let CKFinder discover the path, based on '''url''' by leaving the field empty<br>
+
</pre>
−
<pre>serverPath = ""</pre>
 
−
Remember that CKFinder will only discover the path when the base url is a local web path ( relative to document root ).<br>Example:
 
−
<pre>url = "/userfiles/"</pre>
 
−
If it is a full URL address.<br>Example:
 
−
<pre>url= "http://example.com/ckfinder/files/"</pre>  
 
−
the path won't be discovered. Notice that the trailing slash is required.
 

Latest revision as of 07:46, 28 May 2010

The CheckAuthentication() function

By default, CKFinder will not work due to authentication restrictions. You must first be sure that you have configured it properly, and then enable it.

Once you have completely configured CKFinder, you are ready to enable it for use. The CheckAuthentication() function is used for that. In this function, you must implement the code that ensures that the requests are coming from an authenticated user. This is usually done by assigning a session variable when the user logs on your system.

Return "true" if the user is properly authenticated. We strongly recommend you to NOT simply return "true" from this function without implementing authentication checks. Anonymous users would be able to use CKFinder, including uploading and deleting files from your server.

The following is a sample implementation for it: 

public override bool CheckAuthentication()
{
    if ( Session[ "IsAuthenticated" ] && (bool)Session[ "IsAuthenticated" ] == true )
    {
        return true;
    }

    return false;
}

License

The license information for CKFinder must be pasted inside the LicenseName and LicenseKey variables: 

LicenseName = "put your license name here";
LicenseKey = "put your license key here";

If these fields are blank or an invalid license key information is set, CKFinder will still be fully functional but it will be ruining in demo mode.

Base URL and Directory

The BaseUrl setting is the base path used to build the final URL for the resources handled in CKFinder. For example: 

BaseUrl = "/ckfinder/userfiles/";

Notice that the trailing slash is required.

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

You may point it to a directory directly. For example: 

BaseDir = "C:/SiteDir/CKFinder/userfiles/";

By leaving BaseDir empty, CKFinder will automatically attempt to resolve the path, based on BaseUrl (like Server.MapPath). For example: 

BaseDir = "";

Full URLs

CKFinder is able to resolve the BaseUrl path only when setting it to an absolute URL path, starting from the document root. For example: 

BaseUrl = "/userfiles/";
BaseDir = "";

If you need CKFinder to return full URL address for the resources, the you are explicetelly required to set the BaseDir setting. For example:

// THIS IS WRONG:
BaseUrl = "http://example.com/ckfinder/files/";
BaseDir = "";

// THIS IS GOOD:
BaseUrl = "http://example.com/ckfinder/files/";
BaseDir = "C:/InetPub/MySite/ckfinder/files/";
Retrieved from "https://docs-old.ckeditor.com/index.php?title=CKFinder_1.x/Developers_Guide/ASP.NET/Configuration/Quick_Start&oldid=3415"
This page was last edited on 28 May 2010, at 07:46.