| .github | ||
| .vscode | ||
| devcontainer-example | ||
| development | ||
| docs | ||
| images | ||
| overrides | ||
| resources | ||
| tests | ||
| .dockerignore | ||
| .editorconfig | ||
| .gitignore | ||
| .pre-commit-config.yaml | ||
| .shellcheckrc | ||
| bench.sh | ||
| CODE_OF_CONDUCT.md | ||
| compose.yaml | ||
| CONTRIBUTING.md | ||
| docker-bake.hcl | ||
| example.env | ||
| install_x11_deps.sh | ||
| LICENSE | ||
| pwd.yml | ||
| README.md | ||
| requirements-test.txt | ||
| setup.cfg | ||
Frappe Docker
Everything about Frappe and ERPNext in containers.
Production-ready containerized setup for Frappe and ERPNext applications. This repository provides Docker images and deployment configurations for running Frappe/ERPNext in both development and production environments.
Table of Contents
- Overview
- Prerequisites
- Quick Start
- Deployment Options
- Architecture
- Common Tasks
- Configuration
- Troubleshooting
- Contributing
Overview
Frappe Docker provides a complete containerized solution for deploying the Frappe framework and ERPNext ERP system. It includes:
- Pre-built Docker images for Frappe and ERPNext (versions 13, 14, and 15)
- Multiple deployment configurations (development, production, single-server)
- Docker Compose setups for easy orchestration
- Support for custom apps and extensions
- Built-in backup and restore capabilities
- TLS/SSL support via Traefik reverse proxy
- Multi-tenancy support with port-based routing
- Development containers with VSCode integration
Prerequisites
Before you begin, ensure you have:
- Docker (v20.10+) - Installation Guide
- Docker Compose (v2.0+) - Installation Guide
- Git - Installation Guide
- System Requirements:
- Minimum 4GB RAM (8GB recommended for production)
- 20GB free disk space
- Linux, macOS, or Windows with WSL2
Quick Start
Choose one of the following options to get started quickly:
Option 1: Try in Browser (Play With Docker)
Click below to instantly spin up a Frappe/ERPNext instance in your browser:
Try on your Dev environment
First clone the repo:
git clone https://github.com/frappe/frappe_docker
cd frappe_docker
Then run: docker compose -f pwd.yml up -d
To run on ARM64 architecture follow this instructions
After you clone the repo and cd frappe_docker, run this command to build multi-architecture images specifically for ARM64.
docker buildx bake --no-cache --set "*.platform=linux/arm64"
and then
- add
platform: linux/arm64to all services in thepwd.yml - replace the current specified versions of erpnext image on
pwd.ymlwith:latest
Then run: docker compose -f pwd.yml up -d
Final steps
Wait for 5 minutes for ERPNext site to be created or check create-site container logs before opening browser on port 8080. (username: Administrator, password: admin)
If you ran in a Dev Docker environment, to view container logs: docker compose -f pwd.yml logs -f create-site. Don't worry about some of the initial error messages, some services take a while to become ready, and then they go away.
Documentation
Frequently Asked Questions
Production
- List of containers
- Single Compose Setup
- Environment Variables
- Site Operations
- Custom Apps
- Development Guide
- Troubleshooting
Production Deployment
- Single Server Example
- Setup Options
- Backup and Push Cron Job
- Port Based Multi Tenancy
- TLS for local deployment
- Migrate from multi-image setup
Development
Customization
Contributing
We welcome contributions! Please see CONTRIBUTING.md for guidelines.
Related Projects
- Frappe Framework - Full-stack web framework
- ERPNext - Open source ERP
- Frappe Bench - CLI tool for Frappe deployments
Support
License
This project is licensed under the MIT License - see the LICENSE file for details.