This is an old revision of the document!
Advanced configuration
Most of the configuration is done from FileRun's control panel. However, there are additional configuration options that can be set by editing the file “customizables/config.php”. If the files does not exist, you can simply create it.
Note: The PHP file needs to start with <?php on the first line.
User Interface
| <php>$config['app']['ui']['custom_js_url'] = 'http://your-website/your.js';</php> | Add custom JavaScript code to the FileRun UI |
| <php>$config['app']['ui']['ReadMeFileName'] = “README”;</php> | Sets the name of the file that is used for displaying folder information. |
| <php>$config['app']['hidden_file_names'][] = “_*”;</php> | Hides files and folders who's names are starting with “_”, only in the regular user interface. You can add multiple configuration lines like this one, for various filename patterns. Hidden files and folders will still be visible and accessible via the API, WebDAV and apps. Hidden files and folders can be created and uploaded by users, even if they don't show in the list. Downloading a folder containing hidden files and folders, will not include these files. |
| <php>$config['app']['upload']['max_simultaneous'] = 5;</php> | Change the number of files FileRun is simultaneously uploading. The default number is 3. As a rule of thumb, the larger your files, the smaller this number, and vice-versa. |
| <php>$config['app']['labels']['default'] = 'color' => 'green', 'text' => 'APPROVED'], ['color' => 'orange', 'text' => 'PENDING'], ['color' => 'red', 'text' => 'REJECTED';</php> | These are the default labels, which can be customized as desired. |
| <php>$config['thumbs']['output_small_max_filesize'] = 8388608;</php> | By default, images smaller than 8MB are send directly to the browser instead of having a thumbnail generated. You can alter this limit. |
| <php>$config['thumbs']['output_small_max_filesize_without_size_check'] = 2097152;</php> | FileRun outputs the original photo to the browser if it's small in bytesize (see the above), but not even if it's large in resolution. This setting allows you to have FileRun skip the resolution check. |
| <php>$config['thumbs']['limit_file_size'] = 20971520;</php> | If the thumbnail generation requires image resizing, this limits the resizing only to files larger than 20971520 bytes (20MB). ImageMagick can take a lot of hardware resources while trying to process very large files. |
| <php>$config['app']['disable_sound_notification'] = true;</php> | Sets the default state of the sound notifications to off. |
Web links and E-mailing files
$config['app']['weblinks']['defaults']['expiry'] = $nextWeek→format('Y-m-d');</php>|Make weblinks expire by default after one week. For other time intervals, see http://php.net/manual/en/dateinterval.construct.php|
| <php>$config['app']['email']['dont_send_pass'] = true;</php> | Do not include the configured weblink passwords in the e-mailed links. Use this if you wish to provide the password in a separate message or using an alternative communication method. |
| <php>$config['app']['weblinks']['forcePasswords'] = true;</php> | Forces the users to set passwords to the created web links. |
| <php>$config['app']['email']['bcc_files'] = “example@address.com”;</php> | Send a BCC copy of all “Send by e-mail” messages to “example@address.com”. |
| <php>$config['app']['weblinks']['comments']['show'] = true;</php> | Display the comments users attached to files. |
| <php>$config['app']['weblinks']['comments']['hide_names'] = true;</php> | * Depends on the above. Hides the users names, so only their comments are displayed. |
| <php>$config['app']['weblinks']['comments']['hide_dates'] = true;</php> | * Depends on <php>$config['app']['weblinks']['comments']['show']</php>. Hides the dates of the users comments. |
| <php>$config['app']['weblinks']['disableShortURL'] = true;</php> | Disables the option of generating short links. |
| <php>$config['app']['weblinks']['force_download'] = [“html”, “txt”, “pdf”];</php> | Makes PDF, HTML and TXT files download when accessing a Web Link, instead of being opened inside the browser. |
| <php>$config['app']['weblinks']['audio_file_types'] = ['aac', 'aiff', 'm4a', “mp3”, “ogg”, “flac”, 'alac', “wav”, “mpg”, 'wma', 'mqa'];</php> | Defines the list of types of files that should be included when opening a Web Linked folders as audio playlist. The above is the default list of file types. |
| <php>$config['app']['weblinks']['logging']['downloads']['disable'] = true;</php> | Disables logging of downloads through Web Links. |
| <php>$config['app']['weblinks']['logging']['folder_access']['disable'] = true;</php> | Disables logging of accesses made to Web Linked folders. |
| <php>$config['app']['weblinks']['logging']['referrer']['disable'] = true;</php> | Disables logging of visitors' referrers on downloading Web Links. |
| <php>$config['app']['email']['enableWebLinkThreshold'] = 20971520;</php> | Send files by e-mail as Web Links if their sizes are higher than 20MB. The default value is 10485760 (10MB). |
| <php>$config['app']['weblinks']['useClientEmail'] = true;</php> | Force users to send files using their local e-mail programs instead of FileRun's own function. |
| <php>$config['app']['weblinks']['custom_url_shortener'] = 'http://your-site.com/yourls-api.php?signature=YOUR-SIGNATURE&action=shorturl&format=simple';</php> | Configure custom URL shortener. The example is based on Yourls (https://yourls.org). For shorteners which require the FileRun weblink address to be present in the URL, use the ### placeholder. |
| <php>$config['app']['email']['sendFromDefault'] = true;</php> | Have the files send by the users via e-mail be sent from the configured default e-mail address instead of the e-mail address of the sending user. |
Admin and security
| <php>$config['app']['signup']['unique_company'] = true;</php> | Force users to type a unique company name at registration. |
| <php>$config['app']['admin']['users']['delete']['skipHomeFolderSubCheck'] = true;</php> | Allows you to delete one user's home folder when you are deleting the user accounts, even if the user's home folder contains other users' home folders. We recommend you not to use this option, to avoid accidental file loss. |
| <php>$config['app']['login']['2step']['allow_user_control'] = false;</php> | Prevents users from enabling or disabling the 2-step verification for their accounts. |
| <php>$config['app']['login']['restrict_ip']['admin'] = “192.168.0.1”;</php> | Limit the access of user “admin” to IP address “192.168.0.1”. You can configure as many users as you want. The value can also be an array of multiple IP addresses (Example: ['192.168.0.1', '192.168.0.1']) |
| <php>$config['app']['login']['restrict_ip']['admin'] = “192.168.1.0/24”;</php> | Limit the access of user “admin” to IP address range “192.168.0.*” using a 24 bit subnet mask. There are three possible formats that can be used: 1. Wildcard format: 1.2.3.* 2. CIDR format: 1.2.3/24 OR 1.2.3.4/255.255.255.0 3. Start-End IP format: 1.2.3.0-1.2.3.255 |
| <php>$config['app']['api']['oauth2']['header_access_token_only'] = false;</php> | Allows the OAuth2 token to be provided via a POST OR GET variable (“access_token”) instead of the “Authorization” header. <br>Use this only for testing. |
| <php>$config['app']['logging']['skip_provide_download'] = true;</php> | It makes FileRun skip logging the “File downloaded by another user” action. This is useful when you have many users sharing the same home folder. |
| <php>$config['system']['email_notification']['logging']['expiration'] = 5;</php> | Sets the number of days FileRun keeps the e-mail notification logs to 5. The default setting is 2. |
| <php>$config['app']['email_notification']['basic_actions'] = ['space_quota_warning', 'shared_folder_available', 'receive_copy', 'receive_move', 'receive_upload', 'comment_received', 'provide_download', 'label_set'];</php> | These are the default actions FileRun is e-mailing users about when notifications are enabled. |
System
| <php>$config['path']['trash'] = '/path/with/write/permission/';</php> | Folder to store the trashed files and folders. If your trash folder is on a separate device/partition/file-system, you will probably want to set $config['system']['fm']['use_safe_move'] = true; otherwise you won't be able to delete folders to trash due to a PHP limitation. |
| <php>$config['path']['thumbnail_cache'] = '/path/with/write/permission/';</php> | Folder to store generated thumbnail data in. Make sure you use an absolute path and avoid an empty value at all costs, as it can lead to inadvertent data loss. |
| <php>$config['app']['metadata']['indexing']['web']['max_files'] = 50;</php> | Have FileRun index 50 media files in a single HTTP request. The default is 10. |
| <php>$config['app']['metadata']['disable_extraction'] = true;</php> | Disable the metadata extraction (media indexing) on file upload. |
| <php>$config['system']['db']['utf8_names'] = true;</php> | Force the MySQL connection to use UTF-8. |