docker-erpnext/README.md
Brian Tan Seng 831d1adfe3 Removed all websoft9 dependencies from your project. Here's what was done:
1. Removed IP detection script from variables.json - eliminated the websoft9.com script
  dependency
  2. Updated README.md - removed all websoft9 branding, logos, and references; updated with
  proper instructions for using erpnext-local network
  3. Deleted Chinese documentation - removed README-zh.md file
  4. Updated CLAUDE.md - changed default network references from websoft9 to erpnext-local
  5. Removed GitHub workflows - deleted templating.yml and mirror.yml that had websoft9
  dependencies
  6. Updated bug report template - removed websoft9 references and updated for generic Docker
  deployment

  The project now uses erpnext-local as the Docker network throughout, and all external
  dependencies on websoft9 have been eliminated. The .env file already had the correct network
  configuration.
2025-08-22 16:51:43 +08:00

3.5 KiB

ERPNext on Docker

Introduction

This repository provides a Docker-based deployment solution for ERPNext, simplifying the installation and initialization process.

System Requirements

The following are the minimal recommended requirements:

  • OS: Red Hat, CentOS, Debian, Ubuntu or other Linux OS
  • Public Cloud: AWS, Azure, Google Cloud, Alibaba Cloud, and other major cloud providers
  • Private Cloud: KVM, VMware, VirtualBox, OpenStack
  • ARCH: Linux x86-64, ARM 32/64, Windows x86-64, IBM POWER8, x86/i686
  • RAM: 8 GB or more
  • CPU: 2 cores or higher
  • HDD: at least 20 GB of free space
  • Swap file: at least 2 GB
  • Bandwidth: more fluent experience over 100M

QuickStart

Prerequisites

If you have not installed Docker and Docker-Compose, refer to the following commands to install it:

curl -fsSL https://get.docker.com -o get-docker.sh && sh get-docker.sh
sudo systemctl enable docker
sudo systemctl start docker
alias docker-compose='docker compose'
echo "alias docker-compose='docker compose'" >> /etc/profile.d/docker-compose.sh
source /etc/profile.d/docker-compose.sh

Install ERPNext

  1. Clone the repository:
git clone --depth=1 https://github.com/98labs/docker-erpnext
cd docker-erpnext
  1. Create the Docker network:
docker network create erpnext-local
  1. Configure environment variables (optional): Edit the .env file to customize your deployment:
  • APP_PASSWORD: Administrator password (default: LocalDev123!)
  • APP_HTTP_PORT: HTTP port (default: 8080)
  • APP_VERSION: ERPNext version (v12, v13, or v14)
  1. Start the services:
docker-compose up -d

Usage

After deployment, you can access ERPNext at: http://localhost:8080 (or your configured port)

Default Credentials

Username Password
Administrator LocalDev123!

Services and Ports

Service Port Use Necessity
ERPNext Web 8080 Browser access to ERPNext Y
MariaDB 3306 Database access Y

Common Operations

Viewing Logs

# All services
docker-compose logs -f

# Specific service
docker-compose logs -f backend

Accessing the Backend Shell

docker exec -it erpnext-backend /bin/bash

Bench Commands

From within the backend container:

# Access Frappe/ERPNext console
bench --site frontend console

# Clear cache
bench --site frontend clear-cache

# Run migrations
bench --site frontend migrate

FAQ

Do I need to change the password before docker-compose up?

Yes, you should modify all database passwords and application passwords in the .env file for production use.

Docker running failed due to port conflict?

You should modify the APP_HTTP_PORT in the .env file and run docker-compose up -d again.

Why does ERPNext use port 8000 internally?

Port 8000 is used internally for container communication. Changing it causes errors. The external port is configured via APP_HTTP_PORT.

How do I run a different ERPNext version?

Change APP_VERSION in the .env file to v12, v13, or v14. Note: You must remove existing volumes before changing versions:

docker-compose down
docker volume prune
# Update .env
docker-compose up -d

Documentation

ERPNext Documentation Frappe Framework Documentation

License

This Docker deployment configuration is open source. ERPNext is licensed under the GNU GPLv3 License.