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)

Everything about [Frappe](https://github.com/frappe/frappe) and [ERPNext](https://github.com/frappe/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](http://docs.docker.com).
After that, clone this repo:

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

# Development

We have baseline for developing in VSCode devcontainer with [frappe/bench](https://github.com/frappe/bench). [Start development](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](docs/images-and-compose-files.md).

Also, there's docs to help with deployment:

- [setup options](docs/setup-options.md),
- in cluster:
  - [Docker Swarm](docs/docker-swarm.md),
  - [Kubernetes (frappe/helm)](https://helm.erpnext.com),
- [site operations](docs/site-operations.md).
- Other
  - [add custom domain using traefik](docs/add-custom-domain-using-traefik.md)
  - [backup and push cron jobs](docs/backup-and-push-cronjob.md)
  - [bench console and vscode debugger](docs/bench-console-and-vscode-debugger.md)
  - [build version 10](docs/build-version-10-images.md)
  - [connect to localhost services from containers for local app development](docs/connect-to-localhost-services-from-containers-for-local-app-development.md)
  - [patch code from images](docs/patch-code-from-images.md)
  - [port based multi tenancy](docs/port-based-multi-tenancy.md)
- [Troubleshoot](docs/troubleshoot.md)

# Custom app

Learn how to containerize your custom Frappe app in [this guide](custom_app/README.md).

# Contributing

If you want to contribute to this repo refer to [CONTRIBUTING.md](CONTRIBUTING.md)

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

- [Frappe framework](https://github.com/frappe/frappe#contributing),
- [ERPNext](https://github.com/frappe/erpnext#contributing),
- or [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
Remove custom apps for production instruction 2021-12-17 10:22:23 +00:00			`Everything about [Frappe](https://github.com/frappe/frappe) and [ERPNext](https://github.com/frappe/erpnext) in containers.`
Added a detailed README 2017-07-18 09:26:31 +00:00
Remove custom apps for production instruction 2021-12-17 10:22:23 +00:00			`# Getting Started`
added file-watcher-port and socketio-port + Readme changes Former-commit-id: 34f60750dc8e1ccd14db4e73504fe4b39f1c70fc 2017-08-14 11:46:10 +00:00
Remove custom apps for production instruction 2021-12-17 10:22:23 +00:00			`To get started, you need Docker, docker-compose and git setup on your machine. For Docker basics and best practices. Refer Docker [documentation](http://docs.docker.com).`
			`After that, clone this repo:`
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
Remove custom apps for production instruction 2021-12-17 10:22:23 +00:00			`git clone https://github.com/frappe/frappe_docker`
chore: clean up and update readme Signed-off-by: Chinmay D. Pai <chinmaydpai@gmail.com> 2020-03-02 05:29:25 +00:00			`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
Remove custom apps for production instruction 2021-12-17 10:22:23 +00:00			`# Development`

			`We have baseline for developing in VSCode devcontainer with [frappe/bench](https://github.com/frappe/bench). [Start development](development).`
rudimentary docs 2020-03-06 06:12:11 +00:00
Remove custom apps for production instruction 2021-12-17 10:22:23 +00:00			`# Production`
rudimentary docs 2020-03-06 06:12:11 +00:00
Add docs for images and compose files 2021-12-17 11:10:24 +00:00			`We provide simple and intuitive production setup with prebuilt Frappe and ERPNext images and compose files. To learn more about those, [read the docs](docs/images-and-compose-files.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
Remove custom apps for production instruction 2021-12-17 10:22:23 +00:00			`Also, there's docs to help with deployment:`
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: README and docs 2021-12-26 08:08:51 +00:00			`- [setup options](docs/setup-options.md),`
Remove custom apps for production instruction 2021-12-17 10:22:23 +00:00			`- in cluster:`
			`- [Docker Swarm](docs/docker-swarm.md),`
			`- [Kubernetes (frappe/helm)](https://helm.erpnext.com),`
			`- [site operations](docs/site-operations.md).`
docs: move wiki articles to docs 2022-01-10 08:40:25 +00:00			`- Other`
Run pre-commit on docs 2022-02-08 11:45:07 +00:00			`- [add custom domain using traefik](docs/add-custom-domain-using-traefik.md)`
			`- [backup and push cron jobs](docs/backup-and-push-cronjob.md)`
			`- [bench console and vscode debugger](docs/bench-console-and-vscode-debugger.md)`
			`- [build version 10](docs/build-version-10-images.md)`
			`- [connect to localhost services from containers for local app development](docs/connect-to-localhost-services-from-containers-for-local-app-development.md)`
			`- [patch code from images](docs/patch-code-from-images.md)`
			`- [port based multi tenancy](docs/port-based-multi-tenancy.md)`
docs: move wiki articles to docs 2022-01-10 08:40:25 +00:00			`- [Troubleshoot](docs/troubleshoot.md)`
rudimentary docs 2020-03-06 06:12:11 +00:00
Remove custom apps for production instruction 2021-12-17 10:22:23 +00:00			`# Custom app`
Clean up main README, add development section 2020-03-08 20:17:39 +00:00
Remove custom apps for production instruction 2021-12-17 10:22:23 +00:00			`Learn how to containerize your custom Frappe app in [this guide](custom_app/README.md).`
Clean up main README, add development section 2020-03-08 20:17:39 +00:00
Remove custom apps for production instruction 2021-12-17 10:22:23 +00:00			`# Contributing`
Clean up main README, add development section 2020-03-08 20:17:39 +00:00
Remove custom apps for production instruction 2021-12-17 10:22:23 +00:00			`If you want to contribute to this repo refer to [CONTRIBUTING.md](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
Remove custom apps for production instruction 2021-12-17 10:22:23 +00:00			`This repository is only for Docker related stuff. You also might want to contribute to:`
docs: organize docs break down readme into multiple files organize in docs directory [skip travis] 2020-06-13 10:03:06 +00:00
Remove custom apps for production instruction 2021-12-17 10:22:23 +00:00			`- [Frappe framework](https://github.com/frappe/frappe#contributing),`
			`- [ERPNext](https://github.com/frappe/erpnext#contributing),`
			`- or [Frappe Bench](https://github.com/frappe/bench).`