Frappe Docker

Docker images and orchestration for Frappe applications.

What is this?

This repository handles the containerization of the Frappe stack, including the application server, database, Redis, and supporting services. It provides quick disposable demo setups, a development environment, production-ready Docker images and compose configurations for deploying Frappe applications including ERPNext.

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 official documentation for frappe_docker is maintained in the docs/ folder in this repository.

If you are already familiar with Frappe, you can jump right into the different deployment methods and select the one best suited to your use case.

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 is to play in an already set up sandbox, in your browser, click the button below:

Key Features

Try on your environment

⚠️ Disposable demo only

This setup is intended for quick evaluation. Expect to throw the environment away. You will not be able to install custom apps to this setup. For production deployments, custom configurations, and detailed explanations, see the full documentation.

View Screenshots

Under the Hood

• Frappe Framework: A full-stack web application framework written in Python and Javascript. The framework provides a robust foundation for building web applications, including a database abstraction layer, user authentication, and a REST API.

• Frappe UI: A Vue-based UI library, to provide a modern user interface. The Frappe UI library provides a variety of components that can be used to build single-page applications on top of the Frappe Framework.

Production Setup

Managed Hosting

You can try Frappe Cloud, a simple, user-friendly and sophisticated open-source platform to host Frappe applications with peace of mind.

It takes care of installation, setup, upgrades, monitoring, maintenance and support of your Frappe deployments. It is a fully featured developer platform with an ability to manage and control multiple Frappe deployments.

Development setup

Docker

You need Docker, docker-compose and git setup on your machine. Refer Docker documentation. After that, run the following commands:

git clone https://github.com/frappe/hrms
cd hrms/docker
docker-compose up

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)

Documentation Links

Logo and Trademark Policy

Please read our Logo and Trademark Policy.

Getting Started

Deployment Methods

ARM64

Container Setup Overview

Development

Contributing

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

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.