scripts/elfinder-2.0-rc1/README.md

   1 elFinder
   2 ========
   3
   4 <pre>
   5       _ ______ _           _
   6      | |  ____(_)         | |
   7   ___| | |__   _ _ __   __| | ___ _ __
   8  / _ \ |  __| | | '_ \ / _` |/ _ \ '__|
   9 |  __/ | |    | | | | | (_| |  __/ |
  10  \___|_|_|    |_|_| |_|\__,_|\___|_|
  11 </pre>
  12
  13 elFinder is an open-source file manager for web, written in JavaScript using
  14 jQuery UI. Creation is inspired by simplicity and convenience of Finder program
  15 used in Mac OS X operating system.
  16
  17
  18 Features
  19 --------
  20
  21  * All operations with files and folders on a remote server (copy, move,
  22    upload, create folder/file, rename, etc.)
  23  * High performance server beckend and light client UI
  24  * Multi-root support
  25  * Local file system, MySQL, FTP volume storage drivers
  26  * Background file upload with Drag & Drop HTML5 support
  27  * List and Icons view
  28  * Kayboard shortcuts
  29  * Standart methods of file/group selection using mouse or keyboard
  30  * Move/Copy files with Drag & Drop
  31  * Archives create/extract (zip, rar, 7z, tar, gzip, bzip2)
  32  * Rich context menu and toolbar
  33  * Quicklook, preview for common file types
  34  * Edit text files and images
  35  * "Places" for your favorites
  36  * Calculate directory sizes
  37  * Thumbnails for image files
  38  * Easy to integrate with web editors (elRTE, CKEditor, TinyMCE)
  39  * Flexible configuration of access rights, upload file types, user interface
  40    and other
  41  * Extensibility
  42  * Simple client-server API based on JSON
  43
  44
  45 Requirements
  46 ------------
  47
  48 ### Client
  49  * Modern browser. elFinder was tested in Firefox 10, Internet Explorer 8+,
  50    Safari 5, Opera 11 and Chrome 15+
  51
  52 ### Server
  53  * Any web server
  54  * PHP 5.2+ (for thumbnails - mogrify utility or GD/Imagick module)
  55
  56
  57 3rd party connectors
  58 --------------------
  59  * [Python](https://github.com/Studio-42/elfinder-python)
  60  * [Django](https://github.com/mikery/django-elfinder)
  61  * [Ruby/Rails](https://github.com/phallstrom/el_finder)
  62  * [Java Servlet](https://github.com/Studio-42/elfinder-servlet)
  63  * [ASP.NET Integration](http://code.google.com/p/elfinderintegration/)
  64  * [elFinder .Net connector](http://elfinderconnectornet.codeplex.com/)
  65
  66
  67 Support
  68 -------
  69
  70  * [Homepage](http://elfinder.org)
  71  * [Wiki](https://github.com/Studio-42/elFinder/wiki)
  72  * [Issues](https://github.com/Studio-42/elFinder/issues)
  73  * [Forum](http://elfinder.org/forum/)
  74  * <dev@std42.ru>
  75
  76
  77 Authors
  78 -------
  79
  80  * Chief developer: Dmitry "dio" Levashov <dio@std42.ru>
  81  * Maintainer: Troex Nevelin <troex@fury.scancode.ru>
  82  * Developers: Alexey Sukhotin <strogg@yandex.ru>, Naoki Sawada <hypweb@gmail.com>
  83  * Icons: [PixelMixer](http://pixelmixer.ru), [Yusuke Kamiyamane](http://p.yusukekamiyamane.com)
  84
  85 We hope our tools will be helpful for you.
  86
  87
  88 License
  89 -------
  90
  91 elFinder is issued under a 3-clauses BSD license.
  92
  93 <pre>
  94 Copyright (c) 2009-2012, Studio 42
  95 All rights reserved.
  96
  97 Redistribution and use in source and binary forms, with or without
  98 modification, are permitted provided that the following conditions are met:
  99     * Redistributions of source code must retain the above copyright
 100       notice, this list of conditions and the following disclaimer.
 101     * Redistributions in binary form must reproduce the above copyright
 102       notice, this list of conditions and the following disclaimer in the
 103       documentation and/or other materials provided with the distribution.
 104     * Neither the name of the Studio 42 Ltd. nor the
 105       names of its contributors may be used to endorse or promote products
 106       derived from this software without specific prior written permission.
 107
 108 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 109 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 110 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 111 DISCLAIMED. IN NO EVENT SHALL "STUDIO 42" BE LIABLE FOR ANY DIRECT, INDIRECT,
 112 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 113 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 114 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 115 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 116 OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 117 ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 118 </pre>