mirror of
https://github.com/frappe/frappe_docker.git
synced 2026-06-18 06:05:09 +00:00
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.
226 lines
5.5 KiB
Markdown
226 lines
5.5 KiB
Markdown
# How to install ERPNext on linux/mac using Frappe_docker ?
|
|
|
|
step1: clone the repo
|
|
|
|
```
|
|
git clone https://github.com/frappe/frappe_docker
|
|
```
|
|
|
|
step2: add platform: linux/amd64 to all services in the /pwd.yaml
|
|
|
|
here is the update pwd.yml file
|
|
|
|
```yml
|
|
version: "3"
|
|
|
|
services:
|
|
backend:
|
|
image: frappe/erpnext:v15
|
|
platform: linux/amd64
|
|
deploy:
|
|
restart_policy:
|
|
condition: on-failure
|
|
volumes:
|
|
- sites:/home/frappe/frappe-bench/sites
|
|
- logs:/home/frappe/frappe-bench/logs
|
|
|
|
configurator:
|
|
image: frappe/erpnext:v15
|
|
platform: linux/amd64
|
|
deploy:
|
|
restart_policy:
|
|
condition: none
|
|
entrypoint:
|
|
- bash
|
|
- -c
|
|
# add redis_socketio for backward compatibility
|
|
command:
|
|
- >
|
|
ls -1 apps > sites/apps.txt;
|
|
bench set-config -g db_host $$DB_HOST;
|
|
bench set-config -gp db_port $$DB_PORT;
|
|
bench set-config -g redis_cache "redis://$$REDIS_CACHE";
|
|
bench set-config -g redis_queue "redis://$$REDIS_QUEUE";
|
|
bench set-config -g redis_socketio "redis://$$REDIS_QUEUE";
|
|
bench set-config -gp socketio_port $$SOCKETIO_PORT;
|
|
environment:
|
|
DB_HOST: db
|
|
DB_PORT: "3306"
|
|
REDIS_CACHE: redis-cache:6379
|
|
REDIS_QUEUE: redis-queue:6379
|
|
SOCKETIO_PORT: "9000"
|
|
volumes:
|
|
- sites:/home/frappe/frappe-bench/sites
|
|
- logs:/home/frappe/frappe-bench/logs
|
|
|
|
create-site:
|
|
image: frappe/erpnext:v15
|
|
platform: linux/amd64
|
|
deploy:
|
|
restart_policy:
|
|
condition: none
|
|
volumes:
|
|
- sites:/home/frappe/frappe-bench/sites
|
|
- logs:/home/frappe/frappe-bench/logs
|
|
entrypoint:
|
|
- bash
|
|
- -c
|
|
command:
|
|
- >
|
|
wait-for-it -t 120 db:3306;
|
|
wait-for-it -t 120 redis-cache:6379;
|
|
wait-for-it -t 120 redis-queue:6379;
|
|
export start=`date +%s`;
|
|
until [[ -n `grep -hs ^ sites/common_site_config.json | jq -r ".db_host // empty"` ]] && \
|
|
[[ -n `grep -hs ^ sites/common_site_config.json | jq -r ".redis_cache // empty"` ]] && \
|
|
[[ -n `grep -hs ^ sites/common_site_config.json | jq -r ".redis_queue // empty"` ]];
|
|
do
|
|
echo "Waiting for sites/common_site_config.json to be created";
|
|
sleep 5;
|
|
if (( `date +%s`-start > 120 )); then
|
|
echo "could not find sites/common_site_config.json with required keys";
|
|
exit 1
|
|
fi
|
|
done;
|
|
echo "sites/common_site_config.json found";
|
|
bench new-site --mariadb-user-host-login-scope=% --admin-password=admin --db-root-password=admin --install-app erpnext --set-default frontend;
|
|
|
|
db:
|
|
image: mariadb:10.6
|
|
platform: linux/amd64
|
|
healthcheck:
|
|
test: mysqladmin ping -h localhost --password=admin
|
|
interval: 1s
|
|
retries: 20
|
|
deploy:
|
|
restart_policy:
|
|
condition: on-failure
|
|
command:
|
|
- --character-set-server=utf8mb4
|
|
- --collation-server=utf8mb4_unicode_ci
|
|
- --skip-character-set-client-handshake
|
|
- --skip-innodb-read-only-compressed # Temporary fix for MariaDB 10.6
|
|
environment:
|
|
MYSQL_ROOT_PASSWORD: admin
|
|
volumes:
|
|
- db-data:/var/lib/mysql
|
|
|
|
frontend:
|
|
image: frappe/erpnext:v15
|
|
platform: linux/amd64
|
|
depends_on:
|
|
- websocket
|
|
deploy:
|
|
restart_policy:
|
|
condition: on-failure
|
|
command:
|
|
- nginx-entrypoint.sh
|
|
environment:
|
|
BACKEND: backend:8000
|
|
FRAPPE_SITE_NAME_HEADER: frontend
|
|
SOCKETIO: websocket:9000
|
|
UPSTREAM_REAL_IP_ADDRESS: 127.0.0.1
|
|
UPSTREAM_REAL_IP_HEADER: X-Forwarded-For
|
|
UPSTREAM_REAL_IP_RECURSIVE: "off"
|
|
PROXY_READ_TIMEOUT: 120
|
|
CLIENT_MAX_BODY_SIZE: 50m
|
|
volumes:
|
|
- sites:/home/frappe/frappe-bench/sites
|
|
- logs:/home/frappe/frappe-bench/logs
|
|
ports:
|
|
- "8080:8080"
|
|
|
|
queue-long:
|
|
image: frappe/erpnext:v15
|
|
platform: linux/amd64
|
|
deploy:
|
|
restart_policy:
|
|
condition: on-failure
|
|
command:
|
|
- bench
|
|
- worker
|
|
- --queue
|
|
- long,default,short
|
|
volumes:
|
|
- sites:/home/frappe/frappe-bench/sites
|
|
- logs:/home/frappe/frappe-bench/logs
|
|
|
|
queue-short:
|
|
image: frappe/erpnext:v15
|
|
platform: linux/amd64
|
|
deploy:
|
|
restart_policy:
|
|
condition: on-failure
|
|
command:
|
|
- bench
|
|
- worker
|
|
- --queue
|
|
- short,default
|
|
volumes:
|
|
- sites:/home/frappe/frappe-bench/sites
|
|
- logs:/home/frappe/frappe-bench/logs
|
|
|
|
redis-queue:
|
|
image: redis:6.2-alpine
|
|
platform: linux/amd64
|
|
deploy:
|
|
restart_policy:
|
|
condition: on-failure
|
|
volumes:
|
|
- redis-queue-data:/data
|
|
|
|
redis-cache:
|
|
image: redis:6.2-alpine
|
|
platform: linux/amd64
|
|
deploy:
|
|
restart_policy:
|
|
condition: on-failure
|
|
|
|
scheduler:
|
|
image: frappe/erpnext:v15
|
|
platform: linux/amd64
|
|
deploy:
|
|
restart_policy:
|
|
condition: on-failure
|
|
command:
|
|
- bench
|
|
- schedule
|
|
volumes:
|
|
- sites:/home/frappe/frappe-bench/sites
|
|
- logs:/home/frappe/frappe-bench/logs
|
|
|
|
websocket:
|
|
image: frappe/erpnext:v15
|
|
platform: linux/amd64
|
|
deploy:
|
|
restart_policy:
|
|
condition: on-failure
|
|
command:
|
|
- node
|
|
- /home/frappe/frappe-bench/apps/frappe/socketio.js
|
|
volumes:
|
|
- sites:/home/frappe/frappe-bench/sites
|
|
- logs:/home/frappe/frappe-bench/logs
|
|
|
|
volumes:
|
|
db-data:
|
|
redis-queue-data:
|
|
sites:
|
|
logs:
|
|
```
|
|
|
|
step3: run the docker
|
|
|
|
```
|
|
cd frappe_docker
|
|
```
|
|
|
|
```
|
|
docker-compose -f ./pwd.yml up
|
|
```
|
|
|
|
---
|
|
|
|
Wait for couple of minutes.
|
|
|
|
Open localhost:8080
|