frappe_docker/README.md

[![Build Stable](https://github.com/frappe/frappe_docker/actions/workflows/build_stable.yml/badge.svg)](https://github.com/frappe/frappe_docker/actions/workflows/build_stable.yml)
[![Build Develop](https://github.com/frappe/frappe_docker/actions/workflows/build_develop.yml/badge.svg)](https://github.com/frappe/frappe_docker/actions/workflows/build_develop.yml)

## Getting Started

### Try in Play With Docker

<a href="https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/frappe/frappe_docker/main/pwd.yml">
  <img src="https://raw.githubusercontent.com/play-with-docker/stacks/master/assets/images/button.png" alt="Try in PWD"/>
</a>

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](http://docs.docker.com).

### Cloning the repository and preliminary steps

Clone this repository somewhere in your system:

```sh
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](docs/single-bench.md). Easiest Install!
   2. [Multi bench](docs/multi-bench.md)
2. Multi Server Installs
   1. [Docker Swarm](docs/docker-swarm.md)
   2. [Kubernetes](https://helm.erpnext.com)
3. [Site Operations](docs/site-operations.md)
4. [Environment Variables](docs/environment-variables.md)
5. [Custom apps for production](docs/custom-apps-for-production.md)
6. [Tips for moving deployments](docs/tips-for-moving-deployments.md)
7. [Wiki for optional recipes](https://github.com/frappe/frappe_docker/wiki)

## 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](development).

## Contributing

- [Frappe Docker Images](CONTRIBUTING.md)
- [Frappe Framework](https://github.com/frappe/frappe#contributing)
- [ERPNext](https://github.com/frappe/erpnext#contributing)
- [frappe/bench](https://github.com/frappe/bench)
chore(lint): Fix trailing-whitespace 2021-12-10 08:50:39 +00:00			`[![Build Stable](https://github.com/frappe/frappe_docker/actions/workflows/build_stable.yml/badge.svg)](https://github.com/frappe/frappe_docker/actions/workflows/build_stable.yml)`
ci: Build fixes - Simplify builds by separating dev/stable workflows - Fix Helm deploy key - Remove deploy_key.env (already using deploy key in secrets) - Fix paths matching on push and pull_request triggers - Fix possible issues with tag difference between ERPNext and Frappe (add tag resolving step before pushing) - Don't login, push Docker images and release Helm chart on forks - Don't test on version 12 (there's no test for this version) - Remove frappe-installer (from chore: use github actions #525) - Fix badges in readme 2021-10-31 05:32:58 +00:00			`[![Build Develop](https://github.com/frappe/frappe_docker/actions/workflows/build_develop.yml/badge.svg)](https://github.com/frappe/frappe_docker/actions/workflows/build_develop.yml)`
Add travis badge 2020-04-19 00:18:21 +00:00
merged documentation changes 2020-03-05 16:39:32 +00:00			`## Getting Started`
Added a detailed README 2017-07-18 09:26:31 +00:00
fix: README travis badges add play with docker button [skip travis] 2020-07-01 00:26:24 +00:00			`### Try in Play With Docker`

chore: Fix pwd url and move `pwd.yml` away from `tests` directory (#603) 2021-12-05 15:56:21 +00:00			`<a href="https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/frappe/frappe_docker/main/pwd.yml">`
fix: README travis badges add play with docker button [skip travis] 2020-07-01 00:26:24 +00:00			`<img src="https://raw.githubusercontent.com/play-with-docker/stacks/master/assets/images/button.png" alt="Try in PWD"/>`
			`</a>`

docs: mention PWD admin credentials [skip travis] 2021-04-10 15:33:46 +00:00			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`)
fix: README travis badges add play with docker button [skip travis] 2020-07-01 00:26:24 +00:00
			`### Setting up Pre-requisites`
added file-watcher-port and socketio-port + Readme changes Former-commit-id: 34f60750dc8e1ccd14db4e73504fe4b39f1c70fc 2017-08-14 11:46:10 +00:00
fix: README single command to deploy locally env file placed where docker-compose will be executed 2020-04-27 08:06:33 +00:00			`This repository requires Docker, docker-compose and Git to be setup on the instance to be used.`
added file-watcher-port and socketio-port + Readme changes Former-commit-id: 34f60750dc8e1ccd14db4e73504fe4b39f1c70fc 2017-08-14 11:46:10 +00:00
docs: organize docs break down readme into multiple files organize in docs directory [skip travis] 2020-06-13 10:03:06 +00:00			`For Docker basics and best practices. Refer Docker [documentation](http://docs.docker.com).`
[skip travis] Update README 2020-05-05 07:42:25 +00:00
merged documentation changes 2020-03-05 16:39:32 +00:00			`### Cloning the repository and preliminary steps`
start-container became build-container, added new start-container and updated README.md Former-commit-id: 5e84e477ac8f2b44d21024ff7f16ac082ded3904 2017-07-24 09:49:32 +00:00
chore: clean up and update readme Signed-off-by: Chinmay D. Pai <chinmaydpai@gmail.com> 2020-03-02 05:29:25 +00:00			`Clone this repository somewhere in your system:`
Update README.md Former-commit-id: 8764181929b83109f3c64ba22144cac9090e2a01 2017-07-24 11:11:51 +00:00
chore: clean up and update readme Signed-off-by: Chinmay D. Pai <chinmaydpai@gmail.com> 2020-03-02 05:29:25 +00:00			```sh
			`git clone https://github.com/frappe/frappe_docker.git`
			`cd frappe_docker`
			```
start-container became build-container, added new start-container and updated README.md Former-commit-id: 5e84e477ac8f2b44d21024ff7f16ac082ded3904 2017-07-24 09:49:32 +00:00
docs: organize docs break down readme into multiple files organize in docs directory [skip travis] 2020-06-13 10:03:06 +00:00			`## Production Setup`
rudimentary docs 2020-03-06 06:12:11 +00:00
docs: organize docs break down readme into multiple files organize in docs directory [skip travis] 2020-06-13 10:03:06 +00:00			`It takes care of the following:`
rudimentary docs 2020-03-06 06:12:11 +00:00
chore(lint): Run prettier 2021-12-10 08:53:43 +00:00			`- 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.`
rudimentary docs 2020-03-06 06:12:11 +00:00
docs: improve docs Add section about wiki in contribution section Mention about wiki in README Mention about cron job in README [skip travis] 2021-02-25 09:59:54 +00:00			`It doesn't take care of the following:`

chore(lint): Run prettier 2021-12-10 08:53:43 +00:00			`- Cron Job to backup sites is not created by default.`
			- Use `CronJob` on k8s or refer wiki for alternatives.
docs: improve docs Add section about wiki in contribution section Mention about wiki in README Mention about cron job in README [skip travis] 2021-02-25 09:59:54 +00:00
docs: organize docs break down readme into multiple files organize in docs directory [skip travis] 2020-06-13 10:03:06 +00:00			`1. Single Server Installs`
chore(lint): Run prettier 2021-12-10 08:53:43 +00:00			`1. [Single bench](docs/single-bench.md). Easiest Install!`
			`2. [Multi bench](docs/multi-bench.md)`
docs: organize docs break down readme into multiple files organize in docs directory [skip travis] 2020-06-13 10:03:06 +00:00			`2. Multi Server Installs`
chore(lint): Run prettier 2021-12-10 08:53:43 +00:00			`1. [Docker Swarm](docs/docker-swarm.md)`
			`2. [Kubernetes](https://helm.erpnext.com)`
docs: organize fix links [skip travis] 2020-06-13 10:10:47 +00:00			`3. [Site Operations](docs/site-operations.md)`
docs(frappe-nginx): configurable nginx http timeout [skip travis] 2021-01-04 13:15:42 +00:00			`4. [Environment Variables](docs/environment-variables.md)`
			`5. [Custom apps for production](docs/custom-apps-for-production.md)`
			`6. [Tips for moving deployments](docs/tips-for-moving-deployments.md)`
docs: improve docs Add section about wiki in contribution section Mention about wiki in README Mention about cron job in README [skip travis] 2021-02-25 09:59:54 +00:00			`7. [Wiki for optional recipes](https://github.com/frappe/frappe_docker/wiki)`
rudimentary docs 2020-03-06 06:12:11 +00:00
docs: organize docs break down readme into multiple files organize in docs directory [skip travis] 2020-06-13 10:03:06 +00:00			`## Development Setup`
Clean up main README, add development section 2020-03-08 20:17:39 +00:00
docs: organize docs break down readme into multiple files organize in docs directory [skip travis] 2020-06-13 10:03:06 +00:00			`It takes care of complete setup to develop with Frappe/ERPNext and Bench, Including the following features:`
Clean up main README, add development section 2020-03-08 20:17:39 +00:00
			`- VSCode containers integration`
			`- VSCode Python debugger`
			`- Pre-configured Docker containers for an easy start`

docs: organize docs break down readme into multiple files organize in docs directory [skip travis] 2020-06-13 10:03:06 +00:00			`[Start development](development).`

			`## Contributing`

fix: README contributions url [skip travis] 2020-06-14 15:54:50 +00:00			`- [Frappe Docker Images](CONTRIBUTING.md)`
docs: organize docs break down readme into multiple files organize in docs directory [skip travis] 2020-06-13 10:03:06 +00:00			`- [Frappe Framework](https://github.com/frappe/frappe#contributing)`
			`- [ERPNext](https://github.com/frappe/erpnext#contributing)`
ci: trigger build 2020-06-17 09:45:56 +00:00			`- [frappe/bench](https://github.com/frappe/bench)`