diff --git a/README.md b/README.md index cc333e4a..769efef7 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,37 @@ -# Frappe Docker - -[](https://github.com/frappe/frappe_docker/actions/workflows/core-build-stable.yml) -[](https://github.com/frappe/frappe_docker/actions/workflows/core-build-develop.yml) - -Docker images and orchestration for Frappe applications. +
## What is this? -This repository handles the containerization of the Frappe stack, including the application server, database, Redis, and supporting services. It provides quick disposable demo setups, a development environment, production-ready Docker images and compose configurations for deploying Frappe applications including ERPNext. +This repository is the official container setup for Frappe applications. + +It provides Docker images, Compose configurations, and documentation for running Frappe applications, including ERPNext, CRM, Helpdesk, and other Frappe apps, in containers. + +Use it if you want to: + +- run ERPNext, CRM, Helpdesk, or other Frappe apps with Docker +- start from a quick demo setup +- use production-ready Docker images and Compose setups +- build custom app images +- deploy and operate Frappe in production ## Repository Structure -``` +```bash frappe_docker/ ├── docs/ # Complete documentation ├── overrides/ # Docker Compose configurations for different scenarios @@ -34,11 +54,18 @@ frappe_docker/ ## Documentation -**The official documentation for `frappe_docker` is maintained in the `docs/` folder in this repository.** +The full `frappe_docker` documentation is available in [`docs/`](docs/) and published at [frappe.github.io/frappe_docker](https://frappe.github.io/frappe_docker/). -**New to Frappe Docker?** Read the [Getting Started Guide](docs/getting-started.md) for a comprehensive overview of repository structure, development workflow, custom apps, Docker concepts, and quick start examples. +### Recommended entry points: -If you are already familiar with Frappe, you can jump right into the [different deployment methods](docs/01-getting-started/01-choosing-a-deployment-method.md) and select the one best suited to your use case. +- **New here:** [Getting Started Guide](docs/getting-started.md) +- **Choosing a setup:** [Deployment methods](docs/01-getting-started/01-choosing-a-deployment-method.md) +- **ARM64 notes:** [ARM64](docs/01-getting-started/03-arm64.md) +- **Container setup overview:** [Container Setup Overview](docs/02-setup/01-overview.md) +- **Running in production:** [Production docs](docs/03-production/) +- **Operating a deployment:** [Operations docs](docs/04-operations/) +- **Development workflows:** [Development](docs/05-development/01-development.md) +- **FAQ:** [Frequently Asked Questions](https://github.com/frappe/frappe_docker/wiki/Frequently-Asked-Questions) ## Prerequisites