m (moved CKFinder/Developers Guide/ASP.NET/Configuration/Quick Start to CKFinder 1.x/Developers Guide/ASP.NET/Configuration/Quick Start) |
|||
| (6 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | == The CheckAuthentication() function<br> == | |
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. | 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. | ||
| Line 19: | Line 19: | ||
</pre> | </pre> | ||
| − | + | == License == | |
| − | + | The license information for CKFinder must be pasted inside the LicenseName and LicenseKey variables: | |
| − | <pre> | + | <pre>LicenseName = "put your license name here"; |
| − | + | LicenseKey = "put your license key here";</pre> | |
| − | If | + | 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 ''' | + | The '''BaseUrl''' setting is the base path used to build the final URL for the resources handled in CKFinder. For example: |
| − | <pre> | + | <pre>BaseUrl = "/ckfinder/userfiles/";</pre> |
Notice that the trailing slash is required. | Notice that the trailing slash is required. | ||
| − | The ''' | + | 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: | + | You may point it to a directory directly. For example: |
| − | <pre> | + | <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> | |
| − | <pre> | + | |
| − | + | === Full URLs<br> === | |
| − | <pre> | + | |
| − | If | + | 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> | + | <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 = ""; | ||
| + | |||
| + | // THIS IS GOOD: | ||
| + | BaseUrl = "http://example.com/ckfinder/files/"; | ||
| + | BaseDir = "C:/InetPub/MySite/ckfinder/files/"; | ||
| + | </pre> | ||
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/";