frappe_docker/README.md

Everything about Frappe and ERPNext in containers.

Getting Started

To get started, you need Docker, docker-compose and git setup on your machine. For Docker basics and best practices. Refer Docker documentation. After that, clone this repo:

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

Try in Play With Docker

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)

Development

We have baseline for developing in VSCode devcontainer with frappe/bench. Start development.

Production

We provide simple and intuitive production setup with prebuilt Frappe and ERPNext images and compose files. To learn more about those, read the docs.

Also, there's docs to help with deployment:

• Setup options
• Examples:
  • Single Server
  • Kubernetes (frappe/helm),
• site operations.
• Other
  • add custom domain using traefik
  • backup and push cron jobs
  • bench console and vscode debugger
  • build version 10
  • connect to localhost services from containers for local app development
  • patch code from images
  • port based multi tenancy
• Troubleshoot

Custom app

Learn how to containerize your custom Frappe app in this guide.

Contributing

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

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

• Frappe framework,
• ERPNext,
• or Frappe Bench.