CKFinder 2.x/Developers Guide/Minimum Setup - Revision history

Anna: Minor rewording

2012-04-30T11:33:37Z

Minor rewording

Anna: http://docs.cksource.com/ckfinder_2.x_api/symbols/CKFinder.config.html#.disableHelpButton link added

2012-04-30T11:22:52Z

http://docs.cksource.com/ckfinder_2.x_api/symbols/CKFinder.config.html#.disableHelpButton link added

Anna: Article contents added

2012-04-30T11:08:34Z

Article contents added

New page

CKFinder is highly customizable and can be adjusted to your needs. In order to make your customization efforts easier, below you will find a summary of the contents of the CKFinder installation package. This should help you minimize the number of files deployed to the production server in case you wanted to only use the bare minimum that can make CKFinder work. If needed, you can go through the file list below and manually remove some of them according to your needs.
* <code>_samples</code> – this directory contains CKFinder samples. Using the sample files is the easiest way to verify whether your setup works properly. If CKFinder works correctly, you can safely remove the whole <code>_ samples</code> folder.
* <code>core</code> – this directory contains core CKFinder files, including the connector. It is necessary for CKFinder to work and should be left untouched.
* <code>help</code> – this directory contains the CKFinder User's Guide that is available when you click the '''Help''' toolbar button. If you disable the '''Help''' button, you can delete this folder. Likewise, you can remove particular language versions of the User's Guide if you feel they will not be needed by the users of your website.
* <code>lang</code> – this directory contains CKFinder language files. It is necessary for CKFinder to work, although you can remove the unused language files if you force the CKFinder interface language using the <code>[http://docs.cksource.com/ckfinder_2.x_api/symbols/CKFinder.config.html#.language CKFinder.config.language]</code> property set in the <code>config.js</code> file.
* <code>plugins</code> – this directory contains the plugin files and is necessary for CKFinder to work. Due to the modular construction of the file browser some core functionality was delegated to plugins. You can remove some unused plugins that are not packed in <code>ckfinder.js</code> and are only loaded on demand through the <code>[http://docs.cksource.com/ckfinder_2.x_api/symbols/CKFinder.config.html#.extraPlugins CKFinder.config.extraPlugins]</code> property.
* <code>skins</code> – this directory contains CKFinder skin files along with toolbar buttons and stylesheet definitions and is necessary for CKFinder to work. You can however remove unused skins and their files.
* <code>userfiles</code> – this is the default upload folder for files uploaded with CKFinder. If you change it in your file browser configuration, you can safely remove this directory.

From the CKFinder root directory you can safely remove the following files:
* <code>translations.txt</code>
* <code>install.txt</code>
* <code>changelog.txt</code>

@@ Line 2: / Line 2: @@
 * <code>_samples</code> &ndash; this directory contains CKFinder samples. Using the sample files is the easiest way to verify whether your setup works properly. If CKFinder works correctly, you can safely remove the whole <code>_ samples</code> folder.
 * <code>core</code> &ndash; this directory contains core CKFinder files, including the connector. It is necessary for CKFinder to work and should be left untouched.
-* <code>help</code>  &ndash; this directory contains the CKFinder User's Guide that is available when you click the '''Help''' toolbar button. If you [http://docs.cksource.com/ckfinder_2.x_api/symbols/CKFinder.config.html#.disableHelpButton disable the '''Help''' button], you can delete this folder. Likewise, you can remove particular language versions of the User's Guide if you feel they will not be needed by the users of your website.
+* <code>help</code>  &ndash; this directory contains the CKFinder User's Guide that is available when you click the '''Help''' toolbar button. If you [http://docs.cksource.com/ckfinder_2.x_api/symbols/CKFinder.config.html#.disableHelpButton disable the '''Help''' button], you can delete this folder.
 * <code>lang</code> &ndash; this directory contains CKFinder language files. It is necessary for CKFinder to work, although you can remove the unused language files if you force the CKFinder interface language using the <code>[http://docs.cksource.com/ckfinder_2.x_api/symbols/CKFinder.config.html#.language CKFinder.config.language]</code> property set in the <code>config.js</code> file.
-* <code>plugins</code> &ndash; this directory contains the plugin files and is necessary for CKFinder to work. Due to the modular construction of the file browser some core functionality was delegated to plugins. You can remove some unused plugins that are not packed in <code>ckfinder.js</code> and are only loaded on demand through the <code>[http://docs.cksource.com/ckfinder_2.x_api/symbols/CKFinder.config.html#.extraPlugins CKFinder.config.extraPlugins]</code> property.
+* <code>plugins</code> &ndash; this directory contains the plugin files and is necessary for CKFinder to work. Due to the modular construction of the file browser some core functionality was delegated to plugins. You can remove some unused plugins that are not enabled in the configuration file.
 * <code>skins</code> &ndash; this directory contains CKFinder skin files along with toolbar buttons and stylesheet definitions and is necessary for CKFinder to work. You can however remove unused skins and their files.
 * <code>userfiles</code> &ndash; this is the default upload folder for files uploaded with CKFinder. If you change it in your file browser configuration, you can safely remove this directory.