Installation instructions

Installation

  1. Download latest Roxy Fileman version.
  2. Extract the archive.
  3. Upload Fileman folder to your site.
  4. Edit conf.json to finish your setup. See Configuration section for details.

To configure CKEditor to use Fileman as file and image browser, see CKEditor configuration. To configure TinyMCE to use Fileman as file and image browser, see TinyMCE configuration. For integration with any other web application see custom integration.

IMPORTANT – PHP!
Roxy Fileman requires PHP 5.2 or greater with GD and MB String libraries installed.
Security checks are implemented, but you have to fill "checkAccess()" function located in fileman/php/security.inc.php file in order to actually restrict the access. Usually this is pretty simple, it could be something like "if($_SESSION['is_admin_logged'] !== true)exit;". 
You can also use HTTP Basic authentication or any other authentication mechanism you want. See Roxy Fileman security for more details.

IMPORTANT – .NET!
Roxy Fileman requires .NET 4.5, but can run on .NET 2+ with minor modifications – see FAQ for more details.
.NET users have to map .json extension as static content in IIS configuration. 
All C# code is in one file which is generic web handler (.ashx) – see if you need to register it.
To implement security, you can enable user authentication in web.config file.
 

Configuration

Roxy Fileman comes preconfigured and ready to use. However you will probably want to change the directory which will be accessible by the file browser and where new files will be uploaded. The configuration file is in JSON format and cannot contain any comments!

All settings which are not set or are empty will disable given feature. For example if you want to disable file uploads, just set UPLOAD to empty string – "UPLOAD": "".
 

Configuration options:

FILES_ROOT – This is the folder which can be browsed and where the new files will be ulpoaded. The path must be absolute from your site root! The default value is "" – in this case "fileman/Uploads" will be used. Check the directory permissions! In .NET version the path will be resolved from the applicaation root e.q. ~/files

New setting RETURN_URL_PREFIX – Prefix to use when URL is returned to CKEditor or TinyMCE. This setting could be used to set the full URL of the resource.

New setting SESSION_PATH_KEY – This is key of the session variable to assign to FILES_ROOT. If not set or session variable is empty, FILES_ROOT is set as explained above.

New setting THUMBS_VIEW_WIDTH – Required. Width of images in the thumbnail view. Default is 140.

New setting THUMBS_VIEW_HEIGHT – Required. Height of images in the thumbnail view. Default is 120 .

New setting PREVIEW_THUMB_WIDTH – Required. Width of the image preview. Default is 300.

New setting PREVIEW_THUMB_HEIGHT – Required. Height of the image preview. Default is 200.

New setting MAX_IMAGE_WIDTH – If set uploaded images will be resized to this width maintaining aspect ratio. Default is 1000. To disable resizing set both MAX_IMAGE_WIDTH and MAX_IMAGE_HEIGHT to 0.

New setting MAX_IMAGE_HEIGHT – If set uploaded images will be resized to this height maintaining aspect ratio. Default is 1000. To disable resizing set both MAX_IMAGE_WIDTH and MAX_IMAGE_HEIGHT to 0.

INTEGRATION – Roxy Fileman is developed to work with CKEditor and TinyMCE. For integration with CKEditor set this to "ckeditor", for TinyMCE 3.x set "tinymce3", for TinyMCE 4.x set "tinymce4". For custom implementation set  "custom", then fill "FileSelected()" function located in fileman/js/custom.js – for more details see "Roxy Fileman custom integration". The default value is "custom". This setting could be overriden by sending URL parameter "integration" when openning the file browser.

DIRLIST – Required. Path to the script which outputs directory tree structure. Default is "php/dirtree.php".

CREATEDIR – Path to the script for processing create folder requests. Default is "php/createdir.php".

DELETEDIR – Path to the script for processing delete folder requests. Default is "php/deletedir.php".

MOVEDIR – Path to the script for processing folder move requests. Default is "php/movedir.php".

COPYDIR – Path to the script for processing copy folder requests. Default is "php/copydir.php".

RENAMEDIR – Path to the script for processing rename folder requests. Default is "php/renamedir.php".

FILESLIST – Path to the script which outputs list of files in the selected folder. Default is "php/fileslist.php".

UPLOAD – Path to the script for processing file uploads. Default is "php/upload.php".

DOWNLOAD – Path to the script which forces selected file to be recieved as a download, instead of opening it with the default application. Default is "php/download.php".

New setting DOWNLOADDIR – Path to the script for zipping directory. The default is "php/downloaddir.php".

DELETEFILE – Path to the script for processing delete file requests. Default is "php/deletefile.php".

MOVEFILE – Path to the script for processing move file requests. Default is "php/movefile.php".

COPYFILE – Path to the script for processing copy file requests. Default is "php/copyfile.php".

RENAMEFILE – Path to the script for processing rename file requests. Default is "php/renamefile.php".

GENERATETHUMB – Path to the script which generates thumbnails for the preview tooltip and thumbnail view. Default is "php/thumb.php".

DEFAULTVIEW – The default view when Fileman is opened. Possible values are "list"(default) and "thumb".

FORBIDDEN_UPLOADS – Space separated list of file extensions that are forbidden for upload. This list is also checked when file is renamed. Default value is "zip js jsp jsb mhtml mht xhtml xht php phtml php3 php4 php5 phps shtml jhtml pl sh py cgi exe application gadget hta cpl msc jar vb jse ws wsf wsc wsh ps1 ps2 psc1 psc2 msh msh1 msh2 inf reg scf msp scr dll msi vbs bat com pif cmd vxd cpl htpasswd htaccess".

ALLOWED_UPLOADS – Space separated list of allowed file extensions. Set this if you want to allow only certain file type uploads. This list is also checked when file is renamed. Default is "".

FILEPERMISSIONS – Permissions for uploaded files. Default is "0644".

DIRPERMISSIONS – Permissions for new folders "0755".

LANG – User interface language. Two letter language code or "auto". Roxy Fileman translate engine will try to load language file located in fileman/lang/{you_language_code}.js, if the file is not found the english language is loaded. When set to "auto" Fileman will use the browser's language to locate the language file if available. Default is "auto".

When Fileman is used with CKEditor or TinyMCE and LANG is set to "auto", the editor's language setting will be inherited.

This setting could be overriden dinamically by sending "langCode" in the URL, in this case LANG must be set to "auto". E.q. fileman/index.html?langCode=it – language is set to Italian and fileman/lang/it.json translation file is loaded.

DATEFORMAT – Date and time format used to show file modification time. jquery-dateFormat plugin is used to format dates, see https://github.com/phstc/jquery-dateFormat for format options available.

New setting OPEN_LAST_DIR –  If set to "yes", Roxy Fileman will reopen the last browsed folder. Value: yes/no, the default is "yes".

Date and time patterns:

yy = short year
yyyy = long year
M = month (1-12)
MM = month (01-12)
MMM = month abbreviation (Jan, Feb ? Dec)
MMMM = long month (January, February ? December)
d = day (1 – 31)
dd = day (01 – 31)
ddd = day of the week in words (Monday, Tuesday ? Sunday)
D – Ordinal day (1st, 2nd, 3rd, 21st, 22nd, 23rd, 31st, 4th?)
h = hour in am/pm (0-12)
hh = hour in am/pm (00-12)
H = hour in day (0-23)
HH = hour in day (00-23)
mm = minute
ss = second
SSS = milliseconds
a = AM/PM marker
p = a.m./p.m. marker