Skip to main content

Installation

Frappe Drive can be installed using either Docker or Bench. For most users, Docker is the recommended option because it provides the quickest way to get a standalone Drive instance up and running.

If you’re planning to host multiple Frappe applications or require a multi-tenant setup, installing with Bench is the recommended approach.

Recommended

Use the Docker installation for evaluation and quick deployments. For production environments requiring multiple apps or tenants, use a Bench-based installation or deploy on Frappe Cloud.

Install Using Docker

Docker provides the fastest way to launch a standalone Frappe Drive instance with all required services preconfigured.

Step 1: Create a Project Directory

mkdir frappe-drive
cd frappe-drive

Step 2: Download Required Files

Download the Docker Compose configuration and initialization script:

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

Step 3: Start the Containers

docker compose up -d

Once the containers have started successfully, Frappe Drive will be available on your local deployment.

Install Using Bench

Bench installation provides a complete Frappe development environment and is suitable for production deployments, multi-app installations, and multi-tenant environments.

Step 1: Install Bench

Install Bench by following the official Frappe Framework installation guide.

Step 2: Download the Drive App

bench get-app drive

Step 3: Create a Site

bench new-site site.name

Step 4: Install Frappe Drive

bench install-app drive

Step 5: Install System Dependencies

Ubuntu / Debian

sudo apt install ffmpeg libmagic

macOS

brew install libmagic ffmpeg

Step 6: Start Bench

bench start

Step 7: Access Frappe Drive

Once Bench is running, open your browser and navigate to:

  • http://localhost:8000
  • http://<site-name>:8000

Choosing an Installation Method

Method Recommended For
Docker Quick setup, evaluation, and standalone deployments.
Bench Development, production deployments, multi-app environments, and multi-tenancy.

Related Topics

  • Docker Deployment
  • Bench Installation
  • Frappe Cloud
  • Self Hosting

Best Practices

  • Use Docker if you want to quickly evaluate Frappe Drive.
  • Choose Bench for production environments requiring multiple Frappe applications.
  • Install the required system packages before starting Drive when using Bench.
  • Place your Docker deployment behind a reverse proxy if exposing it publicly.
  • Keep your installation updated to receive the latest features and security improvements.
Rating: 0 / 5 (0 votes)