2
0
mirror of https://github.com/frappe/frappe_docker.git synced 2024-11-08 06:15:26 +00:00
frappe_docker/README.md

70 lines
2.6 KiB
Markdown
Raw Normal View History

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)
[![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)
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
### 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).
2020-05-05 07:42:25 +00:00
2020-03-05 16:39:32 +00:00
### 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
2020-03-06 06:12:11 +00:00
It takes care of the following:
2020-03-06 06:12:11 +00:00
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.
2020-03-06 06:12:11 +00:00
It doesn't take care of the following:
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.
1. Single Server Installs
2021-12-10 08:53:43 +00:00
1. [Single bench](docs/single-bench.md). Easiest Install!
2. [Multi bench](docs/multi-bench.md)
2. Multi Server Installs
2021-12-10 08:53:43 +00:00
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)
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)
2020-03-06 06:12:11 +00:00
## 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)
2020-06-17 09:45:56 +00:00
- [frappe/bench](https://github.com/frappe/bench)