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
• Server optimization

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
• Mobile apps
• File-based activity logs
• WebDAV

The API

• Introduction
• API Methods

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

• API methods
  • Migrating from an older version
  • User info methods
  • Files methods
  • Other methods

API methods🔗

Migrating from an older version🔗

The first API changes were introduced with the FileRun version 2026.1.0. To migrate, please use this guide.

User info methods🔗

• Getting user account information

Files methods🔗

• 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

Other methods🔗

• Get FileRun user account information
• Add FileRun user accounts
• Modify FileRun user accounts
• Delete FileRun user accounts