If you plan to use the full-text searching feature, please use this guide instead.

Setting up on Synology DSM? Check out this guide.

This guide assumes you have Docker and docker-compose installed on a server with at least 1GB of RAM memory.

Start by pulling the Docker image:

docker pull afian/filerun

Then create a text file named docker-compose.yml and paste the following inside:

version: '2'

services:
  db:
    image: mariadb:10.1
    environment:
      MYSQL_ROOT_PASSWORD: your_mysql_root_password
      MYSQL_USER: your_filerun_username
      MYSQL_PASSWORD: your_filerun_password
      MYSQL_DATABASE: your_filerun_database
    volumes:
      - /filerun/db:/var/lib/mysql

  web:
    image: afian/filerun
    environment:
      FR_DB_HOST: db
      FR_DB_PORT: 3306
      FR_DB_NAME: your_filerun_database
      FR_DB_USER: your_filerun_username
      FR_DB_PASS: your_filerun_password
      APACHE_RUN_USER: www-data
      APACHE_RUN_USER_ID: 33
      APACHE_RUN_GROUP: www-data
      APACHE_RUN_GROUP_ID: 33
    depends_on:
      - db
    links:
      - db:db
    ports:
      - "80:80"
    volumes:
      - /filerun/html:/var/www/html
      - /filerun/user-files:/user-files

Please note the above volumes configuration. There are two folders you need to configure. One for the FileRun application files. It can be located in any empty folder and must have the mount path set to /var/www/html and one for the FileRun user files, with the mount path set to /user-files. In other words, if you use the above configuration text as it is, you just need to create two empty folders, /filerun/html and /filerun/user-files and you can starting the FileRun Docker container up:

mkdir /filerun/html /filerun/user-files

And start FileRun up using the following command:

docker-compose up -d

FileRun should be now up and running and you can access it with your browser.

The default FileRun credentials are as follows:

* Username: superuser

* Password: superuser