a2c0134c05
Restructure documentation into organized directories for better navigation: - getting-started/: Quick start guides for new users - setup/: Setup and configuration guides - production/: Production deployment guides (backup, TLS, multi-tenancy) - operations/: Site operations and management - development/: Development workflow guides - migration/: Migration guides - troubleshooting/: Troubleshooting guides - reference/: Reference documentation (container setup, build configs) Rename files for consistency: - Use kebab-case naming convention throughout - Remove numbered prefixes from container-setup files - Use descriptive names (backup-strategy, tls-ssl-setup, etc.) Update all internal cross-references to reflect new file locations. Update README.md with organized documentation structure. Fix image paths in development.md to use correct relative paths. |
||
|---|---|---|
| .github | ||
| .vscode | ||
| devcontainer-example | ||
| development | ||
| docs | ||
| images | ||
| overrides | ||
| resources | ||
| tests | ||
| .dockerignore | ||
| .editorconfig | ||
| .gitignore | ||
| .pre-commit-config.yaml | ||
| .shellcheckrc | ||
| CODE_OF_CONDUCT.md | ||
| compose.yaml | ||
| CONTRIBUTING.md | ||
| docker-bake.hcl | ||
| example.env | ||
| install_x11_deps.sh | ||
| LICENSE | ||
| pwd.yml | ||
| README.md | ||
| requirements-test.txt | ||
| setup.cfg | ||
Everything about Frappe and ERPNext in containers.
Getting Started
New to Frappe Docker? Read the Getting Started Guide for a comprehensive overview of repository structure, development workflow, custom apps, Docker concepts, and quick start examples.
To get started you need Docker, docker-compose, and git setup on your machine. For Docker basics and best practices refer to Docker's documentation.
Once completed, chose one of the following two sections for next steps.
Try in Play With Docker
To play in an already set up sandbox, in your browser, click the button below:
Try on your Dev environment
First clone the repo:
git clone https://github.com/frappe/frappe_docker
cd frappe_docker
Then run: docker compose -f pwd.yml up -d
To run on ARM64 architecture follow this instructions
After you clone the repo and cd frappe_docker, run this command to build multi-architecture images specifically for ARM64.
docker buildx bake --no-cache --set "*.platform=linux/arm64"
and then
- add
platform: linux/arm64to all services in thepwd.yml - replace the current specified versions of erpnext image on
pwd.ymlwith:latest
Then run: docker compose -f pwd.yml up -d
Final steps
Wait for 5 minutes for ERPNext site to be created or check create-site container logs before opening browser on port 8080. (username: Administrator, password: admin)
If you ran in a Dev Docker environment, to view container logs: docker compose -f pwd.yml logs -f create-site. Don't worry about some of the initial error messages, some services take a while to become ready, and then they go away.
Documentation
Getting Started Guide
Frequently Asked Questions
Getting Started
Setup
Production
Operations
Development
Migration
Troubleshooting
Reference
- Container Setup Overview
- Build Setup
- Start Setup
- Environment Variables
- Compose Overrides
- Build Version 10 Images
Contributing
If you want to contribute to this repo refer to CONTRIBUTING.md
This repository is only for container related stuff. You also might want to contribute to: