Documentation

• Welcome
• FileRun homepage
• Changelog
• Get notified about updates
• Contact us

Install

• Requirements
• Install guides
• PHP configuration
• PHP compatibility/upgrade
• Troubleshooting
• Reverse proxies
• Securing FileRun

Configure

• Setting the time zone
• Enabling thumbnails and preview
• Troubleshooting thumbnails
• E-mail notification system
• File preview options
• File indexing
• Authentication integration
• 2FA - 2-step verification
• Google editor integration
• Advanced configuration

Customize

• File plugins
• Translating FileRun
• Custom CSS
• Custom event scripts

Feature Information

• Screenshot sharing
• File searching
• Desktop sync
• Metadata
• Guest users
• Mobile apps
• File-based activity logs
• WebDAV

The API

• Introduction
• • Getting user account information
  • Retrieving lists of files and folders
  • Retrieving metadata
  • Searching files and folders
  • Creating folders
  • Uploading files
  • Downloading files
  • Downloading thumbnails
  • Renaming files or folders
  • Moving files or folders
  • Extracting archives
  • Deleting files or folders
  • Starring files or folders
  • Create web links on files and folders
  • Removing web links
  • Sharing files and folders
  • Unsharing files and folders
  • Get FileRun user account information
  • Add FileRun user accounts
  • Modify FileRun user accounts
  • Delete FileRun user accounts

Maintenance

• Resetting the superuser password
• Updating FileRun
• Backing up the installation
• Changing MySQL connection information
• Deleting old user files
• Migrating to another server
• Command line tools

• Requirements
  • Web Server: Any (Apache/IIS/Nginx/etc.)
    • PHP
    • MySQL database (or MariaDB)
    • Optional
  • Operating system
  • Mobile and desktop sync

Requirements🔗

Web Server: Any (Apache/IIS/Nginx/etc.)🔗

PHP🔗

For details please see the PHP configuration page.

MySQL database (or MariaDB)🔗

• Minimum version: 8.0

Optional🔗

• To be able to handle files larger than 4GB in size, a 64 bit system is needed.
• Libvips or ImageMagick or GraphicsMagick - for thumbnails and image previews.
• FFmpeg - for thumbnails for video files.
• Java + Apache Tika + Elasticsearch - for full-text indexing and searching.

Operating system🔗

FileRun works great on all servers, Microsoft Windows included.

Mobile and desktop sync🔗

The FileRun server installation needs to have the API enabled from its control panel and access should be made via HTTPS with a trusted SSL certificate.