Frappe Drive

100% open source file storage, sharing, and collaboration

More screenshots

Website | Community | Documentation | Forum

Features

Core — the file manager

• Large file uploads using multi-part uploads
• Folder uploads to maintain your structure in Drive
• Access your files across multiple platforms
• Preview files directly in your browser, supported file previews
• Stream videos directly from the server
• Search for all your files and files shared shared with you
• View activity logs of a file to glance at the changes in permissions and file metadata
• Manage folders in list or grid view and sort them by preference
• Mark files as favorite and track your recently viewed files
• Tag files and folders for better organization
• Filter by tags or file kind
• Share files and folders with users, groups, everyone on the site or publish publicly
• Make user groups to collaborate quickly
• Invite other users by emailing them directly from Drive
• Work with guest users who have limited and controlled access to your site
• Get an overview of your storage
• Pool storage of all users together or assign a quota of storage to each user

Writer — the document editor

• Quickly write and share an idea directly from Drive
• The WYSIWYG editor supports markdown
• Collaborate with other users or guests in real time
• Annotate, resolve and reply to other users to give suggestions
• Manually version your documents to always be able to go back to a state
• Automatic versioning to make sure you never lose data
• Resize videos and images inside your document
• Import docx documents into the editor
• Export your documents in PDF
• The editor is page-less but you can add page breaks to make sure you get your desired output when printing

Warning

If you're self hosting Frappe Drive. Do not use the app as the only way to store your files. Always have backup strategy for your files.

Otherwise, consider our managed hosting on Frappe Cloud. It's the same exact code as from the main branch here, but with better support tooling and automated backups.

Installation

To set up the repository locally, follow the steps mentioned below:

Docker Compose [Recommended]

The quickest way to set up Frappe Drive and take it for a test drive.

Frappe framework is multi-tenant and supports multiple apps by default. This docker compose is just a standalone version with Frappe Drive pre-installed. Just put it behind your desired reverse-proxy if needed, and you're good to go.

If you wish to use multiple Frappe apps or need multi-tenancy. I suggest moving over to our production ready self-hosted workflow, or join us on Frappe Cloud to get first party support and hassle-free hosting.

Step 1: Setup folder and download the required files

mkdir frappe-drive
cd frappe-drive

Step 2: Download the required files

Docker Compose File:

wget -O docker-compose.yml https://raw.githubusercontent.com/frappe/drive/main/docker/docker-compose.yml

Frappe Drive Bench Setup Script

wget -O init.sh https://raw.githubusercontent.com/frappe/drive/main/docker/init.sh

Step 3: Run the container and daemonize it

docker compose up -d

Normal Bench Install

Install bench and set up a frappe-bench directory by following the installation steps.

Step 1: Install Bench.

Step 2: Provided bench is all set up you can proceed to install Frappe Drive

bench get-app drive --branch main

Step 3: Install some Drive specific system packages

Ubuntu/Debian (apt based distros)

sudo apt install ffmpeg libmagic

MacOs

brew install libmagic ffmpeg

Step 4: Install drive once it's downloaded

bench install-app drive

Step 5: Start bench if it's not already running

bench start

Frappe Drive should be accessible at localhost:8000 or sitename:8000

Contributions and Community

There are many ways you can contribute even if you don't code:

1. You can start by giving a star to this repository!
2. If you find any issues, even if it is a typo, you can raise an issue to inform us.

License

GNU Affero General Public License v3.0