2020-07-01 00:26:24 +00:00
|
|
|
| Develop | [](https://travis-ci.com/frappe/frappe_docker) |
|
2020-04-19 00:18:21 +00:00
|
|
|
|---------|-----------------------------------------------------------------------------------------------------------------------------|
|
2020-07-01 00:26:24 +00:00
|
|
|
| Master | [](https://travis-ci.com/frappe/frappe_docker) |
|
2020-04-19 00:18:21 +00:00
|
|
|
|
2020-03-05 16:39:32 +00:00
|
|
|
## Getting Started
|
2017-07-18 09:26:31 +00:00
|
|
|
|
2020-07-01 00:26:24 +00:00
|
|
|
### Try in Play With Docker
|
|
|
|
|
|
|
|
|
|
<a href="https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/frappe/frappe_docker/develop/tests/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.
|
|
|
|
|
|
|
|
|
|
### Setting up Pre-requisites
|
2017-08-14 11:46:10 +00:00
|
|
|
|
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.
|
2017-08-14 11:46:10 +00:00
|
|
|
|
2020-06-13 10:03:06 +00:00
|
|
|
For Docker basics and best practices. Refer Docker [documentation](http://docs.docker.com).
|
2020-05-05 07:42:25 +00:00
|
|
|
|
2020-03-05 16:39:32 +00:00
|
|
|
### Cloning the repository and preliminary steps
|
2017-07-24 09:49:32 +00:00
|
|
|
|
2020-03-02 05:29:25 +00:00
|
|
|
Clone this repository somewhere in your system:
|
2017-07-24 11:11:51 +00:00
|
|
|
|
2020-03-02 05:29:25 +00:00
|
|
|
```sh
|
|
|
|
|
git clone https://github.com/frappe/frappe_docker.git
|
|
|
|
|
cd frappe_docker
|
|
|
|
|
```
|
2017-07-24 09:49:32 +00:00
|
|
|
|
2020-06-13 10:03:06 +00:00
|
|
|
## Production Setup
|
2020-03-06 06:12:11 +00:00
|
|
|
|
2020-06-13 10:03:06 +00:00
|
|
|
It takes care of the following:
|
2020-03-06 06:12:11 +00:00
|
|
|
|
2020-06-13 10:03:06 +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.
|
2020-03-06 06:12:11 +00:00
|
|
|
|
2021-02-25 09:59:54 +00:00
|
|
|
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.
|
|
|
|
|
|
2020-06-13 10:03:06 +00:00
|
|
|
1. Single Server Installs
|
2020-06-13 10:10:47 +00:00
|
|
|
1. [Single bench](docs/single-bench.md). Easiest Install!
|
|
|
|
|
2. [Multi bench](docs/multi-bench.md)
|
2020-06-13 10:03:06 +00:00
|
|
|
2. Multi Server Installs
|
|
|
|
|
1. [Docker Swarm](docs/docker-swarm.md)
|
|
|
|
|
2. [Kubernetes](https://helm.erpnext.com)
|
2020-06-13 10:10:47 +00:00
|
|
|
3. [Site Operations](docs/site-operations.md)
|
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)
|
2021-02-25 09:59:54 +00:00
|
|
|
7. [Wiki for optional recipes](https://github.com/frappe/frappe_docker/wiki)
|
2020-03-06 06:12:11 +00:00
|
|
|
|
2020-06-13 10:03:06 +00:00
|
|
|
## Development Setup
|
2020-03-08 20:17:39 +00:00
|
|
|
|
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:
|
2020-03-08 20:17:39 +00:00
|
|
|
|
|
|
|
|
- VSCode containers integration
|
|
|
|
|
- VSCode Python debugger
|
|
|
|
|
- Pre-configured Docker containers for an easy start
|
|
|
|
|
|
2020-06-13 10:03:06 +00:00
|
|
|
[Start development](development).
|
|
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
2020-06-14 15:54:50 +00:00
|
|
|
- [Frappe Docker Images](CONTRIBUTING.md)
|
2020-06-13 10:03:06 +00:00
|
|
|
- [Frappe Framework](https://github.com/frappe/frappe#contributing)
|
|
|
|
|
- [ERPNext](https://github.com/frappe/erpnext#contributing)
|
2020-06-17 09:45:56 +00:00
|
|
|
- [frappe/bench](https://github.com/frappe/bench)
|
