Docker environment for developing, deploying, and running Frappe applications (ERPNext and custom apps) in production and development
Find a file
2025-06-26 17:05:01 +02:00
.github Delete .github/workflows/pre-commit.yml 2025-06-26 17:05:01 +02:00
.vscode style: [prettier] Autoformat code via pre-commit hook 2025-06-24 23:44:41 +02:00
devcontainer-example Update docker-compose.yml (#1415) 2024-06-25 10:36:25 +05:30
development fix: remove comments to satisfy JSON linting 2025-06-24 23:41:22 +02:00
docs chore: Update EOL NodeJS to 20.19.2 (#1638) 2025-05-29 17:33:28 +05:30
images chore: Update EOL NodeJS to 20.19.2 (#1638) 2025-05-29 17:33:28 +05:30
overrides chore: update instructions 2025-06-24 17:09:57 +02:00
resources fix: pwd SocketIO Origin in nginx conf (#1552) 2025-01-24 12:36:30 +05:30
scripts style: [prettier] Autoformat code via pre-commit hook 2025-06-24 23:44:41 +02:00
tests fix: tests 2024-12-10 16:26:59 +05:30
.dockerignore Global refactoring (#617) 2022-03-14 11:23:03 +05:30
.editorconfig chore: Use pre-commit framework (#604) 2021-12-10 11:48:00 +03:00
.gitignore fix: gitignore (#1391) 2024-05-01 12:25:49 +05:30
.pre-commit-config.yaml chore: add hooks and updated versions 2025-06-24 19:44:45 +02:00
.shellcheckrc chore(lint): Take hooks configs out so linting works without pre-commit too (#609) 2021-12-10 12:31:44 +03:00
.yamllint ci: add yamllint 2025-06-24 19:37:50 +02:00
apps.json chore: update instructions 2025-06-24 17:09:57 +02:00
CODE_OF_CONDUCT.md #1402 Environment variables for custom image (#1403) 2024-06-08 00:21:17 +05:30
compose.yaml Compose with restart (#1567) 2025-02-15 12:03:57 +05:30
CONTRIBUTING.md ci: refactor (#1158) 2023-06-26 11:54:37 +05:30
docker-bake.hcl ci: push frappe or erpnext branch as tag (#1508) 2024-11-11 11:52:27 +05:30
example.env chore: Update example.env 2025-06-19 17:06:12 +00:00
install_x11_deps.sh Cypress UI Test service and updates to installer.py (#1250) 2023-10-26 08:35:31 +05:30
LICENSE chore: Rename LICENSE.md to LICENSE (#608) 2021-12-10 16:25:57 +05:30
msg-map.json ci: add msg-map.json 2025-06-24 19:36:38 +02:00
package.json feat(ci): add conventional commit type 2025-06-26 16:12:02 +02:00
pwd.yml chore: Update example.env 2025-06-19 17:06:12 +00:00
README.md style: apply automatic lint fixes via pre-commit 2025-06-24 19:23:55 +02:00
requirements-test.txt chore(deps): bump pytest from 8.3.5 to 8.4.0 (#1644) 2025-06-09 07:53:27 +05:30
setup.cfg Use pytest (#705) 2022-03-24 10:40:56 +03:00
stack.sh style: apply automatic lint fixes via pre-commit 2025-06-24 19:23:55 +02:00

frappe docker (digikwal fork)

Digikwal fork Semantic Release

frappe docker upstream

Build Stable Build Develop

Everything about Frappe and ERPNext in containers.

First things first

I recommend adding the following to bashrc, profile or whatever loads on login, ssh etc..:

export APPS_JSON_BASE64=$(base64 -w 0 /home/frappe/frappe_docker/apps.json)

Getting Started

To get started you need Docker, docker-compose, and git setup on your machine. For Docker basics and best practices refer to Docker's documentation.

Once completed, chose one of the following two sections for next steps.

Try in Play With Docker

To play in an already set up sandbox, in your browser, click the button below:

Try in PWD

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 cloning the repo 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/arm64 to all services in the pwd.yml
  • replace the current specified versions of erpnext image on pwd.yml with :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

Custom Images

Development

Troubleshoot

Contributing

If you want to contribute to this repo refer to CONTRIBUTING.md

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