Quick Start

Last updated: July 18th, 2018

Requirements

  • A web server with PHP support, for example:
  • PHP 7.x.x
  • PHP extensions are required:
    • php-mbstring
    • php-mcrypt
    • php-zip

Installation

We will give an example of installation on Apache server on Ubuntu operating system. The default document root for Apache is `/var/www/html` (Ubuntu 14.04 or later).

Unpack archive to any directory on your server:

unzip engine-fm.zip

Copy the contents to /var/www:

cp -a ./engine-fm/ ./html/ /var/www/

If you are copying to a location not owned by the current user then you should use `sudo`.

sudo cp -a ./engine-fm/ ./html/ /var/www/

Ultimately you will get the next structure of folders:

var/www
       /engine-fm
                 /runtime
                 /settings
                 /vendors
                 /app.php
       /html
            /engine-fm
                      /doc
                      /js
                      /styles
                      /.htaccess
                      /favicon.ico
                      /index.html
                      /server.php

Settings

The main configuration file location is `%application-dir%/engine-fm/settings/public.php`

Name Default Description
serverUrl . URL for server side of the application
storagePath %application-dir%/engine-fm/root Root of file storage
storageMaxSize 5 GB Maximum allowed size for storage
uploadMaxFileSize 1 MB Maximum allowed uploaded file size. Note that php.ini setting has precedence over this setting
maxNumberOfUploadFiles 5 Maximum number of files to upload
allowMimeTypes null (all allowed) or array of mime types Allowed mime types (for uploading)
denyMimeTypes null (all allowed) or array of mime types Denied mime types (for uploading)
icons See list in configuration file List of icons used by toolbar buttons and different mime file types
defaultIcon icon-doc Icon by default for unknown mime file type
hotKeys
openKey Enter Open a selected file
renameKey Alt+r Rename a selected file
permissionsKey Alt+p Set selected file permissions
copyKey Alt+c Copy selected file(s)
moveKey Alt+m Move selected file(s)
trashKey Delete Trash selected file(s)
removeKey Shift+Delete Remove selected file(s)
createFolderKey Alt+f Create a new folder
createHyperlinkKey Alt+h Create a new hyperlink
uploadKey Alt+u Upload file(s)
downloadKey Alt+d Download file(s)
searchKey Alt+s Search file(s)
switchLeftKey Ctrl+37 Switch on left panel
switchRightKey Ctrl+37 Switch on right panel
nextItemKey 40 (arrow to down) Select next file
prevItemKey 38 (arrow to up) Select prev file
firstItemKey 37-Ctrl (arrow to left without Ctrl) Select first file
lastItemKey 39-Ctrl (arrow to right without Ctrl) Select last file