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

• FileRun Server Install Guides
  • Manual installation on a any web server
  • Installation using Docker
  • Platform specific installation guides
• Other guides
  • (Outdated) Docker guides
  • (Outdated) Ubuntu guides
  • (Outdated) Debian guides
  • (Outdated) Centos guides
  • (Outdated) Synology guides
  • (Outdated) Unraid guides
  • Other outdated guides

FileRun Server Install Guides🔗

• Choosing a hosting server guide

Manual installation on a any web server🔗

• Manual installation
• Using cPanel

Installation using Docker🔗

• Basic Docker install
• With full-text search

Platform specific installation guides🔗

• Unraid, via Community App
• Unraid, manually
• Synology DSM - Docker

Other guides🔗

The latest FileRun version requires PHP 8.1+ and the free version is no longer available. For this reason, the guides below are outdated. However, they can still be used for reference, remembering that PHP needs a different version and the FileRun installation package is now being downloaded only from the client account.

(Outdated) Docker guides🔗

• Portainer + NPM, on Linode Video guide
• Adding SSL with Docker - using NPM (Nginx Proxy Manager)
• Comprehensive Docker install
• multiple Linux distros, with full-text search, and SSL via Nginx reverse proxy:
  • Chinese version
  • German version
• On Raspberry Pi
• On Raspberry Pi 64bit

(Outdated) Ubuntu guides🔗

• Ubuntu 20 - Apache (Spanish)
• Ubuntu 20 - NGINX
• Ubuntu 22 - Apache + SSL

(Outdated) Debian guides🔗

• Debian 11 - LAMP

(Outdated) Centos guides🔗

• CentOS 8 - Apache + PHP 7.4 FPM
• CentOS 7 - Apache + PHP 7.4 FPM

(Outdated) Synology guides🔗

• Synology DSM - Web Station
• Synology + Docker + Portainer

(Outdated) Unraid guides🔗

• Unraid - Docker (discussion)

Other outdated guides🔗

• OpenMediaVault - Docker (Note: the new Docker image is filerun/filerun:8.1)
• TrueNAS - FreeBSD with Caddy