mirror of
https://github.com/frappe/frappe_docker.git
synced 2026-06-18 22:25:09 +00:00
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.
111 lines
4.6 KiB
Markdown
111 lines
4.6 KiB
Markdown
[](https://github.com/frappe/frappe_docker/actions/workflows/build_stable.yml)
|
|
[](https://github.com/frappe/frappe_docker/actions/workflows/build_develop.yml)
|
|
|
|
Everything about [Frappe](https://github.com/frappe/frappe) and [ERPNext](https://github.com/frappe/erpnext) in containers.
|
|
|
|
# Getting Started
|
|
|
|
**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.
|
|
|
|
To get started you need [Docker](https://docs.docker.com/get-docker/), [docker-compose](https://docs.docker.com/compose/), and [git](https://docs.github.com/en/get-started/getting-started-with-git/set-up-git) setup on your machine. For Docker basics and best practices refer to Docker's [documentation](http://docs.docker.com).
|
|
|
|
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:
|
|
|
|
<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>
|
|
|
|
### Try on your Dev environment
|
|
|
|
First clone the repo:
|
|
|
|
```sh
|
|
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/arm64` to all services in the `pwd.yml`
|
|
- replace the current specified versions of erpnext image on `pwd.yml` with `: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](docs/getting-started.md)
|
|
|
|
### [Frequently Asked Questions](https://github.com/frappe/frappe_docker/wiki/Frequently-Asked-Questions)
|
|
|
|
### [Getting Started](#getting-started)
|
|
|
|
- [Quick Start (Linux/Mac)](docs/getting-started/quick-start-linux-mac.md)
|
|
- [Single Compose Setup](docs/getting-started/single-compose-setup.md)
|
|
|
|
### [Setup](#setup)
|
|
|
|
- [Container Overview](docs/reference/container-setup/overview.md)
|
|
- [Setup Options](docs/setup/setup-options.md)
|
|
- [Single Server Example](docs/setup/single-server-example.md)
|
|
|
|
### [Production](#production)
|
|
|
|
- [TLS/SSL Setup](docs/production/tls-ssl-setup.md)
|
|
- [Backup Strategy](docs/production/backup-strategy.md)
|
|
- [Multi-Tenancy](docs/production/multi-tenancy.md)
|
|
|
|
### [Operations](#operations)
|
|
|
|
- [Site Operations](docs/operations/site-operations.md)
|
|
|
|
### [Development](#development)
|
|
|
|
- [Development Guide](docs/development/development.md)
|
|
- [Debugging](docs/development/debugging.md)
|
|
- [Local Services Connection](docs/development/local-services-connection.md)
|
|
|
|
### [Migration](#migration)
|
|
|
|
- [Migrate from Multi-Image Setup](docs/migration/migrate-from-multi-image-setup.md)
|
|
|
|
### [Troubleshooting](#troubleshooting)
|
|
|
|
- [Troubleshoot Guide](docs/troubleshooting/troubleshoot.md)
|
|
- [Windows Nginx Entrypoint Error](docs/troubleshooting/windows-nginx-entrypoint-error.md)
|
|
|
|
### [Reference](#reference)
|
|
|
|
- [Container Setup Overview](docs/reference/container-setup/overview.md)
|
|
- [Build Setup](docs/reference/container-setup/build-setup.md)
|
|
- [Start Setup](docs/reference/container-setup/start-setup.md)
|
|
- [Environment Variables](docs/reference/container-setup/env-variables.md)
|
|
- [Compose Overrides](docs/reference/container-setup/overrides.md)
|
|
- [Build Version 10 Images](docs/reference/build-version-10-images.md)
|
|
|
|
# Contributing
|
|
|
|
If you want to contribute to this repo refer to [CONTRIBUTING.md](CONTRIBUTING.md)
|
|
|
|
This repository is only for container related stuff. You also might want to contribute to:
|
|
|
|
- [Frappe framework](https://github.com/frappe/frappe#contributing),
|
|
- [ERPNext](https://github.com/frappe/erpnext#contributing),
|
|
- [Frappe Bench](https://github.com/frappe/bench).
|