2021-12-10 08:50:39 +00:00
[](https://github.com/frappe/frappe_docker/actions/workflows/build_stable.yml)
2021-10-31 05:32:58 +00:00
[](https://github.com/frappe/frappe_docker/actions/workflows/build_develop.yml)
2020-04-19 00:18:21 +00:00
2022-03-14 05:53:03 +00:00
Everything about [Frappe ](https://github.com/frappe/frappe ) and [ERPNext ](https://github.com/frappe/erpnext ) in containers.
2017-07-18 09:26:31 +00:00
2022-03-14 05:53:03 +00:00
# Getting Started
2020-07-01 00:26:24 +00:00
2024-02-29 12:16:18 +00:00
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 ).
2017-07-24 11:11:51 +00:00
2024-06-10 06:51:58 +00:00
Once completed, chose one of the following two sections for next steps.
2017-07-24 09:49:32 +00:00
2022-04-04 09:32:08 +00:00
### Try in Play With Docker
2024-06-10 06:51:58 +00:00
To play in an already set up sandbox, in your browser, click the button below:
2022-04-04 09:32:08 +00:00
< 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 >
2024-06-10 06:51:58 +00:00
### Try on your Dev environment
First clone the repo:
```sh
git clone https://github.com/frappe/frappe_docker
cd frappe_docker
```
2024-06-29 22:42:24 +00:00
Then run: `docker compose -f pwd.yml up -d`
2024-06-10 06:51:58 +00:00
2024-11-27 08:31:18 +00:00
### To run on ARM64 architecture follow this instructions
After cloning the repo 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.yaml
- replace the current specified versions of erpnext image on `pwd.yml` with `:latest`
Then run: `docker compose -f pwd.yml up -d`
2024-06-10 06:51:58 +00:00
## Final steps
2022-04-04 09:32:08 +00:00
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` )
2024-11-12 09:09:09 +00:00
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.
2024-06-10 06:51:58 +00:00
2023-01-15 22:50:09 +00:00
# Documentation
2020-03-06 06:12:11 +00:00
2024-10-15 06:08:00 +00:00
### [Frequently Asked Questions](https://github.com/frappe/frappe_docker/wiki/Frequently-Asked-Questions)
2023-01-15 22:50:09 +00:00
### [Production](#production)
2020-03-06 06:12:11 +00:00
2023-01-15 22:50:09 +00:00
- [List of containers ](docs/list-of-containers.md )
- [Single Compose Setup ](docs/single-compose-setup.md )
- [Environment Variables ](docs/environment-variables.md )
- [Single Server Example ](docs/single-server-example.md )
- [Setup Options ](docs/setup-options.md )
- [Site Operations ](docs/site-operations.md )
- [Backup and Push Cron Job ](docs/backup-and-push-cronjob.md )
- [Port Based Multi Tenancy ](docs/port-based-multi-tenancy.md )
- [Migrate from multi-image setup ](docs/migrate-from-multi-image-setup.md )
2023-06-12 22:36:15 +00:00
- [running on linux/mac ](docs/setup_for_linux_mac.md )
2020-03-06 06:12:11 +00:00
2023-01-15 22:50:09 +00:00
### [Custom Images](#custom-images)
2021-02-25 09:59:54 +00:00
2023-01-15 22:50:09 +00:00
- [Custom Apps ](docs/custom-apps.md )
- [Build Version 10 Images ](docs/build-version-10-images.md )
2021-02-25 09:59:54 +00:00
2023-01-15 22:50:09 +00:00
### [Development](#development)
2020-03-06 06:12:11 +00:00
2023-01-15 22:50:09 +00:00
- [Development using containers ](docs/development.md )
- [Bench Console and VSCode Debugger ](docs/bench-console-and-vscode-debugger.md )
- [Connect to localhost services ](docs/connect-to-localhost-services-from-containers-for-local-app-development.md )
2020-03-08 20:17:39 +00:00
2023-01-15 22:50:09 +00:00
### [Troubleshoot](docs/troubleshoot.md)
2020-03-08 20:17:39 +00:00
2022-03-14 05:53:03 +00:00
# Contributing
2020-03-08 20:17:39 +00:00
2022-03-14 05:53:03 +00:00
If you want to contribute to this repo refer to [CONTRIBUTING.md ](CONTRIBUTING.md )
2020-06-13 10:03:06 +00:00
2023-01-15 22:50:09 +00:00
This repository is only for container related stuff. You also might want to contribute to:
2020-06-13 10:03:06 +00:00
2022-03-14 05:53:03 +00:00
- [Frappe framework ](https://github.com/frappe/frappe#contributing ),
- [ERPNext ](https://github.com/frappe/erpnext#contributing ),
2023-01-15 22:50:09 +00:00
- [Frappe Bench ](https://github.com/frappe/bench ).
