Skip to content

A BrowserCMS module that adds file upload/browsing capability to CKEditor using the KCFinder project.

License

Notifications You must be signed in to change notification settings

browsermedia/bcms_kcfinder

Repository files navigation

KCFinder Module

This project is a BrowserCMS which integrates the KCFinder module with BrowserCMS. KCFinder enhances CKEditor to allow users to browse the server to find files, images and links to pages. KCFinder is an open source alternative to the commercial CKFinder module.

This module replaces the existing KCFinder PHP code for handling uploads and uses Rails to handle all server side code. This is not a general purpose Rails module, as the upload structure is designed to store files using BrowserCMS's Content API.

Features

  • Users can browse for links which will show Pages, Files and Images in a single Sitemap tree.
  • Users can select a section and see all assets
  • Can browse sections in sitemap
  • Users can select a page or file and link to it.
  • Users can browse for images and add them.
  • Icons work for most common types.
  • Can upload and link to files
  • Can upload and link to images

Installation

$ rails g cms:install bcms_kcfinder

When you start your server, you should see 'Browse Server' links when linking or placing images.

Third Party Software

This project integrates the KCFinder project (http://kcfinder.sunhater.com/) which is released under the GPL/LGPL license. See vendor/assets/javascript/kcfinder/doc/README for more details.

For the purposes of integration, all PHP code has been removed leaving only client code, specifically the following directories:

  • doc
  • js
  • themes

Troubleshooting

If you have issues after installing this gem (i.e. the browse button doesn't appear), take the following steps.

$ rake tmp:clear

This will clear the local asset pipeline cache, which is necessary if you had cached/generated JS configuration files that used the stock ckeditor config.

Jquery versions

This has been updated to work with JQuery 1.9.1 and later, which removed several features this module was depending on. The fix was to add jquery-migrate-rails. This may cause issues if you are using an earlier version of jquery.

TODO

Things remaining to be implemented:

  • Unknown extensions return 404s (i.e. CSV, etc)
  • Removed all UI i18n since it was implemented in PHP and the CMS itself isn't i18n yet.

About

A BrowserCMS module that adds file upload/browsing capability to CKEditor using the KCFinder project.

Resources

License

Stars

Watchers

Forks

Packages

No packages published