Installation"

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.

(Add upgrade installation instructions.)
(Typo corrected)
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
Installing CKEditor is a easy task. Just follow these simple steps:
+
__TOC__
 +
Installing CKEditor is easy. In order to install the editor, choose an appropriate procedure (fresh install or upgrade) and follow the steps described below.
  
−
== Installation procedures ==
+
== Installation Procedures ==
  
−
=== Fresh installation ===
+
=== Fresh Installation ===
−
#'''Download''' the latest version of the editor from our web site: http://ckeditor.com/  
+
To install CKEditor for the first time, proceed in the following way:
−
#'''Extract''' (decompress) the downloaded file to a directory called "ckeditor" in the root of your web site
+
# '''Download''' the latest version of the editor from our website: http://ckeditor.com/download
−
'''Note:''' You can place the files in whichever path at your web site. "ckeditor" is the default one.  
+
# '''Extract''' (decompress) the downloaded archive to a directory called <code>ckeditor</code> in the root of your website.
  
−
=== Upgrade installation ===
+
<note>You can place the files in any path of your website. The <code>ckeditor</code> directory is the default one.
−
# Rename your old editor folder to a backup, as e.g. "ckeditor_old"
+
</note>
−
# '''Extract''' (decompress) the downloaded file to the original editor directory, e.g. "ckeditor"
 
−
# Copy all configuration files that '''you have changed''' to their corresponding position in the new directory, these could includes but not limit to the following files:
 
−
* config.js
 
−
* content.css
 
−
* plugins/templates/templates/default.js
 
−
* plugins/styles/styles/default.js
 
−
* plugins/styles/styles/default.js
 
−
* plugins/pastefromword/filter/default.js
 
  
−
== Verify the installation ==
 
  
−
The editor comes with a few sample pages that can be used to verify that installation proceeded properly. Take a look at the _samples directory.  
+
=== Upgrade ===
 +
To upgrade an existing CKEditor installation, proceed in the following way:
 +
# '''Rename''' your old editor folder to a backup folder, for example <code>ckeditor_old</code>.
 +
# '''Download''' the latest version of the editor from our website: http://ckeditor.com/download
 +
# '''Extract''' (decompress) the downloaded archive to the original editor directory, for example <code>ckeditor</code>.
 +
# '''Copy''' all configuration files that '''you have changed''' from the backup folder to their corresponding position in the new directory. These could include (but do not have to be limited to) the following files:
 +
#* <code>config.js</code>
 +
#* <code>contents.css</code>
 +
#* <code>plugins/templates/templates/default.js</code>
 +
#* <code>plugins/styles/styles/default.js</code>
 +
#* <code>plugins/pastefromword/filter/default.js</code>
  
−
To test your installation just call the following page at your web site:
+
== Verification of the Installation ==
−
<pre>http://&lt;your site&gt;/&lt;CKEditor installation path&gt;/_samples/index.html
+
CKEditor comes with a few sample pages that can be used to verify that installation proceeded properly. In order to see whether the editor is working, take a look at the <code>_samples</code> directory.  
  
−
For example:
+
To test your installation, call the following page at your website:<br />
−
http://www.example.com/ckeditor/_samples/index.html
+
<code><nowiki>http://<</nowiki><em>your site</em><nowiki>>/<</nowiki><em>CKEditor installation path</em><nowiki>>/_samples/index.html</nowiki></code>
−
</pre>
+
 
 +
For example:<br />
 +
<code><nowiki>http://www.example.com/ckeditor/_samples/index.html</nowiki></code>
 +
 
 +
== Minimum Setup ==
 +
If you would like to tailor your CKEditor installation to your own needs, stripping some of the files that you are not going to use, refer to the [[CKEditor 3.x/Developers Guide/Minimum Setup|Minimum Setup]] section of the Developer's Guide.

Latest revision as of 09:18, 18 January 2012

Installing CKEditor is easy. In order to install the editor, choose an appropriate procedure (fresh install or upgrade) and follow the steps described below.

Installation Procedures

Fresh Installation

To install CKEditor for the first time, proceed in the following way:

  1. Download the latest version of the editor from our website: http://ckeditor.com/download
  2. Extract (decompress) the downloaded archive to a directory called ckeditor in the root of your website.
important note

You can place the files in any path of your website. The ckeditor directory is the default one.


Upgrade

To upgrade an existing CKEditor installation, proceed in the following way:

  1. Rename your old editor folder to a backup folder, for example ckeditor_old.
  2. Download the latest version of the editor from our website: http://ckeditor.com/download
  3. Extract (decompress) the downloaded archive to the original editor directory, for example ckeditor.
  4. Copy all configuration files that you have changed from the backup folder to their corresponding position in the new directory. These could include (but do not have to be limited to) the following files:
    • config.js
    • contents.css
    • plugins/templates/templates/default.js
    • plugins/styles/styles/default.js
    • plugins/pastefromword/filter/default.js

Verification of the Installation

CKEditor comes with a few sample pages that can be used to verify that installation proceeded properly. In order to see whether the editor is working, take a look at the _samples directory.

To test your installation, call the following page at your website:
http://<your site>/<CKEditor installation path>/_samples/index.html

For example:
http://www.example.com/ckeditor/_samples/index.html

Minimum Setup

If you would like to tailor your CKEditor installation to your own needs, stripping some of the files that you are not going to use, refer to the Minimum Setup section of the Developer's Guide.

Retrieved from "https://docs-old.ckeditor.com/index.php?title=CKEditor_3.x/Developers_Guide/Installation&oldid=6807"
This page was last edited on 18 January 2012, at 09:18.