2
0
mirror of https://github.com/frappe/frappe_docker.git synced 2024-09-19 10:39:02 +00:00
Docker images for production and development setups of the Frappe framework and ERPNext
Go to file
Revant Nandgaonkar 66e7ca91d4
Merge pull request #428 from revant/add-docs
docs: improve docs
2021-02-25 15:55:00 +05:30
.github fix stale issues messages 2020-03-29 22:45:34 +01:00
.vscode Added an opinionated set of extensions that will provide a common base for development and tutorials 2020-04-19 14:00:35 +01:00
build fix(erpnext-nginx): install erpnext or custom app dependencies 2021-02-21 07:38:18 +05:30
devcontainer-example fix: gitignore .devcontainer 2020-08-01 23:27:56 +05:30
development Update README.MD for clarity 2020-12-02 19:52:40 +05:30
docs Update documentation to reflect the new env vars. 2021-02-18 09:35:58 +01:00
installation rootless containers 2021-02-20 10:54:01 +00:00
tests tests: mount assets-vol for migrate command test 2020-10-02 12:45:13 +05:30
.dockerignore chore: cleanup redundant files 2020-03-02 23:10:16 +05:30
.gitignore fix: gitignore .devcontainer 2020-08-01 23:27:56 +05:30
.travis.yml Revert "feat: make images arm64 compatible" 2021-01-07 19:44:40 +05:30
CODE_OF_CONDUCT.md CODE_OF_CONDUCT.md 2020-09-15 11:23:42 -07:00
CONTRIBUTING.md docs: improve docs 2021-02-25 15:30:03 +05:30
deploy_key.enc chore: update deploy_key for travis 2020-06-17 10:31:18 +05:30
docker-compose.yml rootless containers 2021-02-20 10:54:01 +00:00
env-example Use new version variables in tests as well 2020-09-23 10:14:05 +02:00
env-local feat: dynamic labels for local or production 2020-06-14 05:45:14 +05:30
env-production feat: dynamic labels for local or production 2020-06-14 05:45:14 +05:30
frappe-installer rootless containers 2021-02-20 10:54:01 +00:00
greetings.yml Create greetings.yml 2020-03-24 17:15:27 +00:00
LICENSE.md Rename LICENSE to LICENSE.md 2017-10-02 09:48:51 +05:30
README.md docs: improve docs 2021-02-25 15:30:03 +05:30
travis.py Revert "feat: make images arm64 compatible" 2021-01-07 19:44:40 +05:30

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.

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