/frappe_docker

Docker images for production and development setups of the Frappe framework and ERPNext

Primary LanguagePythonMIT LicenseMIT

Develop Build Status
Master Build Status

Getting Started

Try in Play With Docker

Try in PWD

Wait for 5 minutes for ERPNext site to be created or check site-creator container logs before opening browser on port 80. (username: Administrator, password: admin)

Setting up Pre-requisites

This repository requires Docker, docker-compose and Git to be setup on the instance to be used.

For Docker basics and best practices. Refer Docker documentation.

Cloning the repository and preliminary steps

Clone this repository somewhere in your system:

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

Production Setup

It takes care of the following:

  • Setting up the desired version of Frappe/ERPNext.
  • Setting up all the system requirements: eg. MariaDB, Node, Redis.
  • Configure networking for remote access and setting up LetsEncrypt.

It doesn't take care of the following:

  • Cron Job to backup sites is not created by default.
  • Use CronJob on k8s or refer wiki for alternatives.
  1. Single Server Installs
    1. Single bench. Easiest Install!
    2. Multi bench
  2. Multi Server Installs
    1. Docker Swarm
    2. Kubernetes
  3. Site Operations
  4. Environment Variables
  5. Custom apps for production
  6. Tips for moving deployments
  7. Wiki for optional recipes

Development Setup

It takes care of complete setup to develop with Frappe/ERPNext and Bench, Including the following features:

  • VSCode containers integration
  • VSCode Python debugger
  • Pre-configured Docker containers for an easy start

Start development.

Contributing