Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/frappe/frappe_docker
Docker images for production and development setups of the Frappe framework and ERPNext
https://github.com/frappe/frappe_docker
containers erpnext frappe
Last synced: 25 days ago
JSON representation
Docker images for production and development setups of the Frappe framework and ERPNext
- Host: GitHub
- URL: https://github.com/frappe/frappe_docker
- Owner: frappe
- License: mit
- Created: 2017-08-03T11:10:41.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-04-13T11:47:36.000Z (7 months ago)
- Last Synced: 2024-04-14T04:10:06.031Z (7 months ago)
- Topics: containers, erpnext, frappe
- Language: Python
- Homepage:
- Size: 9.45 MB
- Stars: 1,111
- Watchers: 46
- Forks: 1,115
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-starred - frappe/frappe_docker - Docker images for production and development setups of the Frappe framework and ERPNext (others)
- awesome-frappe - Frappe Docker - Official docker images for Frappe. (Uncategorized / Uncategorized)
README
[](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
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:
### 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`
## 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 -d`. Don't worry about some of the initial error messages, some services take a while to become ready, and then they go away.
# Documentation
### [Production](#production)
- [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)
- [running on linux/mac](docs/setup_for_linux_mac.md)
### [Custom Images](#custom-images)
- [Custom Apps](docs/custom-apps.md)
- [Build Version 10 Images](docs/build-version-10-images.md)
### [Development](#development)
- [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)
### [Troubleshoot](docs/troubleshoot.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).