frappe_docker/README.md
Vasyl Herman a8c61f6ffe update
2020-06-28 11:02:43 +03:00

2.3 KiB

Develop Build Status
Master Build Status

Getting Started

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.
  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. Custom apps for production
  5. Tips for moving deployments

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

Development Setup Manual for beginners

  • install docker, docker-compose.
  • Clone the repo, cd into it
  • run make start if you are doing first time or make clean for clean installation
  • run make tty - you are inside the dev container
  • run make clean-init
  • run make install
  • run bench start