tools/elfinder/README.md

0001 elFinder
0002 ========
0003
0004 <pre>
0005       _ ______ _           _
0006      | |  ____(_)         | |
0007   ___| | |__   _ _ __   __| | ___ _ __
0008  / _ \ |  __| | | '_ \ / _` |/ _ \ '__|
0009 |  __/ | |    | | | | | (_| |  __/ |
0010  \___|_|_|    |_|_| |_|\__,_|\___|_|
0011 </pre>
0012
0013 elFinder is an open-source file manager for web, written in JavaScript using
0014 jQuery UI. Creation is inspired by simplicity and convenience of Finder program
0015 used in Mac OS X operating system.
0016
0017
0018 Features
0019 --------
0020
0021  * All operations with files and folders on a remote server (copy, move,
0022    upload, create folder/file, rename, etc.)
0023  * High performance server beckend and light client UI
0024  * Multi-root support
0025  * Local file system, MySQL, FTP volume storage drivers
0026  * Background file upload with Drag & Drop HTML5 support
0027  * List and Icons view
0028  * Kayboard shortcuts
0029  * Standart methods of file/group selection using mouse or keyboard
0030  * Move/Copy files with Drag & Drop
0031  * Archives create/extract (zip, rar, 7z, tar, gzip, bzip2)
0032  * Rich context menu and toolbar
0033  * Quicklook, preview for common file types
0034  * Edit text files and images
0035  * "Places" for your favorites
0036  * Calculate directory sizes
0037  * Thumbnails for image files
0038  * Easy to integrate with web editors (elRTE, CKEditor, TinyMCE)
0039  * Flexible configuration of access rights, upload file types, user interface
0040    and other
0041  * Extensibility
0042  * Simple client-server API based on JSON
0043
0044
0045 Requirements
0046 ------------
0047
0048 ### Client
0049  * Modern browser. elFinder was tested in Firefox 10, Internet Explorer 8+,
0050    Safari 5, Opera 11 and Chrome 15+
0051
0052 ### Server
0053  * Any web server
0054  * PHP 5.2+ (for thumbnails - mogrify utility or GD/Imagick module)
0055
0056
0057 3rd party connectors
0058 --------------------
0059  * [Python](https://github.com/Studio-42/elfinder-python)
0060  * [Django](https://github.com/mikery/django-elfinder)
0061  * [Ruby/Rails](https://github.com/phallstrom/el_finder)
0062  * [Java Servlet](https://github.com/Studio-42/elfinder-servlet)
0063  * [ASP.NET Integration](http://code.google.com/p/elfinderintegration/)
0064  * [elFinder .Net connector](http://elfinderconnectornet.codeplex.com/)
0065
0066
0067 Support
0068 -------
0069
0070  * [Homepage](http://elfinder.org)
0071  * [Wiki](https://github.com/Studio-42/elFinder/wiki)
0072  * [Issues](https://github.com/Studio-42/elFinder/issues)
0073  * [Forum](http://elfinder.org/forum/)
0074  * <dev@std42.ru>
0075
0076
0077 Authors
0078 -------
0079
0080  * Chief developer: Dmitry "dio" Levashov <dio@std42.ru>
0081  * Maintainer: Troex Nevelin <troex@fury.scancode.ru>
0082  * Developers: Alexey Sukhotin <strogg@yandex.ru>, Naoki Sawada <hypweb@gmail.com>
0083  * Icons: [PixelMixer](http://pixelmixer.ru), [Yusuke Kamiyamane](http://p.yusukekamiyamane.com)
0084
0085 We hope our tools will be helpful for you.
0086
0087
0088 License
0089 -------
0090
0091 elFinder is issued under a 3-clauses BSD license.
0092
0093 <pre>
0094 Copyright (c) 2009-2012, Studio 42
0095 All rights reserved.
0096
0097 Redistribution and use in source and binary forms, with or without
0098 modification, are permitted provided that the following conditions are met:
0099     * Redistributions of source code must retain the above copyright
0100       notice, this list of conditions and the following disclaimer.
0101     * Redistributions in binary form must reproduce the above copyright
0102       notice, this list of conditions and the following disclaimer in the
0103       documentation and/or other materials provided with the distribution.
0104     * Neither the name of the Studio 42 Ltd. nor the
0105       names of its contributors may be used to endorse or promote products
0106       derived from this software without specific prior written permission.
0107
0108 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
0109 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
0110 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
0111 DISCLAIMED. IN NO EVENT SHALL "STUDIO 42" BE LIABLE FOR ANY DIRECT, INDIRECT,
0112 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
0113 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
0114 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
0115 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
0116 OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
0117 ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0118 </pre>