mirror of
https://github.com/frappe/frappe_docker.git
synced 2026-06-26 17:15:08 +00:00
66 lines
No EOL
2.4 KiB
Markdown
66 lines
No EOL
2.4 KiB
Markdown
| Develop | [](https://travis-ci.com/frappe/frappe_docker) |
|
|
|---------|-----------------------------------------------------------------------------------------------------------------------------|
|
|
| Master | [](https://travis-ci.com/frappe/frappe_docker) |
|
|
|
|
|
|
## Getting Started
|
|
|
|
## 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.
|
|
|
|
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. [Custom apps for production](docs/custom-apps-for-production.md)
|
|
5. [Tips for moving deployments](docs/tips-for-moving-deployments.md)
|
|
|
|
## 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)
|
|
|
|
## Manual Development Setup for beginners on Linux Desktop
|
|
- install docker, docker-compose.
|
|
- Clone the repo, cd into it
|
|
- run `make start` if you are doing first time or `make clean` for clean installation
|
|
- run `make tty` - you are inside the dev container
|
|
- run `make clean-init`
|
|
- run `make install`
|
|
- run `bench start` inside frappe-bench folder
|
|
- Access your dev sever at [mysite.localhost:8000](http://mysite.localhost:8000) (Administrator\admin) |