# mo_frappe_docker

**Repository Path**: mojerro/mo_frappe_docker

## Basic Information

- **Project Name**: mo_frappe_docker
- **Description**: No description available
- **Primary Language**: Python
- **License**: MIT
- **Default Branch**: zh
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-12-01
- **Last Updated**: 2024-07-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[![Build Stable](https://github.com/frappe/frappe_docker/actions/workflows/build_stable.yml/badge.svg)](https://github.com/frappe/frappe_docker/actions/workflows/build_stable.yml)
[![Build Develop](https://github.com/frappe/frappe_docker/actions/workflows/build_develop.yml/badge.svg)](https://github.com/frappe/frappe_docker/actions/workflows/build_develop.yml)

此仓库是基于 [Frappe](https://github.com/frappe/frappe) 和 [ERPNext](https://github.com/frappe/erpnext) 的中文版docker开发及部署仓库，相关中文库为 [mo-Frappe](https://gitee.com/mojerro/mo-frappe) 和 [mo-ERPNext](https://gitee.com/mojerro/mo-erpnext) 


# 开始使用

使用此项目需要安装 Docker, docker-compose（2.0版本），git。Docker相关使用文档请参照[Docker 官方文档](http://docs.docker.com).

之后克隆此仓库

```sh
git clone https://gitee.com/mojerro/mo_frappe_docker.git
cd mo_frappe_docker
```

# 快速开始

## 设置环境变量

将示例docker环境变量文件复制到 `.env`：

```sh
cp example.env .env
```

## 生成 docker-compose.yml 文件

```sh
# 生成 YAML 文件
docker compose -f compose.yaml \
  -f overrides/compose.mo-erpnext.yaml \
  -f overrides/compose.redis.yaml \
  -f overrides/compose.noproxy.yaml \
  -f overrides/compose.mariadb.yaml \
  config > ./docker-compose.yml
```

## 启动程序

```sh
docker compose -p erpnext -f docker-compose.yml up -d
```

**如果为更新，需要清理缓存**

```sh
docker compose -f docker-compose.yml -p erpnext exec backend bench --site erpnext-zh clear-cache 
```

## 创建ERPNext中文网站

```sh
docker compose -f docker-compose.yml -p erpnext exec backend bench new-site erpnext-zh --mariadb-root-password 123 --admin-password admin --install-app erpnext
```

创建成功后，通过 [localhost:30327](localhost:30327) 进入登录页，管理员用户名/密码为：`Administrator`/`admin`

# 部署

We provide simple and intuitive production setup with prebuilt Frappe and ERPNext images and compose files. To learn more about those, [read the docs](docs/images-and-compose-files.md).

Also, there's docs to help with deployment:

- [setup options](docs/setup-options.md),
- in cluster:
  - [Docker Swarm](docs/docker-swarm.md),
  - [Kubernetes (frappe/helm)](https://helm.erpnext.com),
- [site operations](docs/site-operations.md).
- Other
  - [add custom domain using traefik](docs/add-custom-domain-using-traefik.md)
  - [backup and push cron jobs](docs/backup-and-push-cronjob.md)
  - [bench console and vscode debugger](docs/bench-console-and-vscode-debugger.md)
  - [build version 10](docs/build-version-10-images.md)
  - [connect to localhost services from containers for local app development](docs/connect-to-localhost-services-from-containers-for-local-app-development.md)
  - [patch code from images](docs/patch-code-from-images.md)
  - [port based multi tenancy](docs/port-based-multi-tenancy.md)
- [Troubleshoot](docs/troubleshoot.md)

# Custom app

Learn how to containerize your custom Frappe app in [this guide](custom_app/README.md).

# Contributing

If you want to contribute to this repo refer to [CONTRIBUTING.md](CONTRIBUTING.md)

This repository is only for Docker related stuff. You also might want to contribute to:

- [Frappe framework](https://github.com/frappe/frappe#contributing),
- [ERPNext](https://github.com/frappe/erpnext#contributing),
- or [Frappe Bench](https://github.com/frappe/bench).