CKEditor Installation
Edit this pageWarning: You are browsing the documentation for version 1.x which is not maintained anymore.
If some of your projects are still using this version, consider upgrading.
CKEditor Installation
The CKEditor source is not shipped with the bundle due to license restriction (GPL, LGPL and MPL) whereas the bundle relies on the MIT one which are not compatible together. To install CKEditor source, you can use the Composer script via the built-in Symfony command.
Composer Script
The easiest way to manage CKEditor installation and update is to integrate it at the middle of your composer routine (after the cache clear but before the assets installation).
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
{
"scripts": {
"symfony-scripts": [
"Incenteev\\ParameterHandler\\ScriptHandler::buildParameters",
"Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::buildBootstrap",
"Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::clearCache",
"FOS\\CKEditorBundle\\Composer\\CKEditorScriptHandler::install",
"Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::installAssets",
"Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::installRequirementsFile",
"Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::prepareDeploymentTarget"
],
"post-install-cmd": [
"@symfony-scripts"
],
"post-update-cmd": [
"@symfony-scripts"
]
}
}Symfony Command
1
$ php bin/console ckeditor:installBy default, the command downloads the latest CKEditor full release (samples
directory excluded) in the Resource/public directory of the bundle. Most of
the time, this is exactly what you want but the command allows you to do more.
Download Path
If you don't want to download CKEditor in the Resource/public directory of
the bundle, you can use a custom path (absolute):
1 2 3 4 5
{
"extra": {
"ckeditor-path": "/var/www/html/web/ckeditor"
}
}1
$ php bin/console ckeditor:install /var/www/html/web/ckeditorCKEditor Release
You can choose which CKEditor release (full, standard or basic) to download:
1 2 3 4 5
{
"extra": {
"ckeditor-release": "basic"
}
}1
$ php bin/console ckeditor:install --release=basicCKEditor Version
If your want a specific CKEditor version, you can use:
1 2 3 4 5
{
"extra": {
"ckeditor-tag": "4.6.0"
}
}1
$ php bin/console ckeditor:install --tag=4.6.0Silence Progress bars
While downloading files necessary for the install, a progress bar will be shown by default, if you would prefer hiding it, use one of these methods:
1 2 3 4 5
{
"extra": {
"ckeditor-no-progress-bar": "true"
}
}1
$ php bin/console ckeditor:install --no-progress-barClear Previous Installation
By default, the command will ask you what to do when there is a previous CKEditor installation detected but in non interactive mode, you can control automatically how to handle such case:
1 2 3 4 5
{
"extra": {
"ckeditor-clear": "drop"
}
}1 2 3 4 5 6 7
$ php bin/console ckeditor:install --clear=drop
$ php bin/console ckeditor:install --clear=keep
$ php bin/console ckeditor:install --clear=skip
`drop``: Drop the previous installation & install.
`keep``: Keep the previous installation & install by overriding files.
`skip``: Keep the previous installation & skip install.Path Exclusion
When extracting the downloaded CKEditor ZIP archive, you can exclude paths such as samples, adapters, whatever:
1 2 3 4 5 6 7 8
{
"extra": {
"ckeditor-exclude": [
"samples",
"adapters"
]
}
}1
$ php bin/console ckeditor:install --exclude=samples --exclude=adaptersProxy
If you're using a proxy, you can use the following environment variables:
1 2
$ export HTTP_PROXY=http://127.0.0.1:8080
$ export HTTPS_PROXY=http://127.0.0.1:8080You can also define if the request URI should be full with:
1 2
$ export HTTP_PROXY_REQUEST_FULLURI=true
$ export HTTPS_PROXY_REQUEST_FULLURI=trueReminder
The command has been well documented, if you want to check it out:
1
$ php bin/console ckeditor:install --help
