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.

(→‎License)
 
(14 intermediate revisions by 3 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 programm 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.
  
−
'''$config['Enabled'] = true;'''
+
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.
  
−
=== License ===
+
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.
  
−
If you purchesed CKFinder you should put your license key in the config.php file:
+
The following is a sample implementation for it:
 +
<source>function CheckAuthentication()
 +
{   
 +
return isset($_SESSION['IsAuthorized']) && $_SESSION['IsAuthorized'];
 +
}
 +
</source>
  
−
<pre>$config['LicenseName'] = 'put your license name here';
+
{{CKFinder Sessions|lang=PHP}}
−
$config['LicenseKey'] = 'put your license key here';</pre>
+
=== License ===
  
−
If you leave this fields blank CKFinder will be fully functional bu it will be runing in demo mode.
+
If you purchased CKFinder you should put your license key in the config.php file:
 +
<source lang="php">$config['LicenseName'] = 'put your license name here';
 +
$config['LicenseKey'] = 'put your license key here';</source>
 +
If you leave this fields blank CKFinder will be fully functional but it will be ruining in demo mode.
  
 
=== baseUrl ===
 
=== baseUrl ===
  
−
The $baseUrl is the base path used to build the final URL for the resources handled in CKFinder. Examples:
+
The '''$baseUrl''' is the base path used to build the final URL for the resources handled in CKFinder. Examples:
−
 
+
<source lang="php">$baseUrl = 'http://example.com/ckfinder/files/';
−
'''$baseUrl = 'http://example.com/ckfinder/files/';<br>$baseUrl = '/userfiles/';'''
+
$baseUrl = '/userfiles/';</source>
−
 
 
 
If you leave this field empty the default value (/userfiles/) will be used. Notice that the trailing slash is required.
 
If you leave this field empty the default value (/userfiles/) will be used. Notice that the trailing slash is required.
  
 
=== baseDir ===
 
=== 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:
+
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:
 
You may point it to a directory directly:
−
 
+
<source lang="php">$baseDir = '/home/login/public_html/ckfinder/files/';
−
'''$baseDir = '/home/login/public_html/ckfinder/files/';<br>$baseDir = 'C:/SiteDir/CKFinder/userfiles/';'''
+
$baseDir = 'C:/SiteDir/CKFinder/userfiles/';</source>
−
 
 
 
Or you may let CKFinder discover the path, based on $baseUrl:
 
Or you may let CKFinder discover the path, based on $baseUrl:
−
 
+
<pre>$baseDir = resolveUrl($baseUrl);</pre>
−
'''$baseDir = resolveUrl($baseUrl);'''
+
Remember that CKFinder will only discover the path when the base url is a local web path ( relative to document root ).<br>Example:
−
 
+
<pre>$baseUrl = '/userfiles/'</pre>
−
<br>Remeber that CKFinder will only discover the path when the base url is a local web path ( relative to document root ).<br>Example:
+
If it is a full URL address.<br>Example:
−
 
+
<pre>$baseUrl = 'http://example.com/ckfinder/files/'</pre>
−
'''$baseUrl = '/userfiles/''''
 
−
 
 
−
<br>If it is a full URL adress.<br>Example:
 
−
 
 
−
'''$baseUrl = 'http://example.com/ckfinder/files/''''
 
−
 
 
 
the path won't be discovered. Notice that the trailing slash is required.
 
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: 

function CheckAuthentication()
{    
	return isset($_SESSION['IsAuthorized']) && $_SESSION['IsAuthorized'];
}

Please read the Sessions article for more information about using session variables.

License

If you purchased 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 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: 

$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);

Remember 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 address.
Example: 

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

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

Retrieved from "https://docs-old.ckeditor.com/index.php?title=CKFinder_1.x/Developers_Guide/PHP/Configuration/Quick_Start&oldid=3535"
This page was last edited on 28 May 2010, at 07:46.