What is this?

This repository is the official container setup for Frappe applications.

It provides Docker images, Compose configurations, and documentation for running Frappe applications, including ERPNext, CRM, Helpdesk, and other Frappe apps, in containers.

Use it if you want to:

• run ERPNext, CRM, Helpdesk, or other Frappe apps with Docker
• start from a quick demo setup
• use production-ready Docker images and Compose setups
• build custom app images
• deploy and operate Frappe in production

Repository Structure

frappe_docker/
├── docs/                 # Complete documentation
├── overrides/            # Docker Compose configurations for different scenarios
├── compose.yaml          # Base Compose File for production setups
├── pwd.yml               # Single Compose File for quick disposable demo
├── images/               # Dockerfiles for building Frappe images
├── development/          # Development environment configurations
├── devcontainer-example/ # VS Code devcontainer setup
└── resources/            # Helper scripts and configuration templates

This section describes the structure of this repository, not the Frappe framework itself.

Key Components

• docs/ - Canonical documentation for all deployment and operational workflows
• overrides/ - Opinionated Compose overrides for common deployment patterns
• compose.yaml - Base compose file for production setups (production)
• pwd.yml - Disposable demo environment (non-production)

Documentation

The full frappe_docker documentation is available in docs/ and published at frappe.github.io/frappe_docker.

Documentation is gradually being organized into Tutorials, How-to Guides, Reference, and Explanation. The category indexes explain each category's purpose. To help, see the documentation contribution guide.

Recommended entry points:

• New here: Getting Started Guide
• Choosing a setup: Deployment methods
• ARM64 notes: ARM64
• Container setup overview: Container Setup Overview
• Running in production: Deployment how-to guides
• Operating a deployment: Operations docs
• Development workflows: Development
• FAQ: Frequently Asked Questions

Prerequisites

• Docker
• Docker Compose v2
• git

For Docker basics and best practices refer to Docker's documentation

Demo setup

The fastest way to try Frappe locally is with the single-file demo setup in pwd.yml.

Try on your environment

⚠️ Disposable demo only

This setup is intended for short-lived evaluation only. You will not be able to install custom apps to this setup. For production deployments, custom configurations, and detailed explanations, see the full documentation.

First clone the repo:

git clone https://github.com/frappe/frappe_docker
cd frappe_docker

Then run:

docker compose -f pwd.yml up -d

Wait for a couple of minutes for ERPNext site to be created or check create-site container logs before opening browser on port 8080. (username: Administrator, password: admin)

Contributing

Contributions are welcome! Please see CONTRIBUTING.md for guidelines.

See the repository versioning policy for release classification, compatibility boundaries, and build-tool minimum changes.

This repository is only for container related stuff. You also might want to contribute to:

Resources

• Frappe framework,
• ERPNext,
• Frappe Bench.

License

This repository is licensed under the MIT License. See LICENSE for details.