Skip to content

Latest commit

 

History

History
181 lines (131 loc) · 7.56 KB

README.md

File metadata and controls

181 lines (131 loc) · 7.56 KB

Build Status PHP master Build Status Node master Code Coverage License

FileGator - Powerful Multi-User File Manager

FileGator is a free, open-source, self-hosted web application for managing files and folders.

You can manage files inside your local repository folder (on your server's hard drive) or connect to other storage adapters (see below).

FileGator has multi-user support so you can have admins and other users managing files with different access permissions, roles and home folders.

All basic file operations are supported: copy, move, rename, edit, create, delete, preview, zip, unzip, download, upload.

If allowed, users can download multiple files or folders at once.

File upload supports drag&drop, progress bar, pause and resume. Upload is chunked so you should be able to upload large files regardless of your server configuration.

Screenshot

Sponsors & Backers

FileGator is a free, open-source project. It's an independent project with its ongoing development made possible entirely thanks to the support by these awesome backers. If you'd like to join them, please consider:

Demo with docker

docker run -p 8000:80 -d filegator/filegator
visit: http://127.0.0.1:8000 login as admin/admin123

Typical use cases

  • share a folder with colleagues, your team, friends or family
  • give students access to upload their work
  • allow workers to upload field data / docs / images
  • use as cloud backup
  • manage cdn with multiple people
  • use as ftp/sftp replacement
  • manage s3 or other 3rd party cloud storage
  • use to quickly zip and download remote files

Documentation

Check out the documentation

Features & Goals

  • Multiple storage adapters (Local, FTP, Amazon S3, Dropbox, DO Spaces, Azure Blob and many others via Flysystem)
  • Multiple auth adapters with roles and permissions (Store users in json file, database or use WordPress)
  • Multiple session adapters (Native File, Pdo, Redis, MongoDB, Memcached and others via Symfony)
  • Single page front-end (built with Vuejs, Bulma and Buefy)
  • Chunked uploads (built with Resumable.js)
  • Zip and bulk download support
  • Highly extensible, decoupled and tested code
  • No database required
  • Framework free

Limitations

  • Symlinks are not supported by the underlying Flysystem
  • File permission operations are not supported (chmod/chown)

Minimum Requirements

  • PHP 7.2.5+ (with php-zip extension)

See install instructions for Ubuntu 18.04 or Debian 10.3. Get $100 in (server credits here) so you can play around.

Download precompiled build

Precompiled build is created for non-developers. In this version, the frontend (html, css and javascript) is compiled for you and the source code is removed so the final archive contains only minimum files.

Download & install instructions

Project setup for development (Linux)

You must have git, php, npm, and composer installed.

git clone https://github.com/filegator/filegator.git
cd filegator
cp configuration_sample.php configuration.php
chmod -R 775 private/
chmod -R 775 repository/
composer install --ignore-platform-reqs
npm install
npm run build

Compiles and hot-reloads

The following command will launch backend and frontend on ports 8081 and 8080:

npm run serve

Once everything is ready visit: http://localhost:8080

Run tests & static analysis

Testing requires xdebug, php-zip and sqlite php extensions.

vendor/bin/phpunit
vendor/bin/phpstan analyse ./backend
npm run lint
npm run e2e

Deployment

Set the website document root to filegator/dist directory. This is also known as 'public' folder.

NOTE: For security reasons filegator/dist is the ONLY folder you want to be exposed through the web. Everything else should be outside of your web root, this way people can’t access any of your important files through the browser. If you run the script from the root folder, you will see the message 'Development mode' as a security warning.

Show your support

Please ⭐️ this repository if this project helped you!

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

License

Copyright (c) 2019 Milos Stojanovic.

This project is MIT licensed.