mirror of
https://github.com/frappe/frappe_docker.git
synced 2026-06-17 13:55:08 +00:00
Compare commits
No commits in common. "main" and "v2.0.1" have entirely different histories.
98 changed files with 447 additions and 4593 deletions
10
.github/scripts/get_latest_tags.py
vendored
10
.github/scripts/get_latest_tags.py
vendored
|
|
@ -49,13 +49,6 @@ def update_env(file_name: str, frappe_tag: str, erpnext_tag: str | None = None):
|
|||
f.write(text)
|
||||
|
||||
|
||||
def update_output(file_name: str, frappe_tag: str, erpnext_tag: str | None = None):
|
||||
with open(file_name, "a", encoding="utf-8") as f:
|
||||
f.write(f"frappe_version={frappe_tag}\n")
|
||||
if erpnext_tag:
|
||||
f.write(f"erpnext_version={erpnext_tag}\n")
|
||||
|
||||
|
||||
def _print_resp(frappe_tag: str, erpnext_tag: str | None = None):
|
||||
print(json.dumps({"frappe": frappe_tag, "erpnext": erpnext_tag}))
|
||||
|
||||
|
|
@ -77,9 +70,6 @@ def main(_args: list[str]) -> int:
|
|||
file_name = os.getenv("GITHUB_ENV")
|
||||
if file_name:
|
||||
update_env(file_name, frappe_tag, erpnext_tag)
|
||||
file_name = os.getenv("GITHUB_OUTPUT")
|
||||
if file_name:
|
||||
update_output(file_name, frappe_tag, erpnext_tag)
|
||||
_print_resp(frappe_tag, erpnext_tag)
|
||||
return 0
|
||||
|
||||
|
|
|
|||
189
.github/workflows/app-build-image.yml
vendored
189
.github/workflows/app-build-image.yml
vendored
|
|
@ -1,189 +0,0 @@
|
|||
name: App / Build Image
|
||||
|
||||
on:
|
||||
workflow_call:
|
||||
inputs:
|
||||
app_name:
|
||||
required: true
|
||||
type: string
|
||||
description: "App module and image name, for example 'crm'"
|
||||
app_repo:
|
||||
required: true
|
||||
type: string
|
||||
description: "Git URL or GitHub slug for the app repository"
|
||||
app_ref:
|
||||
required: true
|
||||
type: string
|
||||
description: "Git branch or tag to install for the app"
|
||||
frappe_ref:
|
||||
required: true
|
||||
type: string
|
||||
description: "Tag of the existing frappe/base and frappe/build images, for example version-16"
|
||||
frappe_image_prefix:
|
||||
required: false
|
||||
type: string
|
||||
default: frappe
|
||||
description: "Image prefix for existing base and build images, for example 'frappe' or 'ghcr.io/frappe'"
|
||||
image_name:
|
||||
required: true
|
||||
type: string
|
||||
description: "Full image name, for example ghcr.io/frappe/crm"
|
||||
image_tag:
|
||||
required: true
|
||||
type: string
|
||||
description: "Image tag, for example develop or v16.0.0"
|
||||
push:
|
||||
required: true
|
||||
type: boolean
|
||||
registry:
|
||||
required: false
|
||||
type: string
|
||||
default: docker.io
|
||||
frappe_repo:
|
||||
required: false
|
||||
type: string
|
||||
default: https://github.com/frappe/frappe
|
||||
description: "Git URL for the Frappe framework repository"
|
||||
builder_repository:
|
||||
required: false
|
||||
type: string
|
||||
default: frappe/frappe_docker
|
||||
description: "Repository that contains the Containerfile and helper scripts"
|
||||
builder_ref:
|
||||
required: false
|
||||
type: string
|
||||
default: main
|
||||
description: "Ref to checkout from the builder repository"
|
||||
platforms:
|
||||
required: false
|
||||
type: string
|
||||
default: linux/amd64
|
||||
description: "Docker platforms for the final build"
|
||||
secrets:
|
||||
REGISTRY_USERNAME:
|
||||
required: false
|
||||
REGISTRY_PASSWORD:
|
||||
required: false
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
packages: write
|
||||
|
||||
concurrency:
|
||||
group: app-image-${{ github.repository }}-${{ inputs.app_name }}-${{ inputs.app_ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 30
|
||||
env:
|
||||
BUILDER_DIR: builder
|
||||
APPS_JSON_PATH: builder/.github/tmp/apps.json
|
||||
CACHE_SCOPE: app-image-${{ inputs.app_name }}-${{ inputs.frappe_ref }}
|
||||
TEST_IMAGE: local/${{ inputs.app_name }}:${{ github.run_id }}-${{ github.run_attempt }}
|
||||
FINAL_IMAGE: ${{ inputs.image_name }}:${{ inputs.image_tag }}
|
||||
|
||||
steps:
|
||||
- name: Checkout builder repository
|
||||
uses: actions/checkout@v6
|
||||
with:
|
||||
repository: ${{ inputs.builder_repository }}
|
||||
ref: ${{ inputs.builder_ref }}
|
||||
path: ${{ env.BUILDER_DIR }}
|
||||
|
||||
- name: Setup QEMU
|
||||
uses: docker/setup-qemu-action@v4
|
||||
with:
|
||||
image: tonistiigi/binfmt:latest
|
||||
platforms: all
|
||||
|
||||
- name: Setup Buildx
|
||||
uses: docker/setup-buildx-action@v4
|
||||
|
||||
- name: Create apps.json
|
||||
env:
|
||||
APP_REPO: ${{ inputs.app_repo }}
|
||||
APP_REF: ${{ inputs.app_ref }}
|
||||
APPS_JSON_PATH: ${{ env.APPS_JSON_PATH }}
|
||||
run: |
|
||||
mkdir -p "$(dirname "$APPS_JSON_PATH")"
|
||||
python3 - <<'PY'
|
||||
import json
|
||||
import os
|
||||
from pathlib import Path
|
||||
|
||||
repo = os.environ["APP_REPO"].strip()
|
||||
ref = os.environ["APP_REF"].strip()
|
||||
|
||||
if repo.count("/") == 1 and not repo.startswith(("https://", "http://")):
|
||||
repo = f"https://github.com/{repo}"
|
||||
|
||||
for prefix in ("refs/heads/", "refs/tags/"):
|
||||
if ref.startswith(prefix):
|
||||
ref = ref.removeprefix(prefix)
|
||||
|
||||
Path(os.environ["APPS_JSON_PATH"]).write_text(
|
||||
json.dumps([{"url": repo, "branch": ref}], indent=2) + "\n",
|
||||
encoding="utf-8",
|
||||
)
|
||||
PY
|
||||
|
||||
- name: Build smoke-test image
|
||||
uses: docker/build-push-action@v7
|
||||
with:
|
||||
context: ${{ env.BUILDER_DIR }}
|
||||
file: ${{ env.BUILDER_DIR }}/images/layered/Containerfile
|
||||
build-args: |
|
||||
FRAPPE_IMAGE_PREFIX=${{ inputs.frappe_image_prefix }}
|
||||
FRAPPE_PATH=${{ inputs.frappe_repo }}
|
||||
FRAPPE_BRANCH=${{ inputs.frappe_ref }}
|
||||
cache-from: type=gha,scope=${{ env.CACHE_SCOPE }}
|
||||
cache-to: type=gha,mode=max,scope=${{ env.CACHE_SCOPE }}
|
||||
load: true
|
||||
platforms: linux/amd64
|
||||
secrets: |
|
||||
id=apps_json,src=${{ env.APPS_JSON_PATH }}
|
||||
tags: ${{ env.TEST_IMAGE }}
|
||||
|
||||
- name: Smoke test image contents
|
||||
env:
|
||||
APP_NAME: ${{ inputs.app_name }}
|
||||
TEST_IMAGE: ${{ env.TEST_IMAGE }}
|
||||
run: |
|
||||
docker run --rm --entrypoint bash "$TEST_IMAGE" -lc \
|
||||
"test -d /home/frappe/frappe-bench/apps/frappe && test -d /home/frappe/frappe-bench/apps/${APP_NAME}"
|
||||
|
||||
- name: Login to GHCR
|
||||
if: ${{ inputs.push && inputs.registry == 'ghcr.io' }}
|
||||
uses: docker/login-action@v4
|
||||
with:
|
||||
registry: ghcr.io
|
||||
username: ${{ github.actor }}
|
||||
password: ${{ github.token }}
|
||||
|
||||
- name: Login to target registry
|
||||
if: ${{ inputs.push && inputs.registry != 'ghcr.io' }}
|
||||
uses: docker/login-action@v4
|
||||
with:
|
||||
registry: ${{ inputs.registry }}
|
||||
username: ${{ secrets.REGISTRY_USERNAME }}
|
||||
password: ${{ secrets.REGISTRY_PASSWORD }}
|
||||
|
||||
- name: Push multi-arch image
|
||||
if: ${{ inputs.push }}
|
||||
uses: docker/build-push-action@v7
|
||||
with:
|
||||
context: ${{ env.BUILDER_DIR }}
|
||||
file: ${{ env.BUILDER_DIR }}/images/layered/Containerfile
|
||||
build-args: |
|
||||
FRAPPE_IMAGE_PREFIX=${{ inputs.frappe_image_prefix }}
|
||||
FRAPPE_PATH=${{ inputs.frappe_repo }}
|
||||
FRAPPE_BRANCH=${{ inputs.frappe_ref }}
|
||||
cache-from: type=gha,scope=${{ env.CACHE_SCOPE }}
|
||||
cache-to: type=gha,mode=max,scope=${{ env.CACHE_SCOPE }}
|
||||
platforms: ${{ inputs.platforms }}
|
||||
push: true
|
||||
secrets: |
|
||||
id=apps_json,src=${{ env.APPS_JSON_PATH }}
|
||||
tags: ${{ env.FINAL_IMAGE }}
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
name: Core / Build Bench
|
||||
name: Bench
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
|
|
@ -7,7 +7,7 @@ on:
|
|||
paths:
|
||||
- images/bench/**
|
||||
- docker-bake.hcl
|
||||
- .github/workflows/core-build-bench.yml
|
||||
- .github/workflows/build_bench.yml
|
||||
|
||||
schedule:
|
||||
# Every day at 12:00 pm
|
||||
|
|
@ -23,13 +23,13 @@ jobs:
|
|||
uses: actions/checkout@v6
|
||||
|
||||
- name: Setup QEMU
|
||||
uses: docker/setup-qemu-action@v4
|
||||
uses: docker/setup-qemu-action@v3
|
||||
with:
|
||||
image: tonistiigi/binfmt:latest
|
||||
platforms: all
|
||||
|
||||
- name: Setup Buildx
|
||||
uses: docker/setup-buildx-action@v4
|
||||
uses: docker/setup-buildx-action@v3
|
||||
|
||||
- name: Set Environment Variables
|
||||
run: cat example.env | grep -o '^[^#]*' >> "$GITHUB_ENV"
|
||||
|
|
@ -38,21 +38,21 @@ jobs:
|
|||
run: echo "LATEST_BENCH_RELEASE=$(curl -s 'https://api.github.com/repos/frappe/bench/releases/latest' | jq -r '.tag_name')" >> "$GITHUB_ENV"
|
||||
|
||||
- name: Build and test
|
||||
uses: docker/bake-action@v7.2.0
|
||||
uses: docker/bake-action@v6.10.0
|
||||
with:
|
||||
source: .
|
||||
targets: bench-test
|
||||
|
||||
- name: Login
|
||||
if: ${{ github.repository == 'frappe/frappe_docker' && github.event_name != 'pull_request' }}
|
||||
uses: docker/login-action@v4
|
||||
uses: docker/login-action@v3
|
||||
with:
|
||||
username: ${{ secrets.DOCKERHUB_USERNAME }}
|
||||
password: ${{ secrets.DOCKERHUB_TOKEN }}
|
||||
|
||||
- name: Push
|
||||
if: ${{ github.repository == 'frappe/frappe_docker' && github.event_name != 'pull_request' }}
|
||||
uses: docker/bake-action@v7.2.0
|
||||
uses: docker/bake-action@v6.10.0
|
||||
with:
|
||||
targets: bench
|
||||
push: true
|
||||
35
.github/workflows/build_develop.yml
vendored
35
.github/workflows/build_develop.yml
vendored
|
|
@ -1,12 +1,33 @@
|
|||
name: Legacy / Build Develop
|
||||
name: Develop build
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
branches:
|
||||
- main
|
||||
paths:
|
||||
- images/production/**
|
||||
- overrides/**
|
||||
- tests/**
|
||||
- compose.yaml
|
||||
- docker-bake.hcl
|
||||
- example.env
|
||||
- .github/workflows/build_develop.yml
|
||||
|
||||
schedule:
|
||||
# Every day at 12:00 pm
|
||||
- cron: 0 0 * * *
|
||||
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
delegate:
|
||||
uses: ./.github/workflows/core-build-develop.yml
|
||||
permissions:
|
||||
contents: read
|
||||
packages: write
|
||||
secrets: inherit
|
||||
build:
|
||||
uses: ./.github/workflows/docker-build-push.yml
|
||||
with:
|
||||
repo: erpnext
|
||||
version: develop
|
||||
push: ${{ github.repository == 'frappe/frappe_docker' && github.event_name != 'pull_request' }}
|
||||
python_version: 3.14.2
|
||||
node_version: 24.12.0
|
||||
secrets:
|
||||
DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
|
||||
DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}
|
||||
|
|
|
|||
130
.github/workflows/build_stable.yml
vendored
130
.github/workflows/build_stable.yml
vendored
|
|
@ -1,12 +1,128 @@
|
|||
name: Legacy / Build Stable
|
||||
name: Stable build
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
branches:
|
||||
- main
|
||||
paths:
|
||||
- images/production/**
|
||||
- overrides/**
|
||||
- tests/**
|
||||
- compose.yaml
|
||||
- docker-bake.hcl
|
||||
- example.env
|
||||
- .github/workflows/build_stable.yml
|
||||
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
paths:
|
||||
- images/production/**
|
||||
- overrides/**
|
||||
- tests/**
|
||||
- compose.yaml
|
||||
- docker-bake.hcl
|
||||
- example.env
|
||||
|
||||
# Triggered from frappe/frappe and frappe/erpnext on releases
|
||||
repository_dispatch:
|
||||
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
delegate:
|
||||
uses: ./.github/workflows/core-build-stable.yml
|
||||
permissions:
|
||||
contents: write
|
||||
packages: write
|
||||
secrets: inherit
|
||||
v14:
|
||||
uses: ./.github/workflows/docker-build-push.yml
|
||||
with:
|
||||
repo: erpnext
|
||||
version: "14"
|
||||
push: ${{ github.repository == 'frappe/frappe_docker' && github.event_name != 'pull_request' }}
|
||||
python_version: 3.10.13
|
||||
node_version: 16.20.2
|
||||
secrets:
|
||||
DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
|
||||
DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}
|
||||
|
||||
v15:
|
||||
uses: ./.github/workflows/docker-build-push.yml
|
||||
with:
|
||||
repo: erpnext
|
||||
version: "15"
|
||||
push: ${{ github.repository == 'frappe/frappe_docker' && github.event_name != 'pull_request' }}
|
||||
python_version: 3.11.6
|
||||
node_version: 20.19.2
|
||||
secrets:
|
||||
DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
|
||||
DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}
|
||||
|
||||
v16:
|
||||
uses: ./.github/workflows/docker-build-push.yml
|
||||
with:
|
||||
repo: erpnext
|
||||
version: "16"
|
||||
push: ${{ github.repository == 'frappe/frappe_docker' && github.event_name != 'pull_request' }}
|
||||
python_version: 3.14.2
|
||||
node_version: 24.12.0
|
||||
secrets:
|
||||
DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
|
||||
DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}
|
||||
|
||||
update_versions:
|
||||
name: Update example.env and pwd.yml
|
||||
runs-on: ubuntu-latest
|
||||
if: ${{ github.repository == 'frappe/frappe_docker' && github.event_name != 'pull_request' }}
|
||||
needs: v15
|
||||
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Setup Python
|
||||
uses: actions/setup-python@v6
|
||||
with:
|
||||
python-version: "3.10"
|
||||
|
||||
- name: Get latest versions
|
||||
run: python3 ./.github/scripts/get_latest_tags.py --repo erpnext --version 15
|
||||
|
||||
- name: Update
|
||||
run: |
|
||||
python3 ./.github/scripts/update_example_env.py
|
||||
python3 ./.github/scripts/update_pwd.py
|
||||
|
||||
- name: Push
|
||||
run: |
|
||||
git config --global user.name github-actions
|
||||
git config --global user.email github-actions@github.com
|
||||
git add example.env pwd.yml
|
||||
if [ -z "$(git status --porcelain)" ]; then
|
||||
echo "versions did not change, exiting."
|
||||
exit 0
|
||||
else
|
||||
echo "version changed, pushing changes..."
|
||||
git commit -m "chore: Update example.env"
|
||||
git pull --rebase
|
||||
git push origin main
|
||||
fi
|
||||
|
||||
release_helm:
|
||||
name: Release Helm
|
||||
runs-on: ubuntu-latest
|
||||
if: ${{ github.repository == 'frappe/frappe_docker' && github.event_name != 'pull_request' }}
|
||||
needs: v15
|
||||
|
||||
steps:
|
||||
- name: Setup deploy key
|
||||
uses: webfactory/ssh-agent@v0.9.1
|
||||
with:
|
||||
ssh-private-key: ${{ secrets.HELM_DEPLOY_KEY }}
|
||||
|
||||
- name: Setup Git Credentials
|
||||
run: |
|
||||
git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
|
||||
git config --global user.name "github-actions[bot]"
|
||||
|
||||
- name: Release
|
||||
run: |
|
||||
git clone git@github.com:frappe/helm.git && cd helm
|
||||
pip install -r release_wizard/requirements.txt
|
||||
./release_wizard/wizard 16 patch --remote origin --ci
|
||||
|
|
|
|||
51
.github/workflows/core-build-develop.yml
vendored
51
.github/workflows/core-build-develop.yml
vendored
|
|
@ -1,51 +0,0 @@
|
|||
name: Core / Build Develop
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
packages: write
|
||||
|
||||
on:
|
||||
workflow_call:
|
||||
|
||||
pull_request:
|
||||
branches:
|
||||
- main
|
||||
paths:
|
||||
- images/production/**
|
||||
- overrides/**
|
||||
- tests/**
|
||||
- compose.yaml
|
||||
- docker-bake.hcl
|
||||
- example.env
|
||||
- .github/workflows/core-build-develop.yml
|
||||
- .github/workflows/core-build-test-images.yml
|
||||
- .github/workflows/core-publish-images.yml
|
||||
|
||||
schedule:
|
||||
# Every day at 12:00 pm
|
||||
- cron: 0 0 * * *
|
||||
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
test:
|
||||
uses: ./.github/workflows/core-build-test-images.yml
|
||||
with:
|
||||
repo: erpnext
|
||||
version: develop
|
||||
python_version: 3.14.2
|
||||
node_version: 24.12.0
|
||||
|
||||
publish:
|
||||
if: ${{ github.repository == 'frappe/frappe_docker' && github.event_name != 'pull_request' }}
|
||||
needs: test
|
||||
uses: ./.github/workflows/core-publish-images.yml
|
||||
with:
|
||||
repo: erpnext
|
||||
frappe_version: ${{ needs.test.outputs.frappe_version }}
|
||||
erpnext_version: ${{ needs.test.outputs.erpnext_version }}
|
||||
python_version: 3.14.2
|
||||
node_version: 24.12.0
|
||||
secrets:
|
||||
DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
|
||||
DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}
|
||||
148
.github/workflows/core-build-stable.yml
vendored
148
.github/workflows/core-build-stable.yml
vendored
|
|
@ -1,148 +0,0 @@
|
|||
name: Core / Build Stable
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
packages: write
|
||||
|
||||
on:
|
||||
workflow_call:
|
||||
|
||||
pull_request:
|
||||
branches:
|
||||
- main
|
||||
paths:
|
||||
- images/production/**
|
||||
- overrides/**
|
||||
- tests/**
|
||||
- compose.yaml
|
||||
- docker-bake.hcl
|
||||
- example.env
|
||||
- .github/workflows/core-build-stable.yml
|
||||
- .github/workflows/core-build-test-images.yml
|
||||
- .github/workflows/core-publish-images.yml
|
||||
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
paths:
|
||||
- images/production/**
|
||||
- overrides/**
|
||||
- tests/**
|
||||
- compose.yaml
|
||||
- docker-bake.hcl
|
||||
- example.env
|
||||
- .github/workflows/core-build-stable.yml
|
||||
- .github/workflows/core-build-test-images.yml
|
||||
- .github/workflows/core-publish-images.yml
|
||||
|
||||
# Triggered from frappe/frappe and frappe/erpnext on releases
|
||||
repository_dispatch:
|
||||
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
v15_test:
|
||||
uses: ./.github/workflows/core-build-test-images.yml
|
||||
with:
|
||||
repo: erpnext
|
||||
version: "15"
|
||||
python_version: 3.11.6
|
||||
node_version: 20.19.2
|
||||
|
||||
v15_publish:
|
||||
if: ${{ github.repository == 'frappe/frappe_docker' && github.event_name != 'pull_request' }}
|
||||
needs: v15_test
|
||||
uses: ./.github/workflows/core-publish-images.yml
|
||||
with:
|
||||
repo: erpnext
|
||||
frappe_version: ${{ needs.v15_test.outputs.frappe_version }}
|
||||
erpnext_version: ${{ needs.v15_test.outputs.erpnext_version }}
|
||||
python_version: 3.11.6
|
||||
node_version: 20.19.2
|
||||
secrets:
|
||||
DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
|
||||
DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}
|
||||
|
||||
v16_test:
|
||||
uses: ./.github/workflows/core-build-test-images.yml
|
||||
with:
|
||||
repo: erpnext
|
||||
version: "16"
|
||||
python_version: 3.14.2
|
||||
node_version: 24.12.0
|
||||
v16_publish:
|
||||
if: ${{ github.repository == 'frappe/frappe_docker' && github.event_name != 'pull_request' }}
|
||||
needs: v16_test
|
||||
uses: ./.github/workflows/core-publish-images.yml
|
||||
with:
|
||||
repo: erpnext
|
||||
frappe_version: ${{ needs.v16_test.outputs.frappe_version }}
|
||||
erpnext_version: ${{ needs.v16_test.outputs.erpnext_version }}
|
||||
python_version: 3.14.2
|
||||
node_version: 24.12.0
|
||||
secrets:
|
||||
DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
|
||||
DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}
|
||||
|
||||
update_versions:
|
||||
name: Update example.env and pwd.yml
|
||||
runs-on: ubuntu-latest
|
||||
if: ${{ github.repository == 'frappe/frappe_docker' && github.event_name != 'pull_request' }}
|
||||
needs: v16_publish
|
||||
permissions:
|
||||
contents: write
|
||||
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Setup Python
|
||||
uses: actions/setup-python@v6
|
||||
with:
|
||||
python-version: "3.14.2"
|
||||
|
||||
- name: Get latest versions
|
||||
run: python3 ./.github/scripts/get_latest_tags.py --repo erpnext --version 16
|
||||
|
||||
- name: Update
|
||||
run: |
|
||||
python3 ./.github/scripts/update_example_env.py
|
||||
python3 ./.github/scripts/update_pwd.py
|
||||
|
||||
- name: Push
|
||||
run: |
|
||||
git config --global user.name github-actions
|
||||
git config --global user.email github-actions@github.com
|
||||
git add example.env pwd.yml
|
||||
if [ -z "$(git status --porcelain)" ]; then
|
||||
echo "versions did not change, exiting."
|
||||
exit 0
|
||||
else
|
||||
echo "version changed, pushing changes..."
|
||||
git commit -m "chore: Update example.env"
|
||||
git pull --rebase
|
||||
git push origin main
|
||||
fi
|
||||
|
||||
release_helm:
|
||||
name: Release Helm
|
||||
runs-on: ubuntu-latest
|
||||
if: ${{ github.repository == 'frappe/frappe_docker' && github.event_name != 'pull_request' }}
|
||||
needs: v16_publish
|
||||
|
||||
steps:
|
||||
- name: Setup deploy key
|
||||
uses: webfactory/ssh-agent@v0.10.0
|
||||
with:
|
||||
ssh-private-key: ${{ secrets.HELM_DEPLOY_KEY }}
|
||||
|
||||
- name: Setup Git Credentials
|
||||
run: |
|
||||
git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
|
||||
git config --global user.name "github-actions[bot]"
|
||||
|
||||
- name: Release
|
||||
run: |
|
||||
git clone git@github.com:frappe/helm.git && cd helm
|
||||
pip install -r release_wizard/requirements.txt
|
||||
./release_wizard/wizard 16 patch --remote origin --ci
|
||||
92
.github/workflows/core-publish-images.yml
vendored
92
.github/workflows/core-publish-images.yml
vendored
|
|
@ -1,92 +0,0 @@
|
|||
name: Core / Publish Images
|
||||
|
||||
on:
|
||||
workflow_call:
|
||||
inputs:
|
||||
repo:
|
||||
required: true
|
||||
type: string
|
||||
description: "'erpnext' or 'frappe'"
|
||||
frappe_version:
|
||||
required: true
|
||||
type: string
|
||||
description: "Resolved frappe image tag"
|
||||
erpnext_version:
|
||||
required: false
|
||||
type: string
|
||||
description: "Resolved erpnext image tag"
|
||||
python_version:
|
||||
required: true
|
||||
type: string
|
||||
description: Python Version
|
||||
node_version:
|
||||
required: true
|
||||
type: string
|
||||
description: NodeJS Version
|
||||
secrets:
|
||||
DOCKERHUB_USERNAME:
|
||||
required: true
|
||||
DOCKERHUB_TOKEN:
|
||||
required: true
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
packages: write
|
||||
|
||||
jobs:
|
||||
publish:
|
||||
name: Publish
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Setup QEMU
|
||||
uses: docker/setup-qemu-action@v4
|
||||
with:
|
||||
image: tonistiigi/binfmt:latest
|
||||
platforms: all
|
||||
|
||||
- name: Setup Buildx
|
||||
uses: docker/setup-buildx-action@v4
|
||||
|
||||
- name: Set resolved versions
|
||||
run: |
|
||||
echo "FRAPPE_VERSION=${{ inputs.frappe_version }}" >> "$GITHUB_ENV"
|
||||
if [ -n "${{ inputs.erpnext_version }}" ]; then
|
||||
echo "ERPNEXT_VERSION=${{ inputs.erpnext_version }}" >> "$GITHUB_ENV"
|
||||
fi
|
||||
|
||||
- name: Set build args
|
||||
run: |
|
||||
echo "PYTHON_VERSION=${{ inputs.python_version }}" >> "$GITHUB_ENV"
|
||||
echo "NODE_VERSION=${{ inputs.node_version }}" >> "$GITHUB_ENV"
|
||||
|
||||
- name: Login to Docker Hub
|
||||
uses: docker/login-action@v4
|
||||
with:
|
||||
username: ${{ secrets.DOCKERHUB_USERNAME }}
|
||||
password: ${{ secrets.DOCKERHUB_TOKEN }}
|
||||
|
||||
- name: Push Docker Hub images
|
||||
uses: docker/bake-action@v7.2.0
|
||||
with:
|
||||
push: true
|
||||
set: "*.platform=linux/amd64,linux/arm64"
|
||||
|
||||
- name: Login to GHCR
|
||||
uses: docker/login-action@v4
|
||||
with:
|
||||
registry: ghcr.io
|
||||
username: ${{ github.actor }}
|
||||
password: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: Push GHCR base images
|
||||
uses: docker/bake-action@v7.2.0
|
||||
with:
|
||||
targets: base-images
|
||||
push: true
|
||||
set: "*.platform=linux/amd64,linux/arm64"
|
||||
env:
|
||||
REGISTRY_USER: ghcr.io/${{ github.repository_owner }}
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
name: Core / Build and Test Images
|
||||
name: Build
|
||||
|
||||
on:
|
||||
workflow_call:
|
||||
|
|
@ -11,6 +11,9 @@ on:
|
|||
required: true
|
||||
type: string
|
||||
description: "Major version, git tags should match 'v{version}.*'; or 'develop'"
|
||||
push:
|
||||
required: true
|
||||
type: boolean
|
||||
python_version:
|
||||
required: true
|
||||
type: string
|
||||
|
|
@ -19,36 +22,16 @@ on:
|
|||
required: true
|
||||
type: string
|
||||
description: NodeJS Version
|
||||
outputs:
|
||||
frappe_version:
|
||||
description: "Resolved frappe image tag"
|
||||
value: ${{ jobs.resolve.outputs.frappe_version }}
|
||||
erpnext_version:
|
||||
description: "Resolved erpnext image tag"
|
||||
value: ${{ jobs.resolve.outputs.erpnext_version }}
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
secrets:
|
||||
DOCKERHUB_USERNAME:
|
||||
required: true
|
||||
DOCKERHUB_TOKEN:
|
||||
required: true
|
||||
|
||||
jobs:
|
||||
resolve:
|
||||
name: Resolve Versions
|
||||
runs-on: ubuntu-latest
|
||||
outputs:
|
||||
frappe_version: ${{ steps.resolve.outputs.frappe_version }}
|
||||
erpnext_version: ${{ steps.resolve.outputs.erpnext_version }}
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Resolve image versions
|
||||
id: resolve
|
||||
run: python3 ./.github/scripts/get_latest_tags.py --repo ${{ inputs.repo }} --version ${{ inputs.version }}
|
||||
|
||||
build:
|
||||
name: Build
|
||||
runs-on: ubuntu-latest
|
||||
needs: resolve
|
||||
services:
|
||||
registry:
|
||||
image: docker.io/registry:2
|
||||
|
|
@ -63,23 +46,19 @@ jobs:
|
|||
uses: actions/checkout@v6
|
||||
|
||||
- name: Setup QEMU
|
||||
uses: docker/setup-qemu-action@v4
|
||||
uses: docker/setup-qemu-action@v3
|
||||
with:
|
||||
image: tonistiigi/binfmt:latest
|
||||
platforms: all
|
||||
|
||||
- name: Setup Buildx
|
||||
uses: docker/setup-buildx-action@v4
|
||||
uses: docker/setup-buildx-action@v3
|
||||
with:
|
||||
driver-opts: network=host
|
||||
platforms: linux/${{ matrix.arch }}
|
||||
|
||||
- name: Set resolved versions
|
||||
run: |
|
||||
echo "FRAPPE_VERSION=${{ needs.resolve.outputs.frappe_version }}" >> "$GITHUB_ENV"
|
||||
if [ -n "${{ needs.resolve.outputs.erpnext_version }}" ]; then
|
||||
echo "ERPNEXT_VERSION=${{ needs.resolve.outputs.erpnext_version }}" >> "$GITHUB_ENV"
|
||||
fi
|
||||
- name: Get latest versions
|
||||
run: python3 ./.github/scripts/get_latest_tags.py --repo ${{ inputs.repo }} --version ${{ inputs.version }}
|
||||
|
||||
- name: Set build args
|
||||
run: |
|
||||
|
|
@ -87,7 +66,7 @@ jobs:
|
|||
echo "NODE_VERSION=${{ inputs.node_version }}" >> "$GITHUB_ENV"
|
||||
|
||||
- name: Build
|
||||
uses: docker/bake-action@v7.2.0
|
||||
uses: docker/bake-action@v6.10.0
|
||||
with:
|
||||
source: .
|
||||
push: true
|
||||
|
|
@ -106,3 +85,17 @@ jobs:
|
|||
|
||||
- name: Test
|
||||
run: venv/bin/pytest --color=yes
|
||||
|
||||
- name: Login
|
||||
if: ${{ inputs.push }}
|
||||
uses: docker/login-action@v3
|
||||
with:
|
||||
username: ${{ secrets.DOCKERHUB_USERNAME }}
|
||||
password: ${{ secrets.DOCKERHUB_TOKEN }}
|
||||
|
||||
- name: Push
|
||||
if: ${{ inputs.push }}
|
||||
uses: docker/bake-action@v6.10.0
|
||||
with:
|
||||
push: true
|
||||
set: "*.platform=linux/amd64,linux/arm64"
|
||||
66
.github/workflows/docs-publish-site.yml
vendored
66
.github/workflows/docs-publish-site.yml
vendored
|
|
@ -1,66 +0,0 @@
|
|||
name: Docs / Publish Site
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
paths:
|
||||
- "docs/**"
|
||||
- ".github/workflows/docs-publish-site.yml"
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
pages: write
|
||||
id-token: write
|
||||
|
||||
defaults:
|
||||
run:
|
||||
working-directory: ./docs
|
||||
|
||||
concurrency:
|
||||
group: pages
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
build-and-deploy:
|
||||
runs-on: ubuntu-latest
|
||||
strategy:
|
||||
matrix:
|
||||
node-version: [24]
|
||||
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Use Node.js ${{ matrix.node-version }}
|
||||
uses: actions/setup-node@v6
|
||||
with:
|
||||
node-version: ${{ matrix.node-version }}
|
||||
|
||||
- name: Enable Corepack
|
||||
run: corepack enable
|
||||
|
||||
- name: Activate pnpm
|
||||
run: corepack prepare pnpm@10.28.2 --activate
|
||||
|
||||
- name: Show tool versions
|
||||
run: |
|
||||
node --version
|
||||
corepack --version
|
||||
pnpm --version
|
||||
which pnpm
|
||||
|
||||
- name: Install dependencies
|
||||
run: pnpm i --frozen-lockfile
|
||||
|
||||
- name: Build Docs site
|
||||
run: pnpm docs:build
|
||||
|
||||
- name: Upload artifact
|
||||
uses: actions/upload-pages-artifact@v5
|
||||
with:
|
||||
path: docs/.vitepress/dist
|
||||
|
||||
- name: Deploy to GitHub Pages
|
||||
id: deployment
|
||||
uses: actions/deploy-pages@v5
|
||||
1
.github/workflows/stale.yml
vendored
1
.github/workflows/stale.yml
vendored
|
|
@ -16,4 +16,3 @@ jobs:
|
|||
stale-pr-message: This PR has been automatically marked as stale. You have a week to explain why you believe this is an error.
|
||||
stale-issue-label: no-issue-activity
|
||||
stale-pr-label: no-pr-activity
|
||||
exempt-issue-labels: keep-open
|
||||
|
|
|
|||
4
.gitignore
vendored
4
.gitignore
vendored
|
|
@ -28,7 +28,3 @@ venv
|
|||
|
||||
# NodeJS
|
||||
node_modules
|
||||
|
||||
# VitePress
|
||||
**/.vitepress/dist
|
||||
**/.vitepress/cache
|
||||
|
|
|
|||
|
|
@ -27,7 +27,6 @@ repos:
|
|||
rev: v4.0.0-alpha.8
|
||||
hooks:
|
||||
- id: prettier
|
||||
exclude: ^docs/pnpm-lock\.yaml$
|
||||
additional_dependencies:
|
||||
- prettier@3.5.2
|
||||
|
||||
|
|
@ -35,7 +34,6 @@ repos:
|
|||
rev: v2.4.1
|
||||
hooks:
|
||||
- id: codespell
|
||||
exclude: ^docs/pnpm-lock\.yaml$
|
||||
args:
|
||||
- -L
|
||||
- "ro"
|
||||
|
|
|
|||
|
|
@ -100,35 +100,9 @@ Run pytest:
|
|||
pytest
|
||||
```
|
||||
|
||||
## Detailed Guidelines
|
||||
|
||||
A detailed form management guidelines are available in the [Fork Management](./docs/08-reference/03-fork-management.md)
|
||||
|
||||
# Documentation
|
||||
|
||||
Documentation is written as markdown files, and placed inside the `docs/` directory. There are multiple sub directories under `docs/`, and be sure to place the `.md` file in the relevant sub directory if you are adding a new page.
|
||||
|
||||
If you want to include any image in the markdown file, place them in the `docs/images/` folder, and add a relative link in the `.md` file. For example if there is a `diagram.png` in the `docs/images/` directory, which has to be shown in a markdown file called `docs/01-getting-started/01-choosing-a-deployment-method.md` the image has to be referenced as,
|
||||
|
||||
```
|
||||
|
||||
```
|
||||
|
||||
Frappe Docker also have a static site version of the documentation, which is made using the same `.md` files in the `docs/` directory. Build pipeline uses [VitePress](https://vitepress.dev/) as the Static Site builder, which is a JavaScript (TypeScript) static site builder. Note that to contribute to the documentation JavaScript or VitePress knowledge is not needed. Updating the `.md` file is enough.
|
||||
|
||||
The only additional content needed that is specific to VitePress, is a ['frontmatter'](https://vitepress.dev/guide/frontmatter#frontmatter). Frontmatter is like the `metadata` or `config` of that specific `.md` file, added at the beginning of the file and enclosed in `---`. For example, the frontmatter can include a friendly title, author, date of publishing, etc. A more detailed overview on what is frontmatter can be found in this [blog](https://www.seancdavis.com/posts/wtf-is-frontmatter/).
|
||||
|
||||
In this project only one field is used in the frontmatter. The `title` field. This is used to specify the title of the page shown in the sidebar, which is either same or a simpler and smaller version of the first heading `#` of the page. To add the required frontmatter just add a block at the beginning of the `.md` file as shown below
|
||||
|
||||
```yaml
|
||||
---
|
||||
title: <short-title-for-sidebar>
|
||||
---
|
||||
```
|
||||
|
||||
In case of any doubt, just refer to any of the existing `.md` file. Also checkout the Markdown section in the VitePress documentation to see some additional features supported by VitePress: [Markdown Extensions](https://vitepress.dev/guide/markdown). Be careful not to break compatibility with what is supported by GitHub markdown. It is recommended to keep the documentation simple.
|
||||
|
||||
If you want details on how to configure or update VitePress specific settings and and functionalities, refer this page: [Configuring VitePress](https://github.com/frappe/frappe_docker/blob/main/docs/08-reference/02-configuring-vitepress.md)
|
||||
Place relevant markdown files in the `docs` directory and index them in README.md located at the root of repo.
|
||||
|
||||
# Frappe and ERPNext updates
|
||||
|
||||
|
|
@ -143,4 +117,4 @@ In case of new release of Debian. e.g. bullseye to bookworm. Change following fi
|
|||
|
||||
Change following files on release of ERPNext
|
||||
|
||||
- `.github/workflows/core-build-stable.yml`: Add the new release step under `jobs` and remove the unmaintained one. e.g. In case v12, v13 available, v14 will be added and v12 will be removed on release of v14. Also change the `needs:` for later steps to `v14` from `v13`.
|
||||
- `.github/workflows/build_stable.yml`: Add the new release step under `jobs` and remove the unmaintained one. e.g. In case v12, v13 available, v14 will be added and v12 will be removed on release of v14. Also change the `needs:` for later steps to `v14` from `v13`.
|
||||
|
|
|
|||
|
|
@ -1,25 +0,0 @@
|
|||
# Maintainers
|
||||
|
||||
This project is actively maintained by the following people.
|
||||
|
||||
Maintainers are responsible for:
|
||||
|
||||
- Reviewing and merging pull requests
|
||||
- Managing releases
|
||||
- Triaging and responding to issues
|
||||
- Ensuring the overall health and direction of the project
|
||||
|
||||
## Current Maintainers
|
||||
|
||||
- [@revant](https://github.com/revant)
|
||||
- [@DanielRadlAMR](https://github.com/DanielRadlAMR)
|
||||
- [@Rocket-Quack](https://github.com/Rocket-Quack)
|
||||
|
||||
## Emeritus Maintainers
|
||||
|
||||
_(none)_
|
||||
|
||||
## Becoming a Maintainer
|
||||
|
||||
Contributors who consistently help review pull requests, participate in issue triage,
|
||||
and contribute to releases may be invited to become maintainers.
|
||||
73
README.md
73
README.md
|
|
@ -1,37 +1,17 @@
|
|||
<div align="center">
|
||||
<img src="docs/public/frappe-docker.png" alt="Frappe Docker" width="80" />
|
||||
<h1>Frappe Docker</h1>
|
||||
<p>Docker images and orchestration for Frappe applications.</p>
|
||||
<p>
|
||||
<a href="https://github.com/frappe/frappe_docker/actions/workflows/core-build-stable.yml">
|
||||
<img src="https://img.shields.io/github/actions/workflow/status/frappe/frappe_docker/core-build-stable.yml?branch=main&label=Build%20Stable" alt="Build Stable" />
|
||||
</a>
|
||||
<a href="https://github.com/frappe/frappe_docker/actions/workflows/core-build-develop.yml">
|
||||
<img src="https://img.shields.io/github/actions/workflow/status/frappe/frappe_docker/core-build-develop.yml?branch=main&label=Build%20Develop" alt="Build Develop" />
|
||||
</a>
|
||||
<a href="https://frappe.github.io/frappe_docker/">
|
||||
<img src="https://img.shields.io/badge/Docs-Open%20Site-0A7EA4" alt="Docs" />
|
||||
</a>
|
||||
</p>
|
||||
</div>
|
||||
# Frappe Docker
|
||||
|
||||
[](https://github.com/frappe/frappe_docker/actions/workflows/build_stable.yml)
|
||||
[](https://github.com/frappe/frappe_docker/actions/workflows/build_develop.yml)
|
||||
|
||||
Docker images and orchestration for Frappe applications.
|
||||
|
||||
## What is this?
|
||||
|
||||
This repository is the official container setup for Frappe applications.
|
||||
|
||||
It provides Docker images, Compose configurations, and documentation for running Frappe applications, including ERPNext, CRM, Helpdesk, and other Frappe apps, in containers.
|
||||
|
||||
Use it if you want to:
|
||||
|
||||
- run ERPNext, CRM, Helpdesk, or other Frappe apps with Docker
|
||||
- start from a quick demo setup
|
||||
- use production-ready Docker images and Compose setups
|
||||
- build custom app images
|
||||
- deploy and operate Frappe in production
|
||||
This repository handles the containerization of the Frappe stack, including the application server, database, Redis, and supporting services. It provides quick disposable demo setups, a development environment, production-ready Docker images and compose configurations for deploying Frappe applications including ERPNext.
|
||||
|
||||
## Repository Structure
|
||||
|
||||
```bash
|
||||
```
|
||||
frappe_docker/
|
||||
├── docs/ # Complete documentation
|
||||
├── overrides/ # Docker Compose configurations for different scenarios
|
||||
|
|
@ -54,18 +34,11 @@ frappe_docker/
|
|||
|
||||
## Documentation
|
||||
|
||||
The full `frappe_docker` documentation is available in [`docs/`](docs/) and published at [frappe.github.io/frappe_docker](https://frappe.github.io/frappe_docker/).
|
||||
**The official documentation for `frappe_docker` is maintained in the `docs/` folder in this repository.**
|
||||
|
||||
### Recommended entry points:
|
||||
**New to Frappe Docker?** Read the [Getting Started Guide](docs/getting-started.md) for a comprehensive overview of repository structure, development workflow, custom apps, Docker concepts, and quick start examples.
|
||||
|
||||
- **New here:** [Getting Started Guide](docs/getting-started.md)
|
||||
- **Choosing a setup:** [Deployment methods](docs/01-getting-started/01-choosing-a-deployment-method.md)
|
||||
- **ARM64 notes:** [ARM64](docs/01-getting-started/03-arm64.md)
|
||||
- **Container setup overview:** [Container Setup Overview](docs/02-setup/01-overview.md)
|
||||
- **Running in production:** [Production docs](docs/03-production/)
|
||||
- **Operating a deployment:** [Operations docs](docs/04-operations/)
|
||||
- **Development workflows:** [Development](docs/05-development/01-development.md)
|
||||
- **FAQ:** [Frequently Asked Questions](https://github.com/frappe/frappe_docker/wiki/Frequently-Asked-Questions)
|
||||
If you are already familiar with Frappe, you can jump right into the [different deployment methods](docs/01-getting-started/01-choosing-a-deployment-method.md) and select the one best suited to your use case.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
|
|
@ -77,13 +50,17 @@ The full `frappe_docker` documentation is available in [`docs/`](docs/) and publ
|
|||
|
||||
## Demo setup
|
||||
|
||||
The fastest way to try Frappe locally is with the single-file demo setup in `pwd.yml`.
|
||||
The fastest way to try Frappe is to play in an already set up sandbox, in your browser, click the button below:
|
||||
|
||||
<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>
|
||||
|
||||
### Try on your environment
|
||||
|
||||
> **⚠️ Disposable demo only**
|
||||
>
|
||||
> **This setup is intended for short-lived evaluation only.** You will not be able to install custom apps to this setup. For production deployments, custom configurations, and detailed explanations, see the full documentation.
|
||||
> **This setup is intended for quick evaluation. Expect to throw the environment away.** You will not be able to install custom apps to this setup. For production deployments, custom configurations, and detailed explanations, see the full documentation.
|
||||
|
||||
First clone the repo:
|
||||
|
||||
|
|
@ -100,6 +77,22 @@ docker compose -f pwd.yml up -d
|
|||
|
||||
Wait for a couple of minutes for ERPNext site to be created or check `create-site` container logs before opening browser on port `8080`. (username: `Administrator`, password: `admin`)
|
||||
|
||||
## Documentation Links
|
||||
|
||||
### [Getting Started Guide](docs/getting-started.md)
|
||||
|
||||
### [Frequently Asked Questions](https://github.com/frappe/frappe_docker/wiki/Frequently-Asked-Questions)
|
||||
|
||||
### [Getting Started](#getting-started)
|
||||
|
||||
### [Deployment Methods](docs/01-getting-started/01-choosing-a-deployment-method.md)
|
||||
|
||||
### [ARM64](docs/01-getting-started/03-arm64.md)
|
||||
|
||||
### [Container Setup Overview](docs/02-setup/01-overview.md)
|
||||
|
||||
### [Development](docs/05-development/01-development.md)
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
x-customizable-image: &customizable_image
|
||||
# By default the image used only contains the `frappe` and `erpnext` apps.
|
||||
# See https://github.com/frappe/frappe_docker/blob/main/docs/02-setup/02-build-setup.md#define-custom-apps
|
||||
# See https://github.com/frappe/frappe_docker/blob/main/docs/container-setup/02-build-setup.md#define-custom-apps
|
||||
# about using custom images.
|
||||
image: ${CUSTOM_IMAGE:-frappe/erpnext}:${CUSTOM_TAG:-$ERPNEXT_VERSION}
|
||||
pull_policy: ${PULL_POLICY:-always}
|
||||
|
|
@ -33,7 +33,6 @@ services:
|
|||
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;
|
||||
bench set-config -g chromium_path /usr/bin/chromium-headless-shell;
|
||||
environment:
|
||||
DB_HOST: ${DB_HOST:-}
|
||||
DB_PORT: ${DB_PORT:-}
|
||||
|
|
@ -46,10 +45,6 @@ services:
|
|||
backend:
|
||||
<<: *backend_defaults
|
||||
platform: linux/amd64
|
||||
environment:
|
||||
GUNICORN_THREADS: ${GUNICORN_THREADS:-4}
|
||||
GUNICORN_WORKERS: ${GUNICORN_WORKERS:-2}
|
||||
GUNICORN_TIMEOUT: ${GUNICORN_TIMEOUT:-120}
|
||||
|
||||
frontend:
|
||||
<<: *customizable_image
|
||||
|
|
|
|||
|
|
@ -10,9 +10,7 @@
|
|||
"grapecity.gc-excelviewer",
|
||||
"mtxr.sqltools",
|
||||
"mtxr.sqltools-driver-mysql",
|
||||
"vue.volar",
|
||||
"esbenp.prettier-vscode",
|
||||
"charliermarsh.ruff"
|
||||
"visualstudioexptteam.vscodeintellicode"
|
||||
],
|
||||
"settings": {
|
||||
"terminal.integrated.profiles.linux": {
|
||||
|
|
@ -46,7 +44,6 @@
|
|||
"service": "frappe",
|
||||
"workspaceFolder": "/workspace/development",
|
||||
"shutdownAction": "stopCompose",
|
||||
"postCreateCommand": "uv tool install pre-commit",
|
||||
"mounts": [
|
||||
"source=${localEnv:HOME}${localEnv:USERPROFILE}/.ssh,target=/home/frappe/.ssh,type=bind,consistency=cached"
|
||||
]
|
||||
|
|
|
|||
|
|
@ -5,6 +5,7 @@ services:
|
|||
- --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: 123
|
||||
MARIADB_AUTO_UPGRADE: 1
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
[
|
||||
{
|
||||
"url": "https://github.com/frappe/erpnext.git",
|
||||
"branch": "version-16"
|
||||
"branch": "version-15"
|
||||
}
|
||||
]
|
||||
|
|
|
|||
|
|
@ -72,8 +72,8 @@ def get_args_parser():
|
|||
"--frappe-branch",
|
||||
action="store",
|
||||
type=str,
|
||||
help="frappe repo to use, default: version-16", # noqa: E501
|
||||
default="version-16",
|
||||
help="frappe repo to use, default: version-15", # noqa: E501
|
||||
default="version-15",
|
||||
)
|
||||
parser.add_argument(
|
||||
"-p",
|
||||
|
|
|
|||
|
|
@ -1,20 +1,3 @@
|
|||
{
|
||||
"python.defaultInterpreterPath": "${workspaceFolder}/frappe-bench/env/bin/python",
|
||||
"files.watcherExclude": {
|
||||
// --- Node modules ---
|
||||
"**/node_modules/**": true,
|
||||
|
||||
// --- Frappe bench core dirs ---
|
||||
"**/env/**": true,
|
||||
"**/config/**": true,
|
||||
|
||||
// --- Build artifacts ---
|
||||
"**/__pycache__/**": true,
|
||||
"**/*.pyc": true
|
||||
},
|
||||
"files.exclude": {
|
||||
"**/__pycache__": true,
|
||||
"**/*.pyc": true,
|
||||
"**/.git": false
|
||||
}
|
||||
"python.defaultInterpreterPath": "${workspaceFolder}/frappe-bench/env/bin/python"
|
||||
}
|
||||
|
|
|
|||
|
|
@ -6,10 +6,10 @@ variable "REGISTRY_USER" {
|
|||
}
|
||||
|
||||
variable PYTHON_VERSION {
|
||||
default = "3.14.2"
|
||||
default = "3.11.6"
|
||||
}
|
||||
variable NODE_VERSION {
|
||||
default = "24.13.0"
|
||||
default = "20.19.2"
|
||||
}
|
||||
|
||||
variable "FRAPPE_VERSION" {
|
||||
|
|
@ -62,10 +62,6 @@ group "default" {
|
|||
targets = ["erpnext", "base", "build"]
|
||||
}
|
||||
|
||||
group "base-images" {
|
||||
targets = ["base", "build"]
|
||||
}
|
||||
|
||||
function "tag" {
|
||||
params = [repo, version]
|
||||
result = [
|
||||
|
|
|
|||
|
|
@ -1,29 +0,0 @@
|
|||
import { defineConfig, UserConfig } from "vitepress";
|
||||
import { withSidebar } from "vitepress-sidebar";
|
||||
|
||||
// https://vitepress.dev/reference/site-config
|
||||
const vitePressOptions: UserConfig = {
|
||||
title: "Frappe Docker Docs",
|
||||
description: "Frappe in a Container",
|
||||
base: "/frappe_docker/",
|
||||
head: [["link", { rel: "icon", href: "/frappe_docker/favicon.png" }]],
|
||||
themeConfig: {
|
||||
logo: "/frappe-docker.png",
|
||||
// https://vitepress.dev/reference/default-theme-config
|
||||
nav: [{ text: "Home", link: "/" }],
|
||||
|
||||
socialLinks: [
|
||||
{ icon: "github", link: "https://github.com/frappe/frappe_docker/" },
|
||||
],
|
||||
},
|
||||
};
|
||||
|
||||
const vitePressSidebarOptions = {
|
||||
documentRootPath: ".",
|
||||
useTitleFromFrontmatter: true,
|
||||
useFolderTitleFromIndexFile: true,
|
||||
};
|
||||
|
||||
export default defineConfig(
|
||||
withSidebar(vitePressOptions, vitePressSidebarOptions),
|
||||
);
|
||||
|
|
@ -1,92 +0,0 @@
|
|||
---
|
||||
title: Introduction
|
||||
---
|
||||
|
||||
# Introduction to Frappe Docker
|
||||
|
||||
This is the documentation for the Frappe Docker repository, which contains all the information on how to develop, deploy and share Frappe app, using Docker containers.
|
||||
|
||||
## Repository Architecture
|
||||
|
||||
Frappe Docker provides a comprehensive containerized environment for developing and deploying Frappe/ERPNext applications. It uses a **multi-service architecture** that handles everything from web serving to background job processing.
|
||||
|
||||
### Core Services
|
||||
|
||||
The base compose file includes these essential services:
|
||||
|
||||
- **configurator** - Initialization service that configures database and Redis connections; runs on startup and exits
|
||||
- **backend** - Werkzeug development server for dynamic content processing
|
||||
- **frontend** - Nginx reverse proxy that serves static assets and routes requests
|
||||
- **websocket** - Node.js server running Socket.IO for real-time communications
|
||||
- **queue-short/long** - Python workers using RQ (Redis Queue) for asynchronous background job processing
|
||||
- **scheduler** - Python service that runs scheduled tasks using the schedule library
|
||||
|
||||
Additional services are added through compose overrides:
|
||||
|
||||
- **db** - MariaDB or PostgreSQL database server (via `compose.mariadb.yaml` or `compose.postgres.yaml`)
|
||||
- **redis-cache/queue** - Redis instances for caching and job queues (via `compose.redis.yaml`)
|
||||
|
||||
### How Services Work Together
|
||||
|
||||
```
|
||||
User Request
|
||||
↓
|
||||
[frontend (Nginx)] → Static files served directly
|
||||
↓
|
||||
[backend (Werkzeug)] → Dynamic content processing
|
||||
↓ ↓
|
||||
[db (MariaDB)] [redis-cache]
|
||||
|
||||
Background Tasks:
|
||||
[scheduler] → [redis-queue] → [queue-short/long workers]
|
||||
|
||||
Real-time:
|
||||
[websocket (Socket.IO)] ←→ [redis-cache]
|
||||
```
|
||||
|
||||
## Repository Structure
|
||||
|
||||
### `/` Root: Core Configuration Files
|
||||
|
||||
- **compose.yaml** - Main Docker Compose file defining all services
|
||||
- **example.env** - Environment variables template (copy to `.env`)
|
||||
- **pwd.yml** - "Play with Docker" - simplified single-file setup for quick testing
|
||||
- **docker-bake.hcl** - Advanced Docker Buildx configuration for multi-architecture builds
|
||||
- **docs/container-setup/env-variables.md** - Central reference for environment configuration logic and defaults
|
||||
|
||||
### `images/`: Docker Image Definitions
|
||||
|
||||
Four predefined Dockerfiles are available, each serving different use cases:
|
||||
|
||||
- **images/bench/** - Sets up only the Bench CLI for development or debugging; does not include runtime services
|
||||
- **images/custom/** - Multi-purpose Python backend built from plain Python base image; installs apps from `apps.json`; suitable for **production** and testing; ideal when you need control over Python/Node versions
|
||||
- **images/layered/** - Same final contents as `custom` but based on prebuilt images from Docker Hub; faster builds for production when using Frappe-managed dependency versions
|
||||
- **images/production/** - Installs only Frappe and ERPNext (not customizable with `apps.json`); best for **quick starts or exploration**; for real deployments, use `custom` or `layered`
|
||||
|
||||
> **Note:** For detailed build arguments and advanced configuration options, see [Setup Overview](../02-setup/01-overview.md).
|
||||
|
||||
### `overrides/`: Compose File Extensions
|
||||
|
||||
Docker Compose "overrides" that extend the base compose.yaml for different scenarios:
|
||||
|
||||
- **compose.mariadb.yaml** - Adds MariaDB database service
|
||||
- **compose.redis.yaml** - Adds Redis caching service
|
||||
- **compose.proxy.yaml** - Adds Traefik reverse proxy for multi-site hosting (label-based routing)
|
||||
- **compose.https.yaml** - Adds Traefik HTTPS + automatic certs (uses `SITES_RULE`)
|
||||
- **compose.nginxproxy.yaml** - Adds nginx-proxy reverse proxy (HTTP, env-based `VIRTUAL_HOST`)
|
||||
- **compose.nginxproxy-ssl.yaml** - Adds nginx-proxy + acme-companion (HTTPS, env-based `LETSENCRYPT_HOST`)
|
||||
|
||||
**Proxy choice:**
|
||||
|
||||
- Traefik is more flexible for advanced routing and multi-bench setups
|
||||
- nginx-proxy is simpler for a single bench with host-based routing.
|
||||
|
||||
### `development/`: Dev Environment
|
||||
|
||||
- **development/installer.py** - Automated bench/site creation and configuration script
|
||||
- Contains your local development files (git-ignored to prevent accidental commits)
|
||||
|
||||
### `resources/`: Runtime Templates
|
||||
|
||||
- **core/nginx/nginx-entrypoint.sh** - Dynamic Nginx configuration generator script
|
||||
- **core/nginx/nginx-template.conf** - Nginx configuration template with variable substitution
|
||||
|
|
@ -1,7 +1,3 @@
|
|||
---
|
||||
title: Choosing a Method
|
||||
---
|
||||
|
||||
# Choosing a Deployment or Development Method
|
||||
|
||||
This repository (`frappe_docker`) supports **multiple ways to run Frappe using Docker**.
|
||||
|
|
@ -49,7 +45,7 @@ If you start with `pwd.yml`, you should expect to **throw the environment away**
|
|||
|
||||
## 2. VS Code Devcontainers – Local Development Setup
|
||||
|
||||
The development setup described in [`/docs/05-development/development.md`](../05-development/01-development.md)
|
||||
The development setup described in [`/docs/05-development`](../05-development)
|
||||
|
||||
uses **VS Code Devcontainers** to provide a **local Frappe development environment**.
|
||||
|
||||
|
|
@ -107,7 +103,7 @@ It uses:
|
|||
- The main `compose.yml`
|
||||
- Override files from the `overrides/` directory
|
||||
|
||||
Detailed instructions are available in [`/docs/02-setup`](../02-setup/01-overview.md)
|
||||
Detailed instructions are available in [`/docs/02-setup`](../02-setup)
|
||||
|
||||
### Characteristics
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,3 @@
|
|||
---
|
||||
title: Docker Immutability
|
||||
---
|
||||
|
||||
# Important Concept: Immutability and Persistence
|
||||
|
||||
A frequent source of confusion is how **Docker-based Frappe deployments handle persistence**.
|
||||
|
|
@ -35,11 +31,11 @@ This allows you to:
|
|||
|
||||
Installing apps into a running container is **not supported**.
|
||||
|
||||
`bench get-app` and `bench build` are examples of an common but unsupported actions.
|
||||
`bench get-app` is an examples of an common but unsupported action.
|
||||
|
||||
### Why?
|
||||
|
||||
- Apps and assets are part of the **Docker image**
|
||||
- Apps are part of the **Docker image**
|
||||
- Runtime changes are lost on container recreation
|
||||
- This ensures reproducibility and stability
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,3 @@
|
|||
---
|
||||
title: Quick Start with Linux and Mac
|
||||
---
|
||||
|
||||
# How to install ERPNext on linux/mac using Frappe_docker ?
|
||||
|
||||
## Clone the repo
|
||||
|
|
@ -29,8 +25,8 @@ here is the example pwd.yml file:
|
|||
```yml
|
||||
services:
|
||||
backend:
|
||||
image: frappe/erpnext:v16.19.1
|
||||
platform: linux/arm64
|
||||
image: frappe/erpnext:v15
|
||||
platform: linux/amd64
|
||||
deploy:
|
||||
restart_policy:
|
||||
condition: on-failure
|
||||
|
|
@ -39,8 +35,8 @@ services:
|
|||
- logs:/home/frappe/frappe-bench/logs
|
||||
|
||||
configurator:
|
||||
image: frappe/erpnext:v16.19.1
|
||||
platform: linux/arm64
|
||||
image: frappe/erpnext:v15
|
||||
platform: linux/amd64
|
||||
deploy:
|
||||
restart_policy:
|
||||
condition: none
|
||||
|
|
@ -68,8 +64,8 @@ services:
|
|||
- logs:/home/frappe/frappe-bench/logs
|
||||
|
||||
create-site:
|
||||
image: frappe/erpnext:v16.19.1
|
||||
platform: linux/arm64
|
||||
image: frappe/erpnext:v15
|
||||
platform: linux/amd64
|
||||
deploy:
|
||||
restart_policy:
|
||||
condition: none
|
||||
|
|
@ -100,8 +96,8 @@ services:
|
|||
bench new-site --mariadb-user-host-login-scope=% --admin-password=admin --db-root-password=admin --install-app erpnext --set-default frontend;
|
||||
|
||||
db:
|
||||
image: mariadb:11.8
|
||||
platform: linux/arm64
|
||||
image: mariadb:10.6
|
||||
platform: linux/amd64
|
||||
healthcheck:
|
||||
test: mysqladmin ping -h localhost --password=admin
|
||||
interval: 1s
|
||||
|
|
@ -113,14 +109,15 @@ services:
|
|||
- --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:v16.19.1
|
||||
platform: linux/arm64
|
||||
image: frappe/erpnext:v15
|
||||
platform: linux/amd64
|
||||
depends_on:
|
||||
- websocket
|
||||
deploy:
|
||||
|
|
@ -144,8 +141,8 @@ services:
|
|||
- "8080:8080"
|
||||
|
||||
queue-long:
|
||||
image: frappe/erpnext:v16.19.1
|
||||
platform: linux/arm64
|
||||
image: frappe/erpnext:v15
|
||||
platform: linux/amd64
|
||||
deploy:
|
||||
restart_policy:
|
||||
condition: on-failure
|
||||
|
|
@ -159,8 +156,8 @@ services:
|
|||
- logs:/home/frappe/frappe-bench/logs
|
||||
|
||||
queue-short:
|
||||
image: frappe/erpnext:v16.19.1
|
||||
platform: linux/arm64
|
||||
image: frappe/erpnext:v15
|
||||
platform: linux/amd64
|
||||
deploy:
|
||||
restart_policy:
|
||||
condition: on-failure
|
||||
|
|
@ -175,7 +172,7 @@ services:
|
|||
|
||||
redis-queue:
|
||||
image: redis:6.2-alpine
|
||||
platform: linux/arm64
|
||||
platform: linux/amd64
|
||||
deploy:
|
||||
restart_policy:
|
||||
condition: on-failure
|
||||
|
|
@ -184,14 +181,14 @@ services:
|
|||
|
||||
redis-cache:
|
||||
image: redis:6.2-alpine
|
||||
platform: linux/arm64
|
||||
platform: linux/amd64
|
||||
deploy:
|
||||
restart_policy:
|
||||
condition: on-failure
|
||||
|
||||
scheduler:
|
||||
image: frappe/erpnext:v16.19.1
|
||||
platform: linux/arm64
|
||||
image: frappe/erpnext:v15
|
||||
platform: linux/amd64
|
||||
deploy:
|
||||
restart_policy:
|
||||
condition: on-failure
|
||||
|
|
@ -203,8 +200,8 @@ services:
|
|||
- logs:/home/frappe/frappe-bench/logs
|
||||
|
||||
websocket:
|
||||
image: frappe/erpnext:v16.19.1
|
||||
platform: linux/arm64
|
||||
image: frappe/erpnext:v15
|
||||
platform: linux/amd64
|
||||
deploy:
|
||||
restart_policy:
|
||||
condition: on-failure
|
||||
|
|
|
|||
|
|
@ -1,7 +1,3 @@
|
|||
---
|
||||
title: Single Compose Setup
|
||||
---
|
||||
|
||||
# Single Compose Setup
|
||||
|
||||
This setup is a very simple single compose file that does everything to start required services and a frappe-bench. It is used to start play with docker instance with a site. The file is located in the root of repo and named `pwd.yml`.
|
||||
|
|
|
|||
|
|
@ -1,3 +0,0 @@
|
|||
---
|
||||
title: Getting Started
|
||||
---
|
||||
|
|
@ -1,7 +1,3 @@
|
|||
---
|
||||
title: Setup Overview
|
||||
---
|
||||
|
||||
The purpose of this document is to give you an overview of how the Frappe Docker containers are structured.
|
||||
|
||||
# 🐳 Images
|
||||
|
|
|
|||
|
|
@ -1,19 +1,13 @@
|
|||
---
|
||||
title: Build Setup
|
||||
---
|
||||
|
||||
This guide walks you through building Frappe images from the repository resources.
|
||||
|
||||
# Prerequisites
|
||||
|
||||
- git
|
||||
- docker (Engine **v23.0+** with buildx) or podman
|
||||
- docker or podman
|
||||
- docker compose v2 or podman compose
|
||||
|
||||
> Install containerization software according to the official maintainer documentation. Avoid package managers when not recommended, as they frequently cause compatibility issues.
|
||||
|
||||
> **Why Docker Engine v23+?** The build uses [BuildKit secrets](https://docs.docker.com/build/building/secrets/) (`--secret`) to keep `apps.json` tokens out of image layers. BuildKit is the default builder starting with Docker Engine 23.0 — older releases will fail or silently fall back to the legacy builder, which does not support secret mounts.
|
||||
|
||||
# Clone this repo
|
||||
|
||||
```bash
|
||||
|
|
@ -23,7 +17,7 @@ cd frappe_docker
|
|||
|
||||
# Define custom apps
|
||||
|
||||
If you don't want to include custom apps in the image, skip this section.
|
||||
If you dont want to install specific apps to the image skip this section.
|
||||
|
||||
To include custom apps in your image, create an `apps.json` file in the repository root:
|
||||
|
||||
|
|
@ -31,11 +25,11 @@ To include custom apps in your image, create an `apps.json` file in the reposito
|
|||
[
|
||||
{
|
||||
"url": "https://github.com/frappe/erpnext",
|
||||
"branch": "version-16"
|
||||
"branch": "version-15"
|
||||
},
|
||||
{
|
||||
"url": "https://github.com/frappe/hrms",
|
||||
"branch": "version-16"
|
||||
"branch": "version-15"
|
||||
},
|
||||
{
|
||||
"url": "https://github.com/frappe/helpdesk",
|
||||
|
|
@ -44,23 +38,24 @@ To include custom apps in your image, create an `apps.json` file in the reposito
|
|||
]
|
||||
```
|
||||
|
||||
# Build custom images
|
||||
Then generate a base64-encoded string from this file:
|
||||
|
||||
## Manually
|
||||
```bash
|
||||
export APPS_JSON_BASE64=$(base64 -w 0 apps.json)
|
||||
```
|
||||
|
||||
# Build the image
|
||||
|
||||
Choose the appropriate build command based on your container runtime and desired image type. This example builds the `layered` image with the custom `apps.json` you created.
|
||||
|
||||
> **Security note:** The `apps.json` file is passed as a [BuildKit secret](https://docs.docker.com/build/building/secrets/) so that private repository tokens are **never** stored in image layer metadata. Do not use `--build-arg` for `apps.json` — build arguments are permanently visible via `docker image history`. This requires **Docker Engine v23.0+** (where BuildKit is the default builder).
|
||||
|
||||
`Docker`:
|
||||
|
||||
```bash
|
||||
docker build \
|
||||
--no-cache \
|
||||
--build-arg=FRAPPE_PATH=https://github.com/frappe/frappe \
|
||||
--build-arg=FRAPPE_BRANCH=version-16 \
|
||||
--secret=id=apps_json,src=apps.json \
|
||||
--tag=custom:16 \
|
||||
--build-arg=FRAPPE_BRANCH=version-15 \
|
||||
--build-arg=APPS_JSON_BASE64=$APPS_JSON_BASE64 \
|
||||
--tag=custom:15 \
|
||||
--file=images/layered/Containerfile .
|
||||
```
|
||||
|
||||
|
|
@ -68,42 +63,31 @@ docker build \
|
|||
|
||||
```bash
|
||||
podman build \
|
||||
--no-cache \
|
||||
--build-arg=FRAPPE_PATH=https://github.com/frappe/frappe \
|
||||
--build-arg=FRAPPE_BRANCH=version-16 \
|
||||
--secret=id=apps_json,src=apps.json \
|
||||
--tag=custom:16 \
|
||||
--build-arg=FRAPPE_BRANCH=version-15 \
|
||||
--build-arg=APPS_JSON_BASE64=$APPS_JSON_BASE64 \
|
||||
--tag=custom:15 \
|
||||
--file=images/layered/Containerfile .
|
||||
```
|
||||
|
||||
## Automated
|
||||
## Build args
|
||||
|
||||
This repository is fully suited for automated builds, i.e. using CI/CD pipelines.
|
||||
| Arg | Purpose |
|
||||
| -------------------- | --------------------------------------------------------------------------------------------- |
|
||||
| **Frappe Framework** | |
|
||||
| FRAPPE_PATH | Repository URL for Frappe framework source code. Defaults to https://github.com/frappe/frappe |
|
||||
| FRAPPE_BRANCH | Branch to use for Frappe framework. Defaults to version-15 |
|
||||
| **Custom Apps** | |
|
||||
| APPS_JSON_BASE64 | Base64-encoded JSON string from apps.json defining apps to install |
|
||||
| **Dependencies** | |
|
||||
| PYTHON_VERSION | Python version for the base image |
|
||||
| NODE_VERSION | Node.js version |
|
||||
| WKHTMLTOPDF_VERSION | wkhtmltopdf version |
|
||||
| **bench only** | |
|
||||
| DEBIAN_BASE | Debian base version for the bench image, defaults to `bookworm` |
|
||||
| WKHTMLTOPDF_DISTRO | use the specified distro for debian package. Default is `bookworm` |
|
||||
|
||||
See [Automated Builds and Deployment](../03-production/06-automated-builds-and-deployment.md) for more information.
|
||||
|
||||
## Build args, secrets and flags
|
||||
|
||||
| Variable | Purpose |
|
||||
| -------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| **Frappe Framework** | |
|
||||
| FRAPPE_PATH | Repository URL for Frappe framework source code. Defaults to <https://github.com/frappe/frappe> |
|
||||
| FRAPPE_BRANCH | Branch to use for Frappe framework. Defaults to version-16 |
|
||||
| **Custom Apps** | |
|
||||
| CACHE_BUST | Can be used to invalidate the cached layer. See [Build Cache](../03-production/06-automated-builds-and-deployment.md#build-cache) |
|
||||
| (secret) apps_json | Passed via `--secret=id=apps_json,src=apps.json`. Never use `--build-arg` for this file. |
|
||||
| **Dependencies** | |
|
||||
| PYTHON_VERSION | Python version for the base image |
|
||||
| NODE_VERSION | Node.js version |
|
||||
| WKHTMLTOPDF_VERSION | wkhtmltopdf version |
|
||||
| INSTALL_CHROMIUM | Configure chromium installation, defaults to `true` - needed for Frappe Workbench version >15 |
|
||||
| **bench only** | |
|
||||
| DEBIAN_BASE | Debian base version for the bench image, defaults to `bookworm` |
|
||||
| WKHTMLTOPDF_DISTRO | use the specified distro for debian package. Default is `bookworm` |
|
||||
|
||||
# Deploy the stack
|
||||
|
||||
## env file
|
||||
# env file
|
||||
|
||||
The compose file requires several environment variables. You can either export them on your system or create a `.env` file.
|
||||
|
||||
|
|
@ -117,7 +101,7 @@ For this setup, make sure **at least** the following values are added to `custom
|
|||
|
||||
```txt
|
||||
CUSTOM_IMAGE=custom
|
||||
CUSTOM_TAG=16
|
||||
CUSTOM_TAG=15
|
||||
PULL_POLICY=missing
|
||||
```
|
||||
|
||||
|
|
@ -127,7 +111,7 @@ PULL_POLICY=missing
|
|||
**⚠️ This is not meant to be a complete `.env` configuration guide. These are only the minimal additions required for this example.
|
||||
Please have a look at [env-variables.md](04-env-variables.md) for a full description of all available variables and adjust them according to your needs.**
|
||||
|
||||
## Creating the final compose file
|
||||
# Creating the final compose file
|
||||
|
||||
Combine the base compose file with appropriate overrides for your use case. This example adds MariaDB, Redis, and exposes ports on `:8080`:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,3 @@
|
|||
---
|
||||
title: Start Container
|
||||
---
|
||||
|
||||
# start Container
|
||||
|
||||
Once your compose file is ready, start all containers with a single command:
|
||||
|
|
|
|||
|
|
@ -1,7 +1,3 @@
|
|||
---
|
||||
title: Environment Variables
|
||||
---
|
||||
|
||||
# Environment Variables Reference
|
||||
|
||||
Environment variables configure your Frappe Docker setup. They can be set directly in the container or defined in a `.env` file referenced by Docker Compose.
|
||||
|
|
@ -122,16 +118,6 @@ If your site is named `example.com` and you access it via that domain, no need t
|
|||
|
||||
---
|
||||
|
||||
## Backend (Gunicorn) Configuration
|
||||
|
||||
| Variable | Purpose | Default | When to Set / Allowed Values |
|
||||
| :----------------- | :------------------------------------------------------------- | :------ | :------------------------------------------------------------------------------- |
|
||||
| `GUNICORN_WORKERS` | Number of worker processes handling web requests | `2` | Scale up for multi-core CPUs. Formula: `(2 x Cores) + 1` |
|
||||
| `GUNICORN_THREADS` | Number of concurrent threads per worker process | `4` | Increase to handle more simultaneous I/O-bound requests without high memory cost |
|
||||
| `GUNICORN_TIMEOUT` | Max time a worker can spend on a single request before restart | `120` | Increase if long-running reports or data imports time out |
|
||||
|
||||
---
|
||||
|
||||
## Frontend Nginx Configuration (inside the frontend container)
|
||||
|
||||
| Variable | Purpose | Default | Allowed Values |
|
||||
|
|
@ -150,11 +136,3 @@ Use these variables when running behind a reverse proxy or load balancer:
|
|||
| `UPSTREAM_REAL_IP_ADDRESS` | Trusted upstream IP address for real IP detection | `127.0.0.1` |
|
||||
| `UPSTREAM_REAL_IP_HEADER` | Request header containing client IP | `X-Forwarded-For` |
|
||||
| `UPSTREAM_REAL_IP_RECURSIVE` | Enable recursive IP search | `off` |
|
||||
|
||||
---
|
||||
|
||||
## Migration Service
|
||||
|
||||
| Variable | Purpose | Default | Allowed Values |
|
||||
| --------------- | ------------------------------- | -------------------------- | ---------------- |
|
||||
| `MIGRATE_SITES` | Switch auto migration on or off | `true` - auto migration on | `true` , `false` |
|
||||
|
|
|
|||
|
|
@ -1,7 +1,3 @@
|
|||
---
|
||||
title: Overrides
|
||||
---
|
||||
|
||||
Overrides extend the base compose.yaml with additional services or modify existing behavior. Include them in your compose command using multiple -f flags.
|
||||
|
||||
```bash
|
||||
|
|
@ -24,10 +20,8 @@ docker compose -f compose.yaml -f overrides/compose.mariadb.yaml -f overrides/co
|
|||
| compose.nginxproxy.yaml | Uses nginx-proxy as HTTP reverse proxy on port `:80` | Set `NGINX_PROXY_HOSTS`. Use with `compose.nginxproxy-ssl.yaml` for HTTPS. You can change the published port by setting `HTTP_PUBLISH_PORT` |
|
||||
| compose.nginxproxy-ssl.yaml | Adds acme-companion for HTTPS on port `:443` with automatic certificates | Requires `compose.nginxproxy.yaml`. Set `NGINX_PROXY_HOSTS` and `LETSENCRYPT_EMAIL`. `HTTP_PUBLISH_PORT` and `HTTPS_PUBLISH_PORT` can be set. |
|
||||
| **Redis** | | |
|
||||
| compose.redis.yaml | Adds Redis service for caching and background job queuing | |
|
||||
| **Services** | | |
|
||||
| compose.migrator.yaml | Runs a dedicated migration container performing `bench --site all migrate` on all sites at every start | Control migration intent with `MIGRATE_SITES` - defaults to true |
|
||||
| **TBD** | **The following overrides are available but lack documentation. If you use them and understand their purpose, please consider contributing to this documentation.** | |
|
||||
| compose.redis.yaml | Adds Redis service for caching and background job queuing |
|
||||
| **TBD** | **The following overrides are available but lack documentation. If you use them and understand their purpose, please consider contributing to this documentation.** |
|
||||
| compose.backup-cron.yaml | | |
|
||||
| compose.custom-domain-ssl.yaml | | |
|
||||
| compose.custom-domain.yaml | | |
|
||||
|
|
|
|||
|
|
@ -1,7 +1,3 @@
|
|||
---
|
||||
title: Setup Examples
|
||||
---
|
||||
|
||||
# Setup Examples
|
||||
|
||||
This guide provides practical examples for common setup scenarios. These examples build upon the [container setup guide](01-overview.md) and demonstrate how to combine the base compose file with overrides.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,3 @@
|
|||
---
|
||||
title: Single Server Setup
|
||||
---
|
||||
|
||||
# Single Server Example
|
||||
|
||||
This guide demonstrates setting up multiple Frappe/ERPNext benches (projects) on a single server with shared infrastructure components.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,3 @@
|
|||
---
|
||||
title: Single Server Example
|
||||
---
|
||||
|
||||
# Single Server Example (nginx-proxy + acme-companion)
|
||||
|
||||
This guide demonstrates a single-server setup using nginx-proxy and acme-companion for HTTPS. It is best for a small number of hostnames and a single bench. If you need multiple benches or advanced routing, use the Traefik-based example instead.
|
||||
|
|
@ -15,7 +11,7 @@ We will setup the following:
|
|||
|
||||
## Requirements
|
||||
|
||||
- A server that can run Docker Engine **v23.0+** (recommended: 2 vCPU, 4 GB RAM, 50 GB SSD). The custom-image build below uses [BuildKit secrets](https://docs.docker.com/build/building/secrets/), which require BuildKit as the default builder (Docker Engine 23.0+).
|
||||
- A server that can run Docker (recommended: 2 vCPU, 4 GB RAM, 50 GB SSD).
|
||||
- A public domain with DNS control.
|
||||
- Two subdomains pointing to your server IP (A/AAAA records):
|
||||
- `erp.your-domain.com`
|
||||
|
|
@ -84,17 +80,25 @@ cat > ~/gitops/apps.json <<'EOF'
|
|||
EOF
|
||||
```
|
||||
|
||||
Build the image, passing `apps.json` as a [BuildKit secret](https://docs.docker.com/build/building/secrets/) so that private repo tokens are never stored in image layers. This requires **Docker Engine v23.0+**, where BuildKit is the default builder:
|
||||
Generate the BASE64 value and build:
|
||||
|
||||
```shell
|
||||
export APPS_JSON_BASE64=$(base64 -w 0 ~/gitops/apps.json)
|
||||
|
||||
docker build \
|
||||
--build-arg=FRAPPE_PATH=https://github.com/frappe/frappe \
|
||||
--build-arg=FRAPPE_BRANCH=version-16 \
|
||||
--secret=id=apps_json,src=$HOME/gitops/apps.json \
|
||||
--build-arg=APPS_JSON_BASE64=$APPS_JSON_BASE64 \
|
||||
--tag=my-erpnext-prod-image:16.0.0 \
|
||||
--file=images/layered/Containerfile .
|
||||
```
|
||||
|
||||
If `base64 -w 0` is not available on your system, use:
|
||||
|
||||
```shell
|
||||
export APPS_JSON_BASE64=$(base64 ~/gitops/apps.json | tr -d '\n')
|
||||
```
|
||||
|
||||
### Configure environment
|
||||
|
||||
Create an environment file for the bench:
|
||||
|
|
@ -149,7 +153,7 @@ docker compose --project-name erpnext exec backend \
|
|||
|
||||
# crm.your-domain.com
|
||||
docker compose --project-name erpnext exec backend \
|
||||
bench new-site --mariadb-user-host-login-scope=% --db-root-password changeit --install-app crm --admin-password changeit crm.your-domain.com
|
||||
bench new-site --mariadb-user-host-login-scope=% --db-root-password changeit --install-app erpnext --admin-password changeit crm.your-domain.com
|
||||
```
|
||||
|
||||
### Notes
|
||||
|
|
|
|||
|
|
@ -1,3 +0,0 @@
|
|||
---
|
||||
title: Setup
|
||||
---
|
||||
|
|
@ -1,7 +1,3 @@
|
|||
---
|
||||
title: TLS/SSL Setup Overview
|
||||
---
|
||||
|
||||
# TLS/SSL Setup Overview
|
||||
|
||||
Frappe Docker supports multiple TLS/SSL approaches. Choose the one that matches your routing needs and where you want the proxy to run.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,3 @@
|
|||
---
|
||||
title: Backup Strategy
|
||||
---
|
||||
|
||||
Create backup service or stack.
|
||||
|
||||
```yaml
|
||||
|
|
|
|||
|
|
@ -1,7 +1,3 @@
|
|||
---
|
||||
title: Multi Tenancy
|
||||
---
|
||||
|
||||
WARNING: Do not use this in production if the site is going to be served over plain http.
|
||||
|
||||
### Step 1
|
||||
|
|
|
|||
|
|
@ -1,7 +1,3 @@
|
|||
---
|
||||
title: NGINX and ACME Companion
|
||||
---
|
||||
|
||||
# nginx-proxy + acme-companion (HTTPS)
|
||||
|
||||
This guide explains how to use nginx-proxy with acme-companion to provide HTTPS for a Frappe Docker stack.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,3 @@
|
|||
---
|
||||
title: Caddy with HTTPS
|
||||
---
|
||||
|
||||
# Caddy reverse proxy (local HTTPS)
|
||||
|
||||
This guide shows how to use Caddy as an external reverse proxy in front of the frontend container. It is most useful for local HTTPS or internal networks.
|
||||
|
|
|
|||
|
|
@ -1,147 +0,0 @@
|
|||
---
|
||||
title: Automated Builds and Deployment
|
||||
---
|
||||
|
||||
# Introduction
|
||||
|
||||
This is a brief guide to automated builds and deployment for custom Frappe images.
|
||||
Depending on your specific setup, environment and security rules, the information below may need to be adapted to your needs.
|
||||
|
||||
# Requirements
|
||||
|
||||
## Knowledge
|
||||
|
||||
Basic knowledge of Docker and build pipelines is expected.
|
||||
|
||||
Please refer to the Setup chapter first, especially [Build Setup](../02-setup/02-build-setup.md), for basic understanding.
|
||||
|
||||
## Additional Files
|
||||
|
||||
### Apps
|
||||
|
||||
At build time an `apps.json` file can be provided. This specifies additional Frappe framework compatible apps to include in custom images.
|
||||
|
||||
### Build
|
||||
|
||||
A workflow file for your CI platform and environment is required.
|
||||
|
||||
## Build Cache
|
||||
|
||||
Unlike manual builds, automated build commands should generally not use `--no-cache`.
|
||||
|
||||
Reusing cached layers can greatly reduce build times, disk usage, and bandwidth usage when pushing to image registries.
|
||||
|
||||
Instead, `CACHE_BUST` can be used to control cache invalidation of the Frappe layer when rebuilding is desired.
|
||||
|
||||
This is especially relevant because `apps.json` is provided as a secret. Secret contents are not part of Docker layer cache keys and therefore cannot trigger cache invalidation automatically.
|
||||
|
||||
As a result, Docker may reuse an older cached layer even when the custom app definition has changed.
|
||||
|
||||
Exception: Newer releases of the Frappe framework may still trigger rebuilding the layer.
|
||||
|
||||
### Possible techniques for cache invalidation using `CACHE_BUST`:
|
||||
|
||||
1. No override: normal Docker layer caching is used - not recommended in this use case
|
||||
2. Timestamp: force a rebuild on every pipeline run - since the value will change every run
|
||||
3. Pipeline run ID: rebuild once per CI run
|
||||
4. Commit SHA: rebuild once per commit
|
||||
5. apps.json hash: rebuild only when the custom app definition changes - additional requirements, see below example
|
||||
|
||||
### Examples:
|
||||
|
||||
#### 1. No override - not recommended
|
||||
|
||||
This will reuse a previously build layer and won't check for app updates except Frappe framework
|
||||
|
||||
```yaml
|
||||
- name: Build Docker image
|
||||
shell: sh
|
||||
run: |
|
||||
docker build \
|
||||
--build-arg=FRAPPE_PATH=https://github.com/frappe/frappe \
|
||||
--build-arg=FRAPPE_BRANCH=version-16 \
|
||||
--secret=id=apps_json,src=apps.json \
|
||||
--tag=custom:16 \
|
||||
--file=images/layered/Containerfile .
|
||||
```
|
||||
|
||||
#### 2. Timestamp
|
||||
|
||||
```yaml
|
||||
- name: Build Docker image
|
||||
shell: sh
|
||||
run: |
|
||||
docker build \
|
||||
--build-arg=FRAPPE_PATH=https://github.com/frappe/frappe \
|
||||
--build-arg=FRAPPE_BRANCH=version-16 \
|
||||
--build-arg=CACHE_BUST="$(date +%s)" \
|
||||
--secret=id=apps_json,src=apps.json \
|
||||
--tag=custom:16 \
|
||||
--file=images/layered/Containerfile .
|
||||
```
|
||||
|
||||
#### 3. Pipeline run ID from GitHub
|
||||
|
||||
```yaml
|
||||
- name: Build Docker image
|
||||
shell: sh
|
||||
run: |
|
||||
docker build \
|
||||
--build-arg=FRAPPE_PATH=https://github.com/frappe/frappe \
|
||||
--build-arg=FRAPPE_BRANCH=version-16 \
|
||||
--build-arg=CACHE_BUST="$GITHUB_RUN_ID" \
|
||||
--secret=id=apps_json,src=apps.json \
|
||||
--tag=custom:16 \
|
||||
--file=images/layered/Containerfile .
|
||||
```
|
||||
|
||||
#### 4. Commit SHA from GitHub
|
||||
|
||||
```yaml
|
||||
- name: Build Docker image
|
||||
shell: sh
|
||||
run: |
|
||||
docker build \
|
||||
--build-arg=FRAPPE_PATH=https://github.com/frappe/frappe \
|
||||
--build-arg=FRAPPE_BRANCH=version-16 \
|
||||
--build-arg=CACHE_BUST="$GITHUB_SHA" \
|
||||
--secret=id=apps_json,src=apps.json \
|
||||
--tag=custom:16 \
|
||||
--file=images/layered/Containerfile .
|
||||
```
|
||||
|
||||
#### 5. apps.json hash
|
||||
|
||||
Note: When using branch references in `apps.json`, the hash only changes when the file content changes, not when an upstream app branch receives updates. This method works best when pinning specific commits or releases.
|
||||
|
||||
```yaml
|
||||
- name: Build Docker image
|
||||
shell: sh
|
||||
run: |
|
||||
docker build \
|
||||
--build-arg=FRAPPE_PATH=https://github.com/frappe/frappe \
|
||||
--build-arg=FRAPPE_BRANCH=version-16 \
|
||||
--build-arg=CACHE_BUST="$(sha256sum apps.json | awk '{print $1}')" \
|
||||
--secret=id=apps_json,src=apps.json \
|
||||
--tag=custom:16 \
|
||||
--file=images/layered/Containerfile .
|
||||
```
|
||||
|
||||
## Automated deployment
|
||||
|
||||
### Automate site migration
|
||||
|
||||
After updating a custom image or deploying new app versions, a database migration
|
||||
must be executed using `bench migrate`.
|
||||
|
||||
Without running migrations, the site may become inconsistent or fail to start properly.
|
||||
|
||||
For automated deployments, this step should not be performed manually.
|
||||
|
||||
Consider using the dedicated `migrator` service provided as a Compose override.
|
||||
It ensures that migrations are executed automatically when the stack starts.
|
||||
|
||||
This approach is especially useful in CI/CD pipelines where no interactive access
|
||||
to the backend container is available.
|
||||
|
||||
See [Compose override](../../overrides/compose.migrator.yaml)
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
---
|
||||
title: Production
|
||||
---
|
||||
|
|
@ -1,7 +1,3 @@
|
|||
---
|
||||
title: Site Operations
|
||||
---
|
||||
|
||||
# Site operations
|
||||
|
||||
> 💡 You should setup `--project-name` option in `docker-compose` commands if you have non-standard project name.
|
||||
|
|
@ -19,12 +15,17 @@ docker-compose exec backend bench new-site --mariadb-user-host-login-scope=% --d
|
|||
|
||||
If you need to install some app, specify `--install-app`. To see all options, just run `bench new-site --help`.
|
||||
|
||||
To create a Postgres site (assuming you already use [Postgres compose override](../02-setup/05-overrides.md)), the `root_login` and `root_password` are now automatically set by the `configurator`. For major version upgrades, please refer to the [Postgres Migration Guide](../06-migration/03-postgres-major-version-upgrade.md).
|
||||
|
||||
To create a new Postgres site:
|
||||
To create Postgres site (assuming you already use [Postgres compose override](../02-setup/05-overrides.md)) you need have to do set `root_login` and `root_password` in common config before that:
|
||||
|
||||
```sh
|
||||
docker-compose exec backend bench new-site --db-type postgres --admin-password <admin-password> <site-name>
|
||||
docker-compose exec backend bench set-config -g root_login <root-login>
|
||||
docker-compose exec backend bench set-config -g root_password <root-password>
|
||||
```
|
||||
|
||||
Also command is slightly different:
|
||||
|
||||
```sh
|
||||
docker-compose exec backend bench new-site --mariadb-user-host-login-scope=% --db-type postgres --admin-password <admin-password> <site-name>
|
||||
```
|
||||
|
||||
## Push backup to S3 storage
|
||||
|
|
|
|||
|
|
@ -1,3 +0,0 @@
|
|||
---
|
||||
title: Operations
|
||||
---
|
||||
|
|
@ -1,7 +1,3 @@
|
|||
---
|
||||
title: Getting Started
|
||||
---
|
||||
|
||||
# Getting Started
|
||||
|
||||
## Prerequisites
|
||||
|
|
@ -101,26 +97,6 @@ PYENV_VERSION=3.9.17 bench init --skip-redis-config-generation --frappe-branch v
|
|||
cd frappe-bench
|
||||
```
|
||||
|
||||
At this point the the directory structure will be very close to this, if not exact,
|
||||
|
||||
```
|
||||
development/
|
||||
├── frappe-bench/ # Your actual Frappe installation
|
||||
│ ├── apps/ # All installed Frappe applications
|
||||
│ │ ├── frappe/ # Core framework (don't modify directly)
|
||||
│ │ ├── erpnext/ # ERPNext application (if installed)
|
||||
│ │ └── my_custom_app/ # Your custom apps (edit freely)
|
||||
│ ├── sites/ # Multi-tenant sites
|
||||
│ │ ├── development.localhost/ # Default dev site
|
||||
│ │ │ ├── site_config.json # Site-specific config
|
||||
│ │ │ └── private/files/ # Uploaded files
|
||||
│ │ └── common_site_config.json # Shared configuration
|
||||
│ ├── env/ # Python virtual environment
|
||||
│ ├── logs/ # Application logs
|
||||
│ └── config/ # Bench-level configuration
|
||||
└── .vscode/ # VSCode workspace settings
|
||||
```
|
||||
|
||||
### Setup hosts
|
||||
|
||||
We need to tell bench to use the right containers instead of localhost. Run the following commands inside the container:
|
||||
|
|
|
|||
|
|
@ -1,7 +1,3 @@
|
|||
---
|
||||
title: Debugging
|
||||
---
|
||||
|
||||
Add the following configuration to `launch.json` `configurations` array to start bench console and use debugger. Replace `development.localhost` with appropriate site. Also replace `frappe-bench` with name of the bench directory.
|
||||
|
||||
```json
|
||||
|
|
|
|||
|
|
@ -1,7 +1,3 @@
|
|||
---
|
||||
title: Local Services
|
||||
---
|
||||
|
||||
Add following to frappe container from the `.devcontainer/docker-compose.yml`:
|
||||
|
||||
```yaml
|
||||
|
|
|
|||
|
|
@ -1,254 +0,0 @@
|
|||
---
|
||||
title: Docker Development Setup
|
||||
---
|
||||
|
||||
# Docker Development Setup
|
||||
|
||||
A complete guide for setting up a Frappe development environment on x86 and ARM based computers running UNIX based OSes by running containers directly and working inside them via the terminal. No VS Code Dev Containers extension needed.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Devcontainers are the intended development setup for Frappe Framework but in case you don't want to use that method follow these instructions to use the CLI directly instead
|
||||
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- **Docker Desktop** (Applicable only for MacOS) — [download here](https://www.docker.com/products/docker-desktop/)
|
||||
- **Git**
|
||||
- A terminal (iTerm2, or the built-in Terminal.app)
|
||||
|
||||
### Docker Desktop Resource Allocation (Critical)
|
||||
|
||||
1. Open Docker Desktop → **Settings** → **Resources**
|
||||
2. **Memory**: at least **6 GB** (8 GB recommended)
|
||||
3. **CPUs**: at least **4**
|
||||
4. **Disk image size**: at least **60 GB**
|
||||
5. Click **Apply & Restart**
|
||||
|
||||
---
|
||||
|
||||
## Step 1 — Set ARM64 as Default Platform (ONLY FOR ARM BASED SYSTEMS)
|
||||
|
||||
```bash
|
||||
export DOCKER_DEFAULT_PLATFORM=linux/arm64
|
||||
```
|
||||
|
||||
Make it permanent:
|
||||
|
||||
```bash
|
||||
echo 'export DOCKER_DEFAULT_PLATFORM=linux/arm64' >> ~/.zshrc
|
||||
source ~/.zshrc
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Step 2 — Clone the Repo
|
||||
|
||||
```bash
|
||||
git clone https://github.com/frappe/frappe_docker.git
|
||||
cd frappe_docker
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Step 3 — Set Up the Dev Container Config
|
||||
|
||||
The `devcontainer-example/` folder contains a ready-made `docker-compose.yml` for development. Copy it into place:
|
||||
|
||||
```bash
|
||||
cp -R devcontainer-example .devcontainer
|
||||
```
|
||||
|
||||
This gives you `.devcontainer/docker-compose.yml` which defines all the services you need:
|
||||
|
||||
- `frappe` — the main development container (Debian, Python, Node, bench)
|
||||
- `mariadb` — the database
|
||||
- `redis-cache` — cache layer
|
||||
- `redis-queue` — background job queue
|
||||
|
||||
---
|
||||
|
||||
## Step 4 — Add ARM64 Platform to All Services
|
||||
|
||||
Open `.devcontainer/docker-compose.yml` in any editor and add `platform: linux/arm64` to every service block. It should look like this:
|
||||
|
||||
```yaml
|
||||
services:
|
||||
frappe:
|
||||
image: frappe/bench:latest
|
||||
platform: linux/arm64
|
||||
# ... rest of config
|
||||
|
||||
mariadb:
|
||||
image: mariadb:10.8
|
||||
platform: linux/arm64
|
||||
# ...
|
||||
|
||||
redis-cache:
|
||||
image: redis:6.2-alpine
|
||||
platform: linux/arm64
|
||||
# ...
|
||||
|
||||
redis-queue:
|
||||
image: redis:6.2-alpine
|
||||
platform: linux/arm64
|
||||
# ...
|
||||
```
|
||||
|
||||
> Without this, Docker may pull amd64 images and emulate them via Rosetta — things will work but be noticeably slower.
|
||||
|
||||
---
|
||||
|
||||
## Step 5 — Start the Containers
|
||||
|
||||
```bash
|
||||
docker compose -f .devcontainer/docker-compose.yml up -d
|
||||
```
|
||||
|
||||
Verify everything is running:
|
||||
|
||||
```bash
|
||||
docker compose -f .devcontainer/docker-compose.yml ps
|
||||
```
|
||||
|
||||
You should see all services with status `Up`.
|
||||
|
||||
In case you get any errors along the lines of,
|
||||
|
||||
```log
|
||||
Error response from daemon: failed to set up container networking: driver failed programming external connectivity on endpoint devcontainer-frappe-1 (44b337b68d100e914fab0ce446ed08d791cc73aaffb05cf47c347c00ff88f567): Bind for 0.0.0.0:9001 failed: port is already allocated
|
||||
```
|
||||
|
||||
- Check if the port is being used by another service with `lsof -i :PORT`
|
||||
> Usually on MacOS ports 8000 and 9000 are usually reserved for system use
|
||||
- Go to line 60 and 61 under the `frappe` service and change the ports
|
||||
|
||||
Eg:
|
||||
|
||||
```
|
||||
ports:
|
||||
- 8001-8005:8001-8005
|
||||
- 9002-9005:9002-9005
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Step 6 — Enter the Development Container
|
||||
|
||||
```bash
|
||||
docker exec -e "TERM=xterm-256color" -w /workspace/development -it devcontainer-frappe-1 bash
|
||||
```
|
||||
|
||||
> The container name is typically `devcontainer-frappe-1`. If it differs, check with `docker ps` and use the actual name shown.
|
||||
|
||||
You are now inside the container as the `frappe` user. All subsequent commands in this guide run **inside the container** unless noted otherwise.
|
||||
|
||||
---
|
||||
|
||||
## Step 7 — Initialize a Bench
|
||||
|
||||
```bash
|
||||
bench init --skip-redis-config-generation --frappe-branch version-16 frappe-bench
|
||||
cd frappe-bench
|
||||
```
|
||||
|
||||
Use `version-16` for the latest stable release. Swap for `version-15` if needed.
|
||||
|
||||
This creates:
|
||||
|
||||
```
|
||||
development/
|
||||
└── frappe-bench/
|
||||
├── apps/ ← All Frappe apps live here
|
||||
├── sites/ ← Your sites (databases, uploaded files)
|
||||
├── env/ ← Python virtualenv
|
||||
├── logs/
|
||||
└── Procfile
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Step 8 — Configure Service Hosts
|
||||
|
||||
Tell bench to use the containerised services (not localhost):
|
||||
|
||||
```bash
|
||||
bench set-config -g db_host mariadb
|
||||
bench set-config -g redis_cache redis://redis-cache:6379
|
||||
bench set-config -g redis_queue redis://redis-queue:6379
|
||||
bench set-config -g redis_socketio redis://redis-queue:6379
|
||||
```
|
||||
|
||||
If any command fails, edit the file directly:
|
||||
|
||||
```bash
|
||||
nano sites/common_site_config.json
|
||||
```
|
||||
|
||||
Paste:
|
||||
|
||||
```json
|
||||
{
|
||||
"db_host": "mariadb",
|
||||
"redis_cache": "redis://redis-cache:6379",
|
||||
"redis_queue": "redis://redis-queue:6379",
|
||||
"redis_socketio": "redis://redis-queue:6379"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Step 9 — Fix the Procfile
|
||||
|
||||
Redis runs in separate containers, so remove it from Honcho's Procfile to avoid conflicts:
|
||||
|
||||
```bash
|
||||
sudo sed -i '/redis/d' ./Procfile
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Step 10 — Create a Site
|
||||
|
||||
```bash
|
||||
bench new-site \
|
||||
--db-root-password 123 \
|
||||
--admin-password admin \
|
||||
--mariadb-user-host-login-scope=% \
|
||||
development.localhost
|
||||
```
|
||||
|
||||
- MariaDB root password: `123` (set in the docker-compose defaults)
|
||||
- Admin password: `admin` (change this to whatever you want)
|
||||
- Site name **must end in `.localhost`**
|
||||
|
||||
---
|
||||
|
||||
## Step 11 — Enable Developer Mode
|
||||
|
||||
```bash
|
||||
bench --site development.localhost set-config developer_mode 1
|
||||
bench --site development.localhost clear-cache
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Step 12 — Add development.localhost to /etc/hosts (on your Mac)
|
||||
|
||||
Run this **on your Mac** (not inside the container):
|
||||
|
||||
```bash
|
||||
echo "127.0.0.1 development.localhost" | sudo tee -a /etc/hosts
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Step 13 — Start the Dev Server
|
||||
|
||||
```bash
|
||||
bench build # (optional)
|
||||
bench start
|
||||
```
|
||||
|
||||
Open your browser at **http://development.localhost:8000**
|
||||
Login: `Administrator` / `admin`
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
---
|
||||
title: Development
|
||||
---
|
||||
|
|
@ -1,7 +1,3 @@
|
|||
---
|
||||
title: Migrate from Multi Image Setup
|
||||
---
|
||||
|
||||
## Migrate from multi-image setup
|
||||
|
||||
All the containers now use same image. Use `frappe/erpnext` instead of `frappe/frappe-worker`, `frappe/frappe-nginx` , `frappe/frappe-socketio` , `frappe/erpnext-worker` and `frappe/erpnext-nginx`.
|
||||
|
|
@ -114,14 +110,3 @@ create-site:
|
|||
|
||||
# ... removed for brevity
|
||||
```
|
||||
|
||||
## Upgrading from images with a nested sites/assets volume
|
||||
|
||||
Previous images declared `VOLUME /home/frappe/frappe-bench/sites/assets` separately. This created an implicit nested mountpoint inside the `sites` volume, which could cause Docker to attach different anonymous volumes per container in multi-container setups.
|
||||
That declaration has been removed. `sites` is now the single shared mount, consistent with the compose setup and docs.
|
||||
|
||||
**After pulling the updated image:**
|
||||
|
||||
- Recreate all containers (`docker compose up --force-recreate`). Without this, Docker may keep the old anonymous `sites/assets` volume
|
||||
attached from before the change.
|
||||
- No `bench build` is needed — this only fixes mount consistency, not the asset workflow.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,3 @@
|
|||
---
|
||||
title: Migrate Traefik from v2 to v3
|
||||
---
|
||||
|
||||
# Migrate an existing Traefik v2 instance to v3
|
||||
|
||||
Use this guide if you already run Traefik v2 with `frappe_docker` and want to upgrade to v3. It focuses on the image upgrade and the v3 routing rule changes that affect existing setups.
|
||||
|
|
|
|||
|
|
@ -1,49 +0,0 @@
|
|||
---
|
||||
title: Postgres Major Version Upgrade
|
||||
---
|
||||
|
||||
# PostgreSQL Major Version Upgrade (v13 to v15)
|
||||
|
||||
Upgrading PostgreSQL from version 13 to 15 is a major version jump. Since PostgreSQL does not support in-place data directory upgrades, existing users must manually migrate their data using `pg_dump`.
|
||||
|
||||
### **Migration Steps**
|
||||
|
||||
1. **Backup Existing Data (Version 13):**
|
||||
Before updating your compose file, ensure your containers are running and perform a dump of all databases.
|
||||
|
||||
```bash
|
||||
docker exec -it <project_name>-db-1 pg_dumpall -U postgres > full_dump.sql
|
||||
```
|
||||
|
||||
2. **Stop and Remove Containers:**
|
||||
|
||||
```bash
|
||||
docker compose down
|
||||
```
|
||||
|
||||
3. **Delete Old Data Volume:**
|
||||
PostgreSQL 15 cannot read data created by version 13. You must remove the existing volume (Warning: this deletes the old data directory).
|
||||
|
||||
```bash
|
||||
docker volume rm <project_name>_db-data
|
||||
```
|
||||
|
||||
4. **Update Image and Start (Version 15):**
|
||||
Update your `overrides/compose.postgres.yaml` (or pull the latest changes) and start the containers.
|
||||
|
||||
```bash
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
5. **Restore Data:**
|
||||
Restore the dump into the new PostgreSQL 15 instance.
|
||||
|
||||
```bash
|
||||
cat full_dump.sql | docker exec -i <project_name>-db-1 psql -U postgres
|
||||
```
|
||||
|
||||
6. **Verify and Clean Up:**
|
||||
Ensure your sites are working correctly with `bench migrate` and then remove the `full_dump.sql` file.
|
||||
```bash
|
||||
docker exec -it <project_name>-backend-1 bench --site all migrate
|
||||
```
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
---
|
||||
title: Migration
|
||||
---
|
||||
|
|
@ -1,11 +1,6 @@
|
|||
---
|
||||
title: Troubleshoot
|
||||
---
|
||||
|
||||
- [Fixing MariaDB issues after rebuilding the container](#fixing-mariadb-issues-after-rebuilding-the-container)
|
||||
- [docker-compose does not recognize variables from `.env` file](#docker-compose-does-not-recognize-variables-from-env-file)
|
||||
- [Windows Based Installation](#windows-based-installation)
|
||||
- [Redo installation](#redo-installation)
|
||||
1. [Fixing MariaDB issues after rebuilding the container](#fixing-mariadb-issues-after-rebuilding-the-container)
|
||||
1. [docker-compose does not recognize variables from `.env` file](#docker-compose-does-not-recognize-variables-from-env-file)
|
||||
1. [Windows Based Installation](#windows-based-installation)
|
||||
|
||||
### Fixing MariaDB issues after rebuilding the container
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,3 @@
|
|||
---
|
||||
title: NGINX in Windows
|
||||
---
|
||||
|
||||
# Resolving Docker `nginx-entrypoint.sh` Script Not Found Error on Windows
|
||||
|
||||
If you're encountering the error `exec /usr/local/bin/nginx-entrypoint.sh: no such file or directory` in a Docker container on Windows, follow these steps to resolve the issue.
|
||||
|
|
|
|||
|
|
@ -1,10 +0,0 @@
|
|||
---
|
||||
title: ARM64 / Apple Silicon
|
||||
---
|
||||
|
||||
## Notes on ARM64 and Apple Silicon
|
||||
|
||||
- Enable Docker Desktop's Rosetta emulation for initial builds when running on Apple Silicon with x86-only images.
|
||||
- Prefer published multi-arch images (`frappe/bench`, `frappe/erpnext`) or build locally with `docker buildx bake --set *.platform=linux/amd64,linux/arm64` to cover both architectures in one pass.
|
||||
- When using `pwd.yml`, export `DOCKER_DEFAULT_PLATFORM=linux/arm64` (or select the provided compose profile) to avoid unexpected emulation.
|
||||
- Keep bind mounts under your user home directory and apply `:cached` or `:delegated` consistency flags for better performance on macOS.
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
---
|
||||
title: Troubleshooting
|
||||
---
|
||||
|
|
@ -1,7 +1,3 @@
|
|||
---
|
||||
title: Build Version 10
|
||||
---
|
||||
|
||||
Clone the version-10 branch of this repo
|
||||
|
||||
```shell
|
||||
|
|
|
|||
|
|
@ -1,45 +0,0 @@
|
|||
---
|
||||
title: Configuring VitePress
|
||||
---
|
||||
|
||||
# Configuring VitePress
|
||||
|
||||
To modify any VitePress related settings, a JavaScript development environment is needed. Everything related to VitePress is contained in the `docs/` folder.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
1. Node.js v24 or above is recommended. To install and manage Node.js [nvm](https://github.com/nvm-sh/nvm) is the preferred way for Linux and MacOS. For Windows either official installer or [fnm](https://github.com/Schniz/fnm).
|
||||
2. pnpm package manager, v10.28 or above. Easiest way to install pnpm is using [corepack](https://pnpm.io/installation#using-corepack) which is part of Node.js.
|
||||
|
||||
## Development
|
||||
|
||||
To start a development environment,
|
||||
|
||||
1. Navigate to `/docs` directory in the terminal
|
||||
|
||||
```sh
|
||||
cd docs
|
||||
```
|
||||
|
||||
2. Install dependencies
|
||||
|
||||
```sh
|
||||
pnpm install
|
||||
```
|
||||
|
||||
3. Start the development server
|
||||
|
||||
```sh
|
||||
pnpm run docs:dev
|
||||
```
|
||||
|
||||
4. Open `http://localhost:5173/frappe_docker` in your browser to see the development version which will update the preview as you make changes.
|
||||
|
||||
## Configurations
|
||||
|
||||
1. Public assets related to VitePress site is added in the `docs/public` folder. This folder should **NOT** be used for adding images added inside the `.md` file.
|
||||
2. VitePress uses `index.md` files to do some special things. For example the home page is configured using the `docs/index.md` file. Checkout the file for more details.
|
||||
3. VitePress uses 'file based routing', meaning the URL paths mimics the directory and file structure inside the `docs/` directory.
|
||||
4. VitePress specific config is `docs/.vitepress/config.mts`.
|
||||
5. To auto populate the sidebar, a plugin called 'VitePress Sidebar' is used. The `config.mts` also include config for this plugin. More details can be found in the [documentation page](https://vitepress-sidebar.cdget.com/guide/getting-started).
|
||||
6. Each subfolder has an `index.md` file. This is used to specify the group heading of the pages in the sidebar.
|
||||
|
|
@ -1,161 +0,0 @@
|
|||
---
|
||||
title: Fork Management
|
||||
---
|
||||
|
||||
# Fork Management Best Practices
|
||||
|
||||
## Initial Fork Setup
|
||||
|
||||
```bash
|
||||
# 1. Fork on GitHub (use the Fork button)
|
||||
|
||||
# 2. Clone YOUR fork
|
||||
git clone https://github.com/YOUR_USERNAME/frappe_docker
|
||||
cd frappe_docker
|
||||
|
||||
# 3. Add upstream remote (original repo)
|
||||
git remote add upstream https://github.com/frappe/frappe_docker.git
|
||||
|
||||
# 4. Verify remotes
|
||||
git remote -v
|
||||
# origin https://github.com/YOUR_USERNAME/frappe_docker (your fork)
|
||||
# upstream https://github.com/frappe/frappe_docker (original)
|
||||
|
||||
# 5. Create development branch
|
||||
git checkout -b my-custom-setup
|
||||
```
|
||||
|
||||
## Safe Customization Zones
|
||||
|
||||
**✅ Safe (Won't conflict with upstream):**
|
||||
|
||||
```
|
||||
development/ # Your entire dev environment
|
||||
├── frappe-bench/ # Local installation
|
||||
└── .vscode/ # Your editor settings
|
||||
|
||||
compose.my-*.yaml # Your custom compose overrides
|
||||
scripts/my-*.sh # Your custom scripts
|
||||
docs/my-*.md # Your custom documentation
|
||||
.env.local # Local environment overrides
|
||||
.gitignore.local # Additional gitignore rules
|
||||
```
|
||||
|
||||
**⚠️ Modification Needed (May conflict):**
|
||||
|
||||
```
|
||||
compose.yaml # Core - use overrides instead
|
||||
docker-bake.hcl # Build config - use custom files
|
||||
images/*/Dockerfile # Core images - extend rather than modify
|
||||
```
|
||||
|
||||
**❌ Never Modify (Will break upstream sync):**
|
||||
|
||||
```
|
||||
.github/workflows/ # CI/CD pipelines
|
||||
images/*/ # Core image definitions
|
||||
resources/ # Core templates
|
||||
```
|
||||
|
||||
## Keeping Fork Updated
|
||||
|
||||
```bash
|
||||
# Regularly sync with upstream (weekly recommended)
|
||||
git checkout main
|
||||
git fetch upstream
|
||||
git merge upstream/main
|
||||
git push origin main
|
||||
|
||||
# Update your development branch
|
||||
git checkout my-custom-setup
|
||||
git rebase main # Or: git merge main
|
||||
|
||||
# If conflicts occur during rebase:
|
||||
# 1. Fix conflicts in files
|
||||
# 2. git add <fixed-files>
|
||||
# 3. git rebase --continue
|
||||
# Or: git rebase --abort (to cancel)
|
||||
```
|
||||
|
||||
## Custom Environment Pattern
|
||||
|
||||
Create override files for your customizations:
|
||||
|
||||
```yaml
|
||||
# compose.my-env.yaml
|
||||
version: "3.7"
|
||||
|
||||
services:
|
||||
backend:
|
||||
environment:
|
||||
# Your custom environment variables
|
||||
- DEVELOPER_MODE=true
|
||||
- MY_API_KEY=${MY_API_KEY}
|
||||
volumes:
|
||||
# Your custom bind mounts
|
||||
- ./development/my-scripts:/home/frappe/my-scripts
|
||||
- ./development/my-config:/home/frappe/config
|
||||
|
||||
# Your additional services
|
||||
my-monitoring:
|
||||
image: prom/prometheus
|
||||
ports:
|
||||
- "9090:9090"
|
||||
volumes:
|
||||
- ./monitoring/prometheus.yml:/etc/prometheus/prometheus.yml
|
||||
# Use it:
|
||||
# docker compose -f compose.yaml -f compose.my-env.yaml up
|
||||
```
|
||||
|
||||
## .gitignore Strategy
|
||||
|
||||
Add to `.gitignore` (or create `.gitignore.local`):
|
||||
|
||||
```gitignore
|
||||
# Local environment files
|
||||
.env.local
|
||||
*.local.yaml
|
||||
compose.my-*.yaml
|
||||
|
||||
# Development artifacts
|
||||
development/frappe-bench/sites/*
|
||||
development/frappe-bench/apps/*
|
||||
!development/frappe-bench/apps.json
|
||||
development/frappe-bench/logs/
|
||||
development/frappe-bench/env/
|
||||
|
||||
# Local customizations
|
||||
my-local-configs/
|
||||
scripts/my-*.sh
|
||||
docs/internal-*.md
|
||||
|
||||
# IDE
|
||||
.vscode/settings.json.local
|
||||
.idea/
|
||||
|
||||
# Temporary files
|
||||
*.swp
|
||||
*.swo
|
||||
*~
|
||||
.DS_Store
|
||||
```
|
||||
|
||||
## Contributing Back to Upstream
|
||||
|
||||
```bash
|
||||
# 1. Create feature branch from main
|
||||
git checkout main
|
||||
git pull upstream main
|
||||
git checkout -b feature/my-improvement
|
||||
|
||||
# 2. Make changes and commit
|
||||
git add .
|
||||
git commit -m "feat: add awesome feature"
|
||||
|
||||
# 3. Push to YOUR fork
|
||||
git push origin feature/my-improvement
|
||||
|
||||
# 4. Create Pull Request on GitHub
|
||||
# Go to: https://github.com/frappe/frappe_docker
|
||||
# Click "Compare & pull request"
|
||||
```
|
||||
|
|
@ -1,163 +0,0 @@
|
|||
---
|
||||
title: Framework Comparisons
|
||||
---
|
||||
|
||||
# Framework Comparisons
|
||||
|
||||
> **Note:** This section provides comparisons to other frameworks for developers familiar with them. If you're new to all frameworks, you can skip this section - the rest of the guide is self-contained.
|
||||
|
||||
## Frappe vs Django Concepts
|
||||
|
||||
### Project Structure Comparison
|
||||
|
||||
**Django Project:**
|
||||
|
||||
```python
|
||||
myproject/
|
||||
├── myproject/ # Project settings
|
||||
│ ├── settings.py
|
||||
│ ├── urls.py
|
||||
│ └── wsgi.py
|
||||
├── blog/ # Django app
|
||||
│ ├── models.py
|
||||
│ ├── views.py
|
||||
│ └── urls.py
|
||||
├── shop/ # Django app
|
||||
└── users/ # Django app
|
||||
```
|
||||
|
||||
**Frappe Bench:**
|
||||
|
||||
```
|
||||
bench/
|
||||
├── apps/
|
||||
│ ├── frappe/ # Core framework (comparable to Django itself)
|
||||
│ ├── erpnext/ # Complete business app (like Django + DRF + Celery + admin)
|
||||
│ ├── hrms/ # HR Management app
|
||||
│ └── my_custom_app/ # YOUR custom app
|
||||
└── sites/
|
||||
└── mysite.com/ # Site instance (like Django project + database)
|
||||
├── site_config.json
|
||||
└── private/files/
|
||||
```
|
||||
|
||||
### Conceptual Mapping
|
||||
|
||||
| Django | Frappe | Notes |
|
||||
| ------------------ | ----------------- | ----------------------------------------------- |
|
||||
| Model | DocType | But includes UI, permissions, API automatically |
|
||||
| View | Controller method | Much less code needed |
|
||||
| Admin | Desk | More powerful, auto-generated |
|
||||
| DRF Serializer | Built-in | Automatic from DocType |
|
||||
| Celery task | Background job | Built-in, no separate setup |
|
||||
| signals | hooks.py | More structured |
|
||||
| Management command | bench command | More discoverable |
|
||||
|
||||
### Key Architectural Differences
|
||||
|
||||
1. **Multi-tenancy**
|
||||
|
||||
- Django: One app = one database (typically)
|
||||
- Frappe: One installation = many sites, each with own database
|
||||
|
||||
2. **Background Jobs**
|
||||
|
||||
- Django: Requires Celery + Redis + worker setup
|
||||
- Frappe: Built-in queue system, just use `enqueue()`
|
||||
|
||||
3. **Real-time**
|
||||
|
||||
- Django: Requires Channels + Redis + ASGI setup
|
||||
- Frappe: Socket.IO built-in, automatic for DocType updates
|
||||
|
||||
4. **Admin/Management**
|
||||
|
||||
- Django: Admin for models, basic CRUD
|
||||
- Frappe: Full-featured Desk with reports, dashboards, permissions
|
||||
|
||||
5. **API**
|
||||
- Django: Manual DRF setup, serializers, views
|
||||
- Frappe: Automatic REST + RPC from DocType definitions
|
||||
|
||||
### Code Comparison Example
|
||||
|
||||
**Creating a "Customer" model:**
|
||||
|
||||
Django (requires ~50+ lines):
|
||||
|
||||
```python
|
||||
# models.py
|
||||
class Customer(models.Model):
|
||||
name = models.CharField(max_length=100)
|
||||
email = models.EmailField(unique=True)
|
||||
|
||||
# serializers.py
|
||||
class CustomerSerializer(serializers.ModelSerializer):
|
||||
# ...
|
||||
|
||||
# views.py
|
||||
class CustomerViewSet(viewsets.ModelViewSet):
|
||||
# ...
|
||||
|
||||
# urls.py
|
||||
router.register(r'customers', CustomerViewSet)
|
||||
|
||||
# admin.py
|
||||
@admin.register(Customer)
|
||||
class CustomerAdmin(admin.ModelAdmin):
|
||||
# ...
|
||||
```
|
||||
|
||||
Frappe (DocType JSON + ~10 lines Python):
|
||||
|
||||
```json
|
||||
// customer.json (auto-generated via UI or code)
|
||||
{
|
||||
"name": "Customer",
|
||||
"fields": [
|
||||
{ "fieldname": "customer_name", "fieldtype": "Data" },
|
||||
{ "fieldname": "email", "fieldtype": "Data", "unique": 1 }
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
```python
|
||||
# customer.py (only for custom business logic)
|
||||
import frappe
|
||||
from frappe.model.document import Document
|
||||
|
||||
class Customer(Document):
|
||||
def validate(self):
|
||||
# Custom validation logic only
|
||||
pass
|
||||
```
|
||||
|
||||
✅ **Automatically includes:**
|
||||
|
||||
- REST API (`/api/resource/Customer`)
|
||||
- List view, Form view
|
||||
- Search, Filters, Sorting
|
||||
- Permissions (Create, Read, Update, Delete)
|
||||
- Audit trail (created_by, modified_by, versions)
|
||||
- Print formats, Email templates
|
||||
|
||||
### When to Choose Frappe vs Django
|
||||
|
||||
**Choose Frappe when:**
|
||||
|
||||
- Building business applications (ERP, CRM, project management)
|
||||
- Need multi-tenancy out-of-the-box
|
||||
- Want rapid development with auto-generated UI
|
||||
- Need role-based permissions and workflows
|
||||
- Building for non-technical users who need customization
|
||||
|
||||
**Choose Django when:**
|
||||
|
||||
- Building consumer web apps (social media, e-commerce frontend)
|
||||
- Need full control over every aspect
|
||||
- Have highly custom UI requirements
|
||||
- Team is already Django-expert
|
||||
- Building API-only services
|
||||
|
||||
**Hybrid Approach:**
|
||||
Many teams use both: Frappe for back-office/admin tools, Django for customer-facing web apps.
|
||||
|
|
@ -1,18 +0,0 @@
|
|||
---
|
||||
title: External Links
|
||||
---
|
||||
|
||||
# External Links
|
||||
|
||||
## Official Documentation
|
||||
|
||||
- [Frappe Framework Docs](https://frappeframework.com/docs) - Core framework documentation
|
||||
- [Frappe Docker Docs](https://github.com/frappe/frappe_docker/tree/main/docs) - This repository's docs
|
||||
- [ERPNext Documentation](https://docs.erpnext.com) - ERPNext user and developer docs
|
||||
- [Docker Documentation](https://docs.docker.com) - Docker fundamentals
|
||||
|
||||
## Community Resources
|
||||
|
||||
- [Frappe Forum](https://discuss.frappe.io) - Community Q&A
|
||||
- [Frappe School](https://frappe.school) - Video tutorials
|
||||
- [Frappe GitHub](https://github.com/frappe/frappe) - Framework source code
|
||||
|
|
@ -1,312 +0,0 @@
|
|||
---
|
||||
title: GitHub Actions Image Workflows
|
||||
---
|
||||
|
||||
This document describes the current workflow setup for shared core images and reusable downstream app images.
|
||||
|
||||
# Workflow roles
|
||||
|
||||
The current workflow layout is:
|
||||
|
||||
- `.github/workflows/core-build-develop.yml`
|
||||
- `.github/workflows/core-build-stable.yml`
|
||||
- `.github/workflows/core-build-test-images.yml`
|
||||
- `.github/workflows/core-publish-images.yml`
|
||||
- `.github/workflows/app-build-image.yml`
|
||||
|
||||
`core-build-develop.yml` and `core-build-stable.yml` are orchestration workflows.
|
||||
They decide when the core image pipeline runs.
|
||||
|
||||
`core-build-test-images.yml` is the reusable workflow that:
|
||||
|
||||
- resolves the image versions for the requested release line
|
||||
- builds the shared core images into a local registry
|
||||
- runs the test suite against those images
|
||||
|
||||
`core-publish-images.yml` is the reusable workflow that:
|
||||
|
||||
- publishes the tested images to Docker Hub
|
||||
- publishes `base` and `build` to GHCR
|
||||
|
||||
`app-build-image.yml` is the reusable workflow that downstream repositories call to:
|
||||
|
||||
- create an `apps.json` file from the caller's app repository and ref
|
||||
- build `images/layered/Containerfile`
|
||||
- consume existing `base` and `build` images
|
||||
- install the requested app into the final image
|
||||
- optionally push the final app image to the caller's registry
|
||||
|
||||
# Current flow
|
||||
|
||||
The current structure is:
|
||||
|
||||
```text
|
||||
core orchestration
|
||||
-> core build and test
|
||||
-> core publish
|
||||
|
||||
downstream app workflow
|
||||
-> consume published base and build
|
||||
-> install app
|
||||
-> publish final app image
|
||||
```
|
||||
|
||||
Current Mermaid overview:
|
||||
|
||||
```mermaid
|
||||
flowchart TD
|
||||
subgraph Core["Core image flow"]
|
||||
A[core-build-develop.yml or core-build-stable.yml]
|
||||
B[core-build-test-images.yml]
|
||||
C[Resolve versions]
|
||||
D[Build local test images]
|
||||
E[Run pytest]
|
||||
F[core-publish-images.yml]
|
||||
G[Push Docker Hub: erpnext, base, build]
|
||||
H[Push GHCR: base, build]
|
||||
|
||||
A --> B
|
||||
B --> C
|
||||
C --> D
|
||||
D --> E
|
||||
E --> F
|
||||
F --> G
|
||||
F --> H
|
||||
end
|
||||
|
||||
subgraph App["Downstream app flow"]
|
||||
I[Downstream repo workflow]
|
||||
J[app-build-image.yml]
|
||||
K[Create apps.json]
|
||||
L[Build images/layered/Containerfile]
|
||||
M[Install app]
|
||||
N[Push final app image]
|
||||
|
||||
I --> J
|
||||
J --> K
|
||||
K --> L
|
||||
L --> M
|
||||
M --> N
|
||||
end
|
||||
|
||||
G --> J
|
||||
H --> J
|
||||
```
|
||||
|
||||
More concretely:
|
||||
|
||||
```text
|
||||
core-build-test-images.yml
|
||||
-> resolves frappe and erpnext tags
|
||||
-> builds images into a local CI registry
|
||||
-> runs tests
|
||||
|
||||
core-publish-images.yml
|
||||
-> pushes Docker Hub: erpnext, base, build
|
||||
-> pushes GHCR: base, build
|
||||
|
||||
app-build-image.yml
|
||||
-> pulls:
|
||||
- <prefix>/base:<frappe_ref>
|
||||
- <prefix>/build:<frappe_ref>
|
||||
-> installs app from app_repo + app_ref
|
||||
-> pushes final image_name:image_tag
|
||||
```
|
||||
|
||||
# Naming convention
|
||||
|
||||
GitHub Actions requires workflow files to stay directly inside `.github/workflows`.
|
||||
Subdirectories are not supported for workflow files, so structure should come from file names and `name:` values.
|
||||
|
||||
Recommended file naming convention:
|
||||
|
||||
```text
|
||||
<area>-<action>-<subject>.yml
|
||||
```
|
||||
|
||||
Current examples:
|
||||
|
||||
- `core-build-bench.yml`
|
||||
- `core-build-develop.yml`
|
||||
- `core-build-stable.yml`
|
||||
- `core-build-test-images.yml`
|
||||
- `core-publish-images.yml`
|
||||
- `app-build-image.yml`
|
||||
- `docs-publish-site.yml`
|
||||
|
||||
Recommended visible workflow names:
|
||||
|
||||
- `Core / Build Bench`
|
||||
- `Core / Build Develop`
|
||||
- `Core / Build Stable`
|
||||
- `Core / Build and Test Images`
|
||||
- `Core / Publish Images`
|
||||
- `App / Build Image`
|
||||
- `Docs / Publish Site`
|
||||
|
||||
# Style rules
|
||||
|
||||
To keep workflows predictable, use one convention per category instead of mixing styles.
|
||||
|
||||
Workflow file names should use kebab-case:
|
||||
|
||||
```text
|
||||
core-build-test-images.yml
|
||||
app-build-image.yml
|
||||
```
|
||||
|
||||
Workflow display names should use short title-style groups:
|
||||
|
||||
```text
|
||||
Core / Build and Test Images
|
||||
App / Build Image
|
||||
```
|
||||
|
||||
Workflow inputs should use snake_case:
|
||||
|
||||
```yaml
|
||||
app_name:
|
||||
frappe_ref:
|
||||
image_name:
|
||||
```
|
||||
|
||||
Environment variables should use upper snake case:
|
||||
|
||||
```text
|
||||
FRAPPE_IMAGE_PREFIX
|
||||
PYTHON_VERSION
|
||||
NODE_VERSION
|
||||
```
|
||||
|
||||
The recommended rule set is:
|
||||
|
||||
- workflow file names: kebab-case
|
||||
- workflow `name:` values: grouped title case
|
||||
- workflow inputs: snake_case
|
||||
- job ids and step ids: snake_case where practical
|
||||
- environment variables: UPPER_SNAKE_CASE
|
||||
|
||||
This means `-` is preferred for file names, while `_` remains appropriate for YAML keys, inputs, and environment variables.
|
||||
|
||||
# Important inputs in `app-build-image.yml`
|
||||
|
||||
The reusable app workflow is controlled mainly by these inputs:
|
||||
|
||||
- `app_name`
|
||||
The application directory name, for example `crm`
|
||||
- `app_repo`
|
||||
The Git repository to install, for example `frappe/crm`
|
||||
- `app_ref`
|
||||
The branch or tag to install, for example `develop`
|
||||
- `frappe_ref`
|
||||
The tag of the existing `base` and `build` images, for example `version-16`
|
||||
- `frappe_image_prefix`
|
||||
Where the shared `base` and `build` images come from, for example `frappe` or `ghcr.io/frappe`
|
||||
- `image_name`
|
||||
The final target image name, for example `ghcr.io/acme/crm`
|
||||
- `image_tag`
|
||||
The final target image tag, for example `develop`
|
||||
- `registry`
|
||||
The registry for the final push, for example `ghcr.io` or `docker.io`
|
||||
|
||||
The key distinction is:
|
||||
|
||||
```text
|
||||
frappe_image_prefix = source of shared base/build images
|
||||
image_name = destination of the final app image
|
||||
```
|
||||
|
||||
# Example: caller repository publishes to GHCR
|
||||
|
||||
This example assumes:
|
||||
|
||||
- shared base images exist in `ghcr.io/frappe/base` and `ghcr.io/frappe/build`
|
||||
- the caller repository wants to publish its own app image to `ghcr.io/acme/crm`
|
||||
|
||||
```yaml
|
||||
name: App / Build CRM Image
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
push:
|
||||
branches:
|
||||
- develop
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
packages: write
|
||||
|
||||
jobs:
|
||||
build-image:
|
||||
uses: frappe/frappe_docker/.github/workflows/app-build-image.yml@main
|
||||
with:
|
||||
app_name: crm
|
||||
app_repo: acme/crm
|
||||
app_ref: develop
|
||||
frappe_ref: version-16
|
||||
frappe_image_prefix: ghcr.io/frappe
|
||||
image_name: ghcr.io/acme/crm
|
||||
image_tag: develop
|
||||
registry: ghcr.io
|
||||
push: true
|
||||
platforms: linux/amd64
|
||||
```
|
||||
|
||||
What happens:
|
||||
|
||||
```text
|
||||
1. app-build-image.yml is called
|
||||
2. apps.json is generated from acme/crm + develop
|
||||
3. the workflow builds images/layered/Containerfile
|
||||
4. layered uses:
|
||||
- ghcr.io/frappe/build:version-16
|
||||
- ghcr.io/frappe/base:version-16
|
||||
5. CRM is installed
|
||||
6. the final image is pushed to ghcr.io/acme/crm:develop
|
||||
```
|
||||
|
||||
For GHCR, the caller workflow should grant:
|
||||
|
||||
- `permissions: packages: write`
|
||||
|
||||
The reusable workflow then logs in with the workflow token.
|
||||
|
||||
# Example: caller repository publishes to Docker Hub
|
||||
|
||||
This example assumes:
|
||||
|
||||
- shared base images come from Docker Hub under `frappe`
|
||||
- the caller repository wants to publish its app image to Docker Hub as `acme/crm`
|
||||
|
||||
```yaml
|
||||
name: App / Build CRM Image
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
push:
|
||||
branches:
|
||||
- develop
|
||||
|
||||
jobs:
|
||||
build-image:
|
||||
uses: frappe/frappe_docker/.github/workflows/app-build-image.yml@main
|
||||
with:
|
||||
app_name: crm
|
||||
app_repo: acme/crm
|
||||
app_ref: develop
|
||||
frappe_ref: version-16
|
||||
frappe_image_prefix: frappe
|
||||
image_name: acme/crm
|
||||
image_tag: develop
|
||||
registry: docker.io
|
||||
push: true
|
||||
platforms: linux/amd64
|
||||
secrets:
|
||||
REGISTRY_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
|
||||
REGISTRY_PASSWORD: ${{ secrets.DOCKERHUB_TOKEN }}
|
||||
```
|
||||
|
||||
In this case:
|
||||
|
||||
- shared images are pulled from `frappe/base:version-16` and `frappe/build:version-16`
|
||||
- the final image is pushed to Docker Hub as `acme/crm:develop`
|
||||
|
|
@ -1,62 +0,0 @@
|
|||
---
|
||||
title: How Assets are handled
|
||||
---
|
||||
|
||||
# Assets Reference
|
||||
|
||||
## Problem
|
||||
|
||||
The `sites` directory contains both persistent data (site config, uploaded files, etc.) and build-time artifacts (`sites/assets`). Mounting the entire `sites` directory as a Docker volume causes assets to be persisted alongside config, which leads to:
|
||||
|
||||
- Stale assets surviving image updates
|
||||
- Asset/manifest mismatches after rebuilds
|
||||
- Assets being tied to the volume lifecycle rather than the image lifecycle
|
||||
|
||||
## Solution
|
||||
|
||||
Assets are moved out of the `sites` volume during the build process and replaced with a **symlink** later on. This means assets are always served from the image layer, while the rest of `sites` remains persistent.
|
||||
|
||||
### How it works
|
||||
|
||||
During the image build (`Containerfile`), the following is done:
|
||||
|
||||
```dockerfile
|
||||
RUN cp -r /home/frappe/frappe-bench/sites/assets /home/frappe/frappe-bench/assets && \
|
||||
rm -rf /home/frappe/frappe-bench/sites/assets
|
||||
```
|
||||
|
||||
This runs **before** the `VOLUME` declaration, so the **`sites` volume does not contain any assets at all**.
|
||||
|
||||
Additionally an `ENTRYPOINT` is added to the images which adds a **symlink** from `assets` to `site\assets`.
|
||||
|
||||
> This is implemented in the entrypoint instead of baking the symlink directly into the image so it also works with pre-existing or already-initialized `sites` volumes.
|
||||
> Since mounting a volume over `/home/frappe/frappe-bench/sites` hides the image contents at that path, any symlink created during the image build would not be visible inside the mounted volume. The entrypoint recreates the symlink at container startup, ensuring it always exists and automatically repairing older volumes that may not already contain it.
|
||||
|
||||
At runtime:
|
||||
|
||||
```
|
||||
/home/frappe/frappe-bench/
|
||||
├── assets/ ← image layer (ephemeral, always matches the image)
|
||||
├── sites/
|
||||
│ ├── assets -> /home/frappe/frappe-bench/assets ← symlink
|
||||
│ ├── common_site_config.json ← persisted in volume
|
||||
│ └── <site>/ ← persisted in volume
|
||||
└── logs/ ← persisted in volume
|
||||
```
|
||||
|
||||
### Volume behavior
|
||||
|
||||
| Path | Persistent | Source |
|
||||
| -------------------------- | ----------------------- | ---------------------- |
|
||||
| `sites/` (except assets) | ✅ Yes | Named volume (`sites`) |
|
||||
| `sites/assets` (symlink) | ✅ Yes (symlink itself) | Named volume (`sites`) |
|
||||
| `assets/` (symlink target) | ❌ No | Image layer |
|
||||
| `logs/` | ✅ Yes | Unnamed volume |
|
||||
|
||||
The `sites/assets` symlink is stored inside the persistent `sites` volume, but its target (`/home/frappe/frappe-bench/assets`) comes from the container image. When the container is recreated or upgraded, the assets directory is recreated from the new image, ensuring assets always stay in sync with the running version.
|
||||
|
||||
## Important: `bench build` at runtime
|
||||
|
||||
Running `bench build` inside a running container will write new assets and eventually cause a mismatch between `assets.json` and the actual assets, breaking the UI. This can be recovered by recreating the containers
|
||||
|
||||
> Note: restarting the containers is not sufficient — they need to be recreated to discard the writable layer.
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
---
|
||||
title: References
|
||||
---
|
||||
|
|
@ -1,64 +0,0 @@
|
|||
---
|
||||
title: Custom Apps
|
||||
---
|
||||
|
||||
# Frappe Custom Applications
|
||||
|
||||
## What Are Frappe Custom Apps?
|
||||
|
||||
Custom apps are self-contained, modular business applications that extend Frappe's functionality. They follow a convention-over-configuration approach where the framework provides most boilerplate automatically.
|
||||
|
||||
## Custom App Structure
|
||||
|
||||
```
|
||||
my_custom_app/
|
||||
├── hooks.py # App configuration and hooks into Frappe lifecycle
|
||||
├── modules.txt # List of business modules in this app
|
||||
├── my_custom_app/
|
||||
│ ├── __init__.py
|
||||
│ ├── config/
|
||||
│ │ └── desktop.py # Desktop workspace icons and shortcuts
|
||||
│ ├── my_module/ # Business domain module (e.g., sales, inventory)
|
||||
│ │ ├── doctype/ # Document Types (data models)
|
||||
│ │ │ ├── customer/
|
||||
│ │ │ │ ├── customer.py # Python controller (business logic)
|
||||
│ │ │ │ ├── customer.json # Model definition (schema, validation)
|
||||
│ │ │ │ └── customer.js # Frontend logic (UI interactions)
|
||||
│ │ └── page/ # Custom pages (dashboards, reports)
|
||||
│ ├── public/ # Static assets (CSS, JS, images)
|
||||
│ ├── templates/ # Jinja2 templates for web pages
|
||||
│ └── www/ # Web pages accessible via routes
|
||||
└── requirements.txt # Python package dependencies
|
||||
```
|
||||
|
||||
## Built-in Features (Auto-generated)
|
||||
|
||||
Every Frappe app automatically includes:
|
||||
|
||||
- **REST API** - Automatic CRUD endpoints from DocType definitions
|
||||
- **Permissions system** - Row-level and field-level access control
|
||||
- **Audit trails** - Automatic version tracking and change history
|
||||
- **Custom fields** - Runtime field additions without code changes
|
||||
- **Workflows** - Configurable approval and state management
|
||||
- **Reports** - Query builder and report designer
|
||||
- **Print formats** - PDF generation with custom templates
|
||||
- **Email integration** - Template-based email sending
|
||||
- **File attachments** - Document attachment management
|
||||
|
||||
## Creating Custom Apps
|
||||
|
||||
```bash
|
||||
# Enter the development container
|
||||
docker exec -it <container_name> bash
|
||||
|
||||
# Create new app (interactive prompts will ask for details)
|
||||
bench new-app my_custom_app
|
||||
|
||||
# Install app to a site
|
||||
bench --site mysite.com install-app my_custom_app
|
||||
|
||||
# Create a new DocType (data model)
|
||||
bench --site mysite.com console
|
||||
>>> bench.new_doc("DocType", {...})
|
||||
# Or use the web UI: Setup → Customize → DocType → New
|
||||
```
|
||||
|
|
@ -1,62 +0,0 @@
|
|||
---
|
||||
title: Docker Bind Mounts
|
||||
---
|
||||
|
||||
# Docker Bind Mounts
|
||||
|
||||
## What Are Bind Mounts?
|
||||
|
||||
Bind mounts create a direct connection between a directory on your host machine and a directory inside a container. Changes in either location are immediately reflected in the other - perfect for development where you want to edit code on your host and see changes in the container.
|
||||
|
||||
## Bind Mount vs Named Volume vs Anonymous Volume
|
||||
|
||||
| Type | Syntax | Use Case | Persistence |
|
||||
| -------------------- | ------------------------------ | -------------------------- | ---------------------------- |
|
||||
| **Bind Mount** | `./local/path:/container/path` | Development, config files | On host filesystem |
|
||||
| **Named Volume** | `volume_name:/container/path` | Production data, databases | Docker-managed |
|
||||
| **Anonymous Volume** | `/container/path` | Temporary/cache data | Docker-managed, auto-deleted |
|
||||
|
||||
## Bind Mount Examples
|
||||
|
||||
```yaml
|
||||
services:
|
||||
backend:
|
||||
volumes:
|
||||
# Development: Edit code on host, run in container
|
||||
- ./my_custom_app:/home/frappe/frappe-bench/apps/my_custom_app
|
||||
|
||||
# Configuration: Override container config with host file
|
||||
- ./custom-config.json:/home/frappe/frappe-bench/sites/common_site_config.json:ro # :ro = read-only
|
||||
|
||||
# Logs: Access container logs on host for debugging
|
||||
- ./logs:/home/frappe/frappe-bench/logs
|
||||
|
||||
# Database (not recommended for production)
|
||||
- ./data/mysql:/var/lib/mysql
|
||||
|
||||
# Named volume for production database
|
||||
db:
|
||||
volumes:
|
||||
- db_data:/var/lib/mysql # Managed by Docker, survives container deletion
|
||||
|
||||
volumes:
|
||||
db_data: # Define named volume
|
||||
```
|
||||
|
||||
## Performance Optimization (macOS/Windows)
|
||||
|
||||
Docker on macOS/Windows uses a VM, making bind mounts slower. Use these flags:
|
||||
|
||||
```yaml
|
||||
volumes:
|
||||
# :cached - Host writes are buffered (good for general development)
|
||||
- ./development:/home/frappe/frappe-bench:cached
|
||||
|
||||
# :delegated - Container writes are buffered (best when container writes heavily)
|
||||
- ./development:/home/frappe/frappe-bench:delegated
|
||||
|
||||
# :consistent - Full synchronization (slowest but safest)
|
||||
- ./development:/home/frappe/frappe-bench:consistent
|
||||
```
|
||||
|
||||
**Recommendation:** Use `:cached` for most development work on macOS/Windows.
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
---
|
||||
title: Concepts
|
||||
---
|
||||
|
|
@ -1,7 +1,3 @@
|
|||
---
|
||||
title: Getting Started
|
||||
---
|
||||
|
||||
# Getting Started with Frappe Docker
|
||||
|
||||
_A comprehensive guide for developers getting started with Frappe Docker, with comparisons to Django for teams familiar with that framework_
|
||||
|
|
@ -89,7 +85,7 @@ Four predefined Dockerfiles are available, each serving different use cases:
|
|||
- **images/layered/** - Same final contents as `custom` but based on prebuilt images from Docker Hub; faster builds for production when using Frappe-managed dependency versions
|
||||
- **images/production/** - Installs only Frappe and ERPNext (not customizable with `apps.json`); best for **quick starts or exploration**; for real deployments, use `custom` or `layered`
|
||||
|
||||
> **Note:** For detailed build arguments and advanced configuration options, see [docs/02-setup/01-overview.md](02-setup/01-overview.md).
|
||||
> **Note:** For detailed build arguments and advanced configuration options, see [docs/container-setup/01-overview.md](container-setup/01-overview.md).
|
||||
|
||||
### 📁 overrides/ - Compose File Extensions
|
||||
|
||||
|
|
@ -859,11 +855,11 @@ Many teams use both: Frappe for back-office/admin tools, Django for customer-fac
|
|||
|
||||
### Key Files in This Repository
|
||||
|
||||
- [`docs/05-development/01-development.md`](05-development/01-development.md) - Detailed development setup
|
||||
- [`docs/02-setup/04-env-variables.md`](02-setup/04-env-variables.md) - Environment variable reference
|
||||
- [`docs/02-setup/07-single-server-example.md`](02-setup/07-single-server-example.md) - Production deployment guide
|
||||
- [`docs/04-operations/01-site-operations.md`](04-operations/01-site-operations.md) - Common site management tasks
|
||||
- `development/installer.py` - Automated setup script
|
||||
- [`docs/development.md`](development.md) - Detailed development setup
|
||||
- [`docs/container-setup/env-variables.md`](container-setup/env-variables.md) - Environment variable reference
|
||||
- [`docs/single-server-example.md`](single-server-example.md) - Production deployment guide
|
||||
- [`docs/site-operations.md`](site-operations.md) - Common site management tasks
|
||||
- [`development/installer.py`](../development/installer.py) - Automated setup script
|
||||
- [`pwd.yml`](../pwd.yml) - Quick test configuration
|
||||
- [`compose.yaml`](../compose.yaml) - Base Docker Compose configuration
|
||||
|
||||
|
|
@ -958,7 +954,7 @@ bench update # Update framework and apps
|
|||
|
||||
### Getting Help
|
||||
|
||||
1. **Check existing docs** - Most issues covered in [`docs/07-troubleshooting/01-troubleshoot.md](07-troubleshooting/01-troubleshoot.md)
|
||||
1. **Check existing docs** - Most issues covered in [`docs/troubleshoot.md`](troubleshoot.md)
|
||||
2. **Search Frappe Forum** - [discuss.frappe.io](https://discuss.frappe.io)
|
||||
3. **GitHub Issues** - Search existing issues first
|
||||
4. **Discord/Telegram** - Community real-time chat (links in main repo)
|
||||
|
|
@ -969,7 +965,7 @@ Found issues or improvements for this guide?
|
|||
|
||||
- Create an issue: [frappe_docker/issues](https://github.com/frappe/frappe_docker/issues)
|
||||
- Submit focused PRs: keep updates scoped and split large efforts across multiple pull requests.
|
||||
- Review CONTRIBUTING.md: for coding standards and review expectations.
|
||||
- Review [CONTRIBUTING.md](../CONTRIBUTING.md) for coding standards and review expectations.
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -1,26 +0,0 @@
|
|||
---
|
||||
# https://vitepress.dev/reference/default-theme-home-page
|
||||
layout: home
|
||||
|
||||
hero:
|
||||
name: "Frappe in Docker"
|
||||
# text: "Frappe in Container"
|
||||
tagline: "Documentation to use Docker based setup of Frappe framework"
|
||||
image:
|
||||
src: /frappe-docker.png
|
||||
actions:
|
||||
- theme: brand
|
||||
text: Getting Started
|
||||
link: /getting-started
|
||||
- theme: alt
|
||||
text: Single Compose Setup
|
||||
link: /01-getting-started/04-single-compose-setup
|
||||
|
||||
features:
|
||||
- title: Containerised
|
||||
details: All the power of Frappe, but in the container
|
||||
- title: Setup in Minutes
|
||||
details: Get it started in a few minutes
|
||||
- title: Production Ready
|
||||
details: Deploy production applications with ease
|
||||
---
|
||||
|
|
@ -1,19 +0,0 @@
|
|||
{
|
||||
"devDependencies": {
|
||||
"vitepress": "2.0.0-alpha.16",
|
||||
"vitepress-sidebar": "1.33.1"
|
||||
},
|
||||
"scripts": {
|
||||
"docs:dev": "vitepress dev",
|
||||
"docs:build": "vitepress build",
|
||||
"docs:preview": "vitepress preview"
|
||||
},
|
||||
"pnpm": {
|
||||
"overrides": {
|
||||
"vite": "7.3.2",
|
||||
"minimatch": "10.2.5",
|
||||
"picomatch": "4.0.4"
|
||||
}
|
||||
},
|
||||
"packageManager": "pnpm@10.28.2+sha512.41872f037ad22f7348e3b1debbaf7e867cfd448f2726d9cf74c08f19507c31d2c8e7a11525b983febc2df640b5438dee6023ebb1f84ed43cc2d654d2bc326264"
|
||||
}
|
||||
1759
docs/pnpm-lock.yaml
1759
docs/pnpm-lock.yaml
File diff suppressed because it is too large
Load diff
Binary file not shown.
|
Before Width: | Height: | Size: 44 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 44 KiB |
15
example.env
15
example.env
|
|
@ -1,6 +1,6 @@
|
|||
# Reference: https://github.com/frappe/frappe_docker/blob/main/docs/02-setup/04-env-variables.md
|
||||
# Reference: https://github.com/frappe/frappe_docker/blob/main/docs/environment-variables.md
|
||||
|
||||
ERPNEXT_VERSION=v16.23.0
|
||||
ERPNEXT_VERSION=v15.96.1
|
||||
|
||||
DB_PASSWORD=123
|
||||
|
||||
|
|
@ -15,17 +15,6 @@ DB_PORT=
|
|||
REDIS_CACHE=
|
||||
REDIS_QUEUE=
|
||||
|
||||
|
||||
# The number of threads per Gunicorn worker process for handling concurrent requests.
|
||||
GUNICORN_THREADS=4
|
||||
|
||||
# The number of worker processes for handling requests.
|
||||
# A typical formula is (2 x number of CPU cores) + 1.
|
||||
GUNICORN_WORKERS=2
|
||||
|
||||
# Workers exceeding this timeout (in seconds) will be killed and restarted.
|
||||
GUNICORN_TIMEOUT=120
|
||||
|
||||
# Only with HTTPS override
|
||||
LETSENCRYPT_EMAIL=mail@example.com
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,6 @@ LABEL author=frappé
|
|||
|
||||
ARG GIT_REPO=https://github.com/frappe/bench.git
|
||||
ARG GIT_BRANCH=v5.x
|
||||
ARG INSTALL_CHROMIUM=true
|
||||
|
||||
RUN apt-get update \
|
||||
&& DEBIAN_FRONTEND=noninteractive apt-get install --no-install-recommends -y \
|
||||
|
|
@ -74,11 +73,6 @@ RUN apt-get update \
|
|||
file \
|
||||
# For MIME type detection
|
||||
media-types \
|
||||
# Chromium
|
||||
&& if [ "$INSTALL_CHROMIUM" != "false" ]; then \
|
||||
DEBIAN_FRONTEND=noninteractive apt-get install --no-install-recommends -y \
|
||||
chromium-headless-shell; \
|
||||
fi \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
|
||||
RUN sed -i -e 's/# en_US.UTF-8 UTF-8/en_US.UTF-8 UTF-8/' /etc/locale.gen \
|
||||
|
|
@ -105,18 +99,18 @@ USER frappe
|
|||
WORKDIR /home/frappe
|
||||
|
||||
# Install Python via pyenv
|
||||
ENV PYTHON_VERSION_PREV=3.12.12
|
||||
ENV PYTHON_VERSION_V14=3.10.13
|
||||
ENV PYTHON_VERSION=3.14.2
|
||||
ENV PYENV_ROOT=/home/frappe/.pyenv
|
||||
ENV PATH=$PYENV_ROOT/shims:$PYENV_ROOT/bin:$PATH
|
||||
|
||||
# From https://github.com/pyenv/pyenv#basic-github-checkout
|
||||
RUN git clone --depth 1 https://github.com/pyenv/pyenv.git .pyenv \
|
||||
&& pyenv install $PYTHON_VERSION_PREV \
|
||||
&& pyenv install $PYTHON_VERSION_V14 \
|
||||
&& pyenv install $PYTHON_VERSION \
|
||||
&& PYENV_VERSION=$PYTHON_VERSION_PREV pip install --no-cache-dir virtualenv \
|
||||
&& PYENV_VERSION=$PYTHON_VERSION_V14 pip install --no-cache-dir virtualenv \
|
||||
&& PYENV_VERSION=$PYTHON_VERSION pip install --no-cache-dir virtualenv \
|
||||
&& pyenv global $PYTHON_VERSION $PYTHON_VERSION_PREV \
|
||||
&& pyenv global $PYTHON_VERSION $PYTHON_VERSION_v14 \
|
||||
&& sed -Ei -e '/^([^#]|$)/ {a export PYENV_ROOT="/home/frappe/.pyenv" a export PATH="$PYENV_ROOT/bin:$PATH" a ' -e ':a' -e '$!{n;ba};}' ~/.profile \
|
||||
&& echo 'eval "$(pyenv init --path)"' >>~/.profile \
|
||||
&& echo 'eval "$(pyenv init -)"' >>~/.bashrc
|
||||
|
|
@ -132,15 +126,15 @@ RUN git clone ${GIT_REPO} --depth 1 -b ${GIT_BRANCH} .bench \
|
|||
&& echo "export BENCH_DEVELOPER=1" >>/home/frappe/.bashrc
|
||||
|
||||
# Install Node via nvm
|
||||
ENV NODE_VERSION_PREV=22.22.0
|
||||
ENV NODE_VERSION=24.13.0
|
||||
ENV NODE_VERSION_14=16.20.2
|
||||
ENV NODE_VERSION=24.12.0
|
||||
ENV NVM_DIR=/home/frappe/.nvm
|
||||
ENV PATH=${NVM_DIR}/versions/node/v${NODE_VERSION}/bin/:${PATH}
|
||||
|
||||
RUN wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.5/install.sh | bash \
|
||||
&& . ${NVM_DIR}/nvm.sh \
|
||||
&& nvm install ${NODE_VERSION_PREV} \
|
||||
&& nvm use v${NODE_VERSION_PREV} \
|
||||
&& nvm install ${NODE_VERSION_14} \
|
||||
&& nvm use v${NODE_VERSION_14} \
|
||||
&& npm install -g yarn \
|
||||
&& nvm install ${NODE_VERSION} \
|
||||
&& nvm use v${NODE_VERSION} \
|
||||
|
|
|
|||
|
|
@ -1,16 +1,13 @@
|
|||
ARG PYTHON_VERSION=3.14.2
|
||||
ARG PYTHON_VERSION=3.11.6
|
||||
ARG DEBIAN_BASE=bookworm
|
||||
FROM python:${PYTHON_VERSION}-slim-${DEBIAN_BASE} AS base
|
||||
|
||||
COPY resources/core/nginx/nginx-template.conf /templates/nginx/frappe.conf.template
|
||||
COPY resources/core/nginx/nginx-entrypoint.sh /usr/local/bin/nginx-entrypoint.sh
|
||||
COPY resources/core/nginx/security_headers.conf /etc/nginx/snippets/security_headers.conf
|
||||
|
||||
ARG WKHTMLTOPDF_VERSION=0.12.6.1-3
|
||||
ARG WKHTMLTOPDF_DISTRO=bookworm
|
||||
ARG INSTALL_CHROMIUM=true
|
||||
|
||||
ARG NODE_VERSION=24.13.0
|
||||
ARG NODE_VERSION=20.19.2
|
||||
ENV NVM_DIR=/home/frappe/.nvm
|
||||
ENV PATH=${NVM_DIR}/versions/node/v${NODE_VERSION}/bin/:${PATH}
|
||||
|
||||
|
|
@ -49,7 +46,6 @@ RUN useradd -ms /bin/bash frappe \
|
|||
&& nvm install ${NODE_VERSION} \
|
||||
&& nvm use v${NODE_VERSION} \
|
||||
&& npm install -g yarn \
|
||||
&& corepack enable pnpm \
|
||||
&& nvm alias default v${NODE_VERSION} \
|
||||
&& rm -rf ${NVM_DIR}/.cache \
|
||||
&& echo 'export NVM_DIR="/home/frappe/.nvm"' >>/home/frappe/.bashrc \
|
||||
|
|
@ -62,15 +58,9 @@ RUN useradd -ms /bin/bash frappe \
|
|||
&& curl -sLO https://github.com/wkhtmltopdf/packaging/releases/download/$WKHTMLTOPDF_VERSION/$downloaded_file \
|
||||
&& apt-get install -y ./$downloaded_file \
|
||||
&& rm $downloaded_file \
|
||||
# Chromium
|
||||
&& if [ "$INSTALL_CHROMIUM" != "false" ]; then \
|
||||
DEBIAN_FRONTEND=noninteractive apt-get install --no-install-recommends -y \
|
||||
chromium-headless-shell; \
|
||||
fi \
|
||||
# Clean up
|
||||
&& rm -rf /var/lib/apt/lists/* \
|
||||
&& rm -fr /etc/nginx/sites-enabled/default \
|
||||
&& mkdir -p /etc/nginx/snippets \
|
||||
&& pip3 install frappe-bench \
|
||||
# Fixes for non-root nginx and logs to stdout
|
||||
&& sed -i '/user www-data/d' /etc/nginx/nginx.conf \
|
||||
|
|
@ -78,14 +68,12 @@ RUN useradd -ms /bin/bash frappe \
|
|||
&& touch /run/nginx.pid \
|
||||
&& chown -R frappe:frappe /etc/nginx/conf.d \
|
||||
&& chown -R frappe:frappe /etc/nginx/nginx.conf \
|
||||
&& chown -R frappe:frappe /etc/nginx/snippets \
|
||||
&& chown -R frappe:frappe /var/log/nginx \
|
||||
&& chown -R frappe:frappe /var/lib/nginx \
|
||||
&& chown -R frappe:frappe /run/nginx.pid \
|
||||
&& chmod 755 /usr/local/bin/nginx-entrypoint.sh \
|
||||
&& chmod 644 /templates/nginx/frappe.conf.template
|
||||
|
||||
|
||||
FROM base AS builder
|
||||
|
||||
RUN apt-get update \
|
||||
|
|
@ -119,16 +107,18 @@ RUN apt-get update \
|
|||
libbz2-dev \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
|
||||
# apps.json includes
|
||||
ARG APPS_JSON_BASE64
|
||||
RUN if [ -n "${APPS_JSON_BASE64}" ]; then \
|
||||
mkdir /opt/frappe && echo "${APPS_JSON_BASE64}" | base64 -d > /opt/frappe/apps.json; \
|
||||
fi
|
||||
|
||||
USER frappe
|
||||
|
||||
ARG FRAPPE_BRANCH=version-16
|
||||
ARG FRAPPE_BRANCH=version-15
|
||||
ARG FRAPPE_PATH=https://github.com/frappe/frappe
|
||||
ARG CACHE_BUST=""
|
||||
|
||||
RUN --mount=type=secret,id=apps_json,target=/opt/frappe/apps.json,uid=1000,gid=1000 \
|
||||
: "${CACHE_BUST}" && \
|
||||
export APP_INSTALL_ARGS="" && \
|
||||
if [ -f /opt/frappe/apps.json ] && [ -s /opt/frappe/apps.json ]; then \
|
||||
RUN export APP_INSTALL_ARGS="" && \
|
||||
if [ -n "${APPS_JSON_BASE64}" ]; then \
|
||||
export APP_INSTALL_ARGS="--apps_path=/opt/frappe/apps.json"; \
|
||||
fi && \
|
||||
bench init ${APP_INSTALL_ARGS}\
|
||||
|
|
@ -151,24 +141,21 @@ COPY --from=builder --chown=frappe:frappe /home/frappe/frappe-bench /home/frappe
|
|||
|
||||
WORKDIR /home/frappe/frappe-bench
|
||||
|
||||
# Move assets to image-layer storage
|
||||
RUN cp -r /home/frappe/frappe-bench/sites/assets /home/frappe/frappe-bench/assets && \
|
||||
rm -rf /home/frappe/frappe-bench/sites/assets
|
||||
|
||||
VOLUME [ \
|
||||
"/home/frappe/frappe-bench/sites", \
|
||||
"/home/frappe/frappe-bench/sites/assets", \
|
||||
"/home/frappe/frappe-bench/logs" \
|
||||
]
|
||||
|
||||
USER root
|
||||
# This entrypoint script link build assets of the image to the mounted sites volume at container initialization
|
||||
COPY resources/core/main-entrypoint.sh /usr/local/bin/entrypoint.sh
|
||||
RUN chmod 755 /usr/local/bin/entrypoint.sh
|
||||
|
||||
COPY resources/core/start.sh /usr/local/bin/start.sh
|
||||
RUN chmod 755 /usr/local/bin/start.sh
|
||||
|
||||
USER frappe
|
||||
ENTRYPOINT ["/usr/local/bin/entrypoint.sh"]
|
||||
|
||||
CMD ["start.sh"]
|
||||
CMD [ \
|
||||
"/home/frappe/frappe-bench/env/bin/gunicorn", \
|
||||
"--chdir=/home/frappe/frappe-bench/sites", \
|
||||
"--bind=0.0.0.0:8000", \
|
||||
"--threads=4", \
|
||||
"--workers=2", \
|
||||
"--worker-class=gthread", \
|
||||
"--worker-tmp-dir=/dev/shm", \
|
||||
"--timeout=120", \
|
||||
"--preload", \
|
||||
"frappe.app:application" \
|
||||
]
|
||||
|
|
|
|||
|
|
@ -1,18 +1,21 @@
|
|||
ARG FRAPPE_BRANCH=version-16
|
||||
ARG FRAPPE_IMAGE_PREFIX=frappe
|
||||
ARG FRAPPE_BRANCH=version-15
|
||||
|
||||
FROM ${FRAPPE_IMAGE_PREFIX}/build:${FRAPPE_BRANCH} AS builder
|
||||
FROM frappe/build:${FRAPPE_BRANCH} AS builder
|
||||
|
||||
ARG FRAPPE_BRANCH=version-16
|
||||
ARG FRAPPE_BRANCH=version-15
|
||||
ARG FRAPPE_PATH=https://github.com/frappe/frappe
|
||||
ARG CACHE_BUST=""
|
||||
ARG APPS_JSON_BASE64
|
||||
|
||||
USER root
|
||||
|
||||
RUN if [ -n "${APPS_JSON_BASE64}" ]; then \
|
||||
mkdir /opt/frappe && echo "${APPS_JSON_BASE64}" | base64 -d > /opt/frappe/apps.json; \
|
||||
fi
|
||||
|
||||
USER frappe
|
||||
|
||||
RUN --mount=type=secret,id=apps_json,target=/opt/frappe/apps.json,uid=1000,gid=1000 \
|
||||
: "${CACHE_BUST}" && \
|
||||
export APP_INSTALL_ARGS="" && \
|
||||
if [ -f /opt/frappe/apps.json ] && [ -s /opt/frappe/apps.json ]; then \
|
||||
RUN export APP_INSTALL_ARGS="" && \
|
||||
if [ -n "${APPS_JSON_BASE64}" ]; then \
|
||||
export APP_INSTALL_ARGS="--apps_path=/opt/frappe/apps.json"; \
|
||||
fi && \
|
||||
bench init ${APP_INSTALL_ARGS}\
|
||||
|
|
@ -27,7 +30,7 @@ RUN --mount=type=secret,id=apps_json,target=/opt/frappe/apps.json,uid=1000,gid=1
|
|||
echo "{}" > sites/common_site_config.json && \
|
||||
find apps -mindepth 1 -path "*/.git" | xargs rm -fr
|
||||
|
||||
FROM ${FRAPPE_IMAGE_PREFIX}/base:${FRAPPE_BRANCH} AS backend
|
||||
FROM frappe/base:${FRAPPE_BRANCH} AS backend
|
||||
|
||||
USER frappe
|
||||
|
||||
|
|
@ -35,24 +38,21 @@ COPY --from=builder --chown=frappe:frappe /home/frappe/frappe-bench /home/frappe
|
|||
|
||||
WORKDIR /home/frappe/frappe-bench
|
||||
|
||||
# Move assets to image-layer storage
|
||||
RUN cp -r /home/frappe/frappe-bench/sites/assets /home/frappe/frappe-bench/assets && \
|
||||
rm -rf /home/frappe/frappe-bench/sites/assets
|
||||
|
||||
VOLUME [ \
|
||||
"/home/frappe/frappe-bench/sites", \
|
||||
"/home/frappe/frappe-bench/sites/assets", \
|
||||
"/home/frappe/frappe-bench/logs" \
|
||||
]
|
||||
|
||||
USER root
|
||||
# This entrypoint script link build assets of the image to the mounted sites volume at container initialization
|
||||
COPY resources/core/main-entrypoint.sh /usr/local/bin/entrypoint.sh
|
||||
RUN chmod 755 /usr/local/bin/entrypoint.sh
|
||||
|
||||
COPY resources/core/start.sh /usr/local/bin/start.sh
|
||||
RUN chmod 755 /usr/local/bin/start.sh
|
||||
|
||||
USER frappe
|
||||
ENTRYPOINT ["/usr/local/bin/entrypoint.sh"]
|
||||
|
||||
CMD ["start.sh"]
|
||||
CMD [ \
|
||||
"/home/frappe/frappe-bench/env/bin/gunicorn", \
|
||||
"--chdir=/home/frappe/frappe-bench/sites", \
|
||||
"--bind=0.0.0.0:8000", \
|
||||
"--threads=4", \
|
||||
"--workers=2", \
|
||||
"--worker-class=gthread", \
|
||||
"--worker-tmp-dir=/dev/shm", \
|
||||
"--timeout=120", \
|
||||
"--preload", \
|
||||
"frappe.app:application" \
|
||||
]
|
||||
|
|
|
|||
|
|
@ -1,12 +1,10 @@
|
|||
ARG PYTHON_VERSION=3.14.2
|
||||
ARG PYTHON_VERSION=3.11.6
|
||||
ARG DEBIAN_BASE=bookworm
|
||||
FROM python:${PYTHON_VERSION}-slim-${DEBIAN_BASE} AS base
|
||||
|
||||
ARG WKHTMLTOPDF_VERSION=0.12.6.1-3
|
||||
ARG WKHTMLTOPDF_DISTRO=bookworm
|
||||
ARG INSTALL_CHROMIUM=true
|
||||
|
||||
ARG NODE_VERSION=24.13.0
|
||||
ARG NODE_VERSION=20.19.2
|
||||
ENV NVM_DIR=/home/frappe/.nvm
|
||||
ENV PATH=${NVM_DIR}/versions/node/v${NODE_VERSION}/bin/:${PATH}
|
||||
|
||||
|
|
@ -45,7 +43,6 @@ RUN useradd -ms /bin/bash frappe \
|
|||
&& nvm install ${NODE_VERSION} \
|
||||
&& nvm use v${NODE_VERSION} \
|
||||
&& npm install -g yarn \
|
||||
&& corepack enable pnpm \
|
||||
&& nvm alias default v${NODE_VERSION} \
|
||||
&& rm -rf ${NVM_DIR}/.cache \
|
||||
&& echo 'export NVM_DIR="/home/frappe/.nvm"' >>/home/frappe/.bashrc \
|
||||
|
|
@ -58,15 +55,9 @@ RUN useradd -ms /bin/bash frappe \
|
|||
&& curl -sLO https://github.com/wkhtmltopdf/packaging/releases/download/$WKHTMLTOPDF_VERSION/$downloaded_file \
|
||||
&& apt-get install -y ./$downloaded_file \
|
||||
&& rm $downloaded_file \
|
||||
# Chromium
|
||||
&& if [ "$INSTALL_CHROMIUM" != "false" ]; then \
|
||||
DEBIAN_FRONTEND=noninteractive apt-get install --no-install-recommends -y \
|
||||
chromium-headless-shell; \
|
||||
fi \
|
||||
# Clean up
|
||||
&& rm -rf /var/lib/apt/lists/* \
|
||||
&& rm -fr /etc/nginx/sites-enabled/default \
|
||||
&& mkdir -p /etc/nginx/snippets \
|
||||
&& pip3 install frappe-bench \
|
||||
# Fixes for non-root nginx and logs to stdout
|
||||
&& sed -i '/user www-data/d' /etc/nginx/nginx.conf \
|
||||
|
|
@ -74,15 +65,12 @@ RUN useradd -ms /bin/bash frappe \
|
|||
&& touch /run/nginx.pid \
|
||||
&& chown -R frappe:frappe /etc/nginx/conf.d \
|
||||
&& chown -R frappe:frappe /etc/nginx/nginx.conf \
|
||||
&& chown -R frappe:frappe /etc/nginx/snippets \
|
||||
&& chown -R frappe:frappe /var/log/nginx \
|
||||
&& chown -R frappe:frappe /var/lib/nginx \
|
||||
&& chown -R frappe:frappe /run/nginx.pid
|
||||
|
||||
COPY resources/core/nginx/nginx-template.conf /templates/nginx/frappe.conf.template
|
||||
COPY resources/core/nginx/nginx-entrypoint.sh /usr/local/bin/nginx-entrypoint.sh
|
||||
COPY resources/core/nginx/security_headers.conf /etc/nginx/snippets/security_headers.conf
|
||||
RUN chmod 755 /usr/local/bin/nginx-entrypoint.sh
|
||||
|
||||
FROM base AS build
|
||||
|
||||
|
|
@ -115,10 +103,10 @@ USER frappe
|
|||
|
||||
FROM build AS builder
|
||||
|
||||
ARG FRAPPE_BRANCH=version-16
|
||||
ARG FRAPPE_BRANCH=version-15
|
||||
ARG FRAPPE_PATH=https://github.com/frappe/frappe
|
||||
ARG ERPNEXT_REPO=https://github.com/frappe/erpnext
|
||||
ARG ERPNEXT_BRANCH=version-16
|
||||
ARG ERPNEXT_BRANCH=version-15
|
||||
RUN bench init \
|
||||
--frappe-branch=${FRAPPE_BRANCH} \
|
||||
--frappe-path=${FRAPPE_PATH} \
|
||||
|
|
@ -142,24 +130,21 @@ COPY --from=builder --chown=frappe:frappe /home/frappe/frappe-bench /home/frappe
|
|||
|
||||
WORKDIR /home/frappe/frappe-bench
|
||||
|
||||
# Move assets to image-layer storage
|
||||
RUN cp -r /home/frappe/frappe-bench/sites/assets /home/frappe/frappe-bench/assets && \
|
||||
rm -rf /home/frappe/frappe-bench/sites/assets
|
||||
|
||||
VOLUME [ \
|
||||
"/home/frappe/frappe-bench/sites", \
|
||||
"/home/frappe/frappe-bench/sites/assets", \
|
||||
"/home/frappe/frappe-bench/logs" \
|
||||
]
|
||||
|
||||
USER root
|
||||
# This entrypoint script link build assets of the image to the mounted sites volume at container initialization
|
||||
COPY resources/core/main-entrypoint.sh /usr/local/bin/entrypoint.sh
|
||||
RUN chmod 755 /usr/local/bin/entrypoint.sh
|
||||
|
||||
COPY resources/core/start.sh /usr/local/bin/start.sh
|
||||
RUN chmod 755 /usr/local/bin/start.sh
|
||||
|
||||
USER frappe
|
||||
ENTRYPOINT ["/usr/local/bin/entrypoint.sh"]
|
||||
|
||||
CMD ["start.sh"]
|
||||
CMD [ \
|
||||
"/home/frappe/frappe-bench/env/bin/gunicorn", \
|
||||
"--chdir=/home/frappe/frappe-bench/sites", \
|
||||
"--bind=0.0.0.0:8000", \
|
||||
"--threads=4", \
|
||||
"--workers=2", \
|
||||
"--worker-class=gthread", \
|
||||
"--worker-tmp-dir=/dev/shm", \
|
||||
"--timeout=120", \
|
||||
"--preload", \
|
||||
"frappe.app:application" \
|
||||
]
|
||||
|
|
|
|||
|
|
@ -13,6 +13,7 @@ services:
|
|||
- --character-set-server=utf8mb4
|
||||
- --collation-server=utf8mb4_unicode_ci
|
||||
- --skip-character-set-client-handshake
|
||||
- --skip-innodb-read-only-compressed
|
||||
environment:
|
||||
MYSQL_ROOT_PASSWORD: ${DB_PASSWORD:-changeit}
|
||||
MARIADB_AUTO_UPGRADE: 1
|
||||
|
|
|
|||
|
|
@ -20,6 +20,7 @@ services:
|
|||
- --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: ${DB_PASSWORD:-123}
|
||||
MARIADB_AUTO_UPGRADE: 1
|
||||
|
|
|
|||
|
|
@ -1,44 +0,0 @@
|
|||
# Provides a service for automated migration of a given site.
|
||||
|
||||
# Compose extension fields of base compose.yaml. See https://github.com/frappe/frappe_docker/blob/main/compose.yaml
|
||||
# Needed for merging compose files.
|
||||
x-customizable-image: &customizable_image
|
||||
# By default the image used only contains the `frappe` and `erpnext` apps.
|
||||
# See https://github.com/frappe/frappe_docker/blob/main/docs/02-setup/02-build-setup.md#define-custom-apps
|
||||
# about using custom images.
|
||||
image: ${CUSTOM_IMAGE:-frappe/erpnext}:${CUSTOM_TAG:-$ERPNEXT_VERSION}
|
||||
pull_policy: ${PULL_POLICY:-always}
|
||||
restart: ${RESTART_POLICY:-unless-stopped}
|
||||
|
||||
x-depends-on-configurator: &depends_on_configurator
|
||||
depends_on:
|
||||
configurator:
|
||||
condition: service_completed_successfully
|
||||
|
||||
x-backend-defaults: &backend_defaults
|
||||
<<: [*depends_on_configurator, *customizable_image]
|
||||
volumes:
|
||||
- sites:/home/frappe/frappe-bench/sites
|
||||
|
||||
services:
|
||||
migrator:
|
||||
<<: *backend_defaults
|
||||
platform: linux/amd64
|
||||
entrypoint:
|
||||
- bash
|
||||
- -c
|
||||
command:
|
||||
- >
|
||||
if [ "$$MIGRATE_SITES" != "true" ]; then
|
||||
echo "[migrator] Migration disabled";
|
||||
exit 0;
|
||||
fi;
|
||||
if [ -z "$$(find sites -mindepth 2 -maxdepth 2 -name site_config.json 2>/dev/null)" ]; then
|
||||
echo "[migrator] No sites found, skipping migration";
|
||||
exit 0;
|
||||
fi;
|
||||
echo "[migrator] Migrating all sites";
|
||||
bench --site all migrate;
|
||||
environment:
|
||||
MIGRATE_SITES: ${MIGRATE_SITES:-true}
|
||||
restart: on-failure:5
|
||||
|
|
@ -37,10 +37,12 @@ services:
|
|||
redis-cache:
|
||||
networks:
|
||||
- bench-network
|
||||
- mariadb-network
|
||||
|
||||
redis-queue:
|
||||
networks:
|
||||
- bench-network
|
||||
- mariadb-network
|
||||
|
||||
networks:
|
||||
traefik-public:
|
||||
|
|
|
|||
|
|
@ -4,8 +4,6 @@ services:
|
|||
LETSENCRYPT_HOST: ${NGINX_PROXY_HOSTS:?No NGINX_PROXY_HOSTS set}
|
||||
|
||||
nginx-proxy:
|
||||
labels:
|
||||
com.github.nginx-proxy.nginx: "true"
|
||||
ports:
|
||||
- ${HTTP_PUBLISH_PORT:-80}:80
|
||||
- ${HTTPS_PUBLISH_PORT:-443}:443
|
||||
|
|
|
|||
|
|
@ -2,20 +2,15 @@ services:
|
|||
configurator:
|
||||
environment:
|
||||
DB_HOST: db
|
||||
DB_PORT: "5432"
|
||||
DB_PORT: 5432
|
||||
depends_on:
|
||||
db:
|
||||
condition: service_healthy
|
||||
- db
|
||||
|
||||
db:
|
||||
image: postgres:15.17
|
||||
image: postgres:13.5
|
||||
command: []
|
||||
healthcheck:
|
||||
test: ["CMD-SHELL", "pg_isready -U postgres"]
|
||||
interval: 5s
|
||||
retries: 5
|
||||
environment:
|
||||
POSTGRES_PASSWORD: ${DB_PASSWORD:-123}
|
||||
POSTGRES_PASSWORD: ${DB_PASSWORD:?No db password set}
|
||||
volumes:
|
||||
- db-data:/var/lib/postgresql/data
|
||||
|
||||
|
|
|
|||
|
|
@ -8,11 +8,11 @@ services:
|
|||
- redis-queue
|
||||
|
||||
redis-cache:
|
||||
image: redis:8.6-alpine
|
||||
image: redis:6.2-alpine
|
||||
restart: unless-stopped
|
||||
|
||||
redis-queue:
|
||||
image: redis:8.6-alpine
|
||||
image: redis:6.2-alpine
|
||||
restart: unless-stopped
|
||||
volumes:
|
||||
- redis-queue-data:/data
|
||||
|
|
|
|||
27
pwd.yml
27
pwd.yml
|
|
@ -1,6 +1,6 @@
|
|||
services:
|
||||
backend:
|
||||
image: frappe/erpnext:v16.23.0
|
||||
image: frappe/erpnext:v15.96.1
|
||||
networks:
|
||||
- frappe_network
|
||||
deploy:
|
||||
|
|
@ -16,7 +16,7 @@ services:
|
|||
MARIADB_ROOT_PASSWORD: admin
|
||||
|
||||
configurator:
|
||||
image: frappe/erpnext:v16.23.0
|
||||
image: frappe/erpnext:v15.96.1
|
||||
networks:
|
||||
- frappe_network
|
||||
deploy:
|
||||
|
|
@ -45,7 +45,7 @@ services:
|
|||
- logs:/home/frappe/frappe-bench/logs
|
||||
|
||||
create-site:
|
||||
image: frappe/erpnext:v16.23.0
|
||||
image: frappe/erpnext:v15.96.1
|
||||
networks:
|
||||
- frappe_network
|
||||
deploy:
|
||||
|
|
@ -78,15 +78,13 @@ services:
|
|||
bench new-site --mariadb-user-host-login-scope='%' --admin-password=admin --db-root-username=root --db-root-password=admin --install-app erpnext --set-default frontend;
|
||||
|
||||
db:
|
||||
image: mariadb:11.8
|
||||
image: mariadb:10.6
|
||||
networks:
|
||||
- frappe_network
|
||||
healthcheck:
|
||||
test: ["CMD", "healthcheck.sh", "--connect", "--innodb_initialized"]
|
||||
start_period: 5s
|
||||
interval: 5s
|
||||
timeout: 5s
|
||||
retries: 5
|
||||
test: mysqladmin ping -h localhost --password=admin
|
||||
interval: 1s
|
||||
retries: 20
|
||||
deploy:
|
||||
restart_policy:
|
||||
condition: on-failure
|
||||
|
|
@ -94,6 +92,7 @@ services:
|
|||
- --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
|
||||
MARIADB_ROOT_PASSWORD: admin
|
||||
|
|
@ -101,7 +100,7 @@ services:
|
|||
- db-data:/var/lib/mysql
|
||||
|
||||
frontend:
|
||||
image: frappe/erpnext:v16.23.0
|
||||
image: frappe/erpnext:v15.96.1
|
||||
networks:
|
||||
- frappe_network
|
||||
depends_on:
|
||||
|
|
@ -127,7 +126,7 @@ services:
|
|||
- "8080:8080"
|
||||
|
||||
queue-long:
|
||||
image: frappe/erpnext:v16.23.0
|
||||
image: frappe/erpnext:v15.96.1
|
||||
networks:
|
||||
- frappe_network
|
||||
deploy:
|
||||
|
|
@ -146,7 +145,7 @@ services:
|
|||
FRAPPE_REDIS_QUEUE: redis://redis-queue:6379
|
||||
|
||||
queue-short:
|
||||
image: frappe/erpnext:v16.23.0
|
||||
image: frappe/erpnext:v15.96.1
|
||||
networks:
|
||||
- frappe_network
|
||||
deploy:
|
||||
|
|
@ -183,7 +182,7 @@ services:
|
|||
condition: on-failure
|
||||
|
||||
scheduler:
|
||||
image: frappe/erpnext:v16.23.0
|
||||
image: frappe/erpnext:v15.96.1
|
||||
networks:
|
||||
- frappe_network
|
||||
deploy:
|
||||
|
|
@ -197,7 +196,7 @@ services:
|
|||
- logs:/home/frappe/frappe-bench/logs
|
||||
|
||||
websocket:
|
||||
image: frappe/erpnext:v16.23.0
|
||||
image: frappe/erpnext:v15.96.1
|
||||
networks:
|
||||
- frappe_network
|
||||
deploy:
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
pytest==9.1.0
|
||||
pytest==9.0.2
|
||||
|
|
|
|||
|
|
@ -1,12 +0,0 @@
|
|||
#!/bin/bash
|
||||
set -e
|
||||
|
||||
ASSETS_PATH="/home/frappe/frappe-bench/sites/assets"
|
||||
BAKED_PATH="/home/frappe/frappe-bench/assets"
|
||||
|
||||
echo "Linking fresh assets to volume..."
|
||||
rm -rf "$ASSETS_PATH"
|
||||
mkdir -p "$(dirname "$ASSETS_PATH")"
|
||||
ln -s "$BAKED_PATH" "$ASSETS_PATH"
|
||||
|
||||
exec "$@"
|
||||
|
|
@ -6,23 +6,20 @@ upstream socketio-server {
|
|||
server ${SOCKETIO} fail_timeout=0;
|
||||
}
|
||||
|
||||
# Parse the X-Forwarded-Proto header - if set - defaulting to $scheme.
|
||||
map $http_x_forwarded_proto $proxy_x_forwarded_proto {
|
||||
default $scheme;
|
||||
https https;
|
||||
}
|
||||
|
||||
server {
|
||||
listen 8080;
|
||||
server_name ${FRAPPE_SITE_NAME_HEADER};
|
||||
absolute_redirect off;
|
||||
root /home/frappe/frappe-bench/sites;
|
||||
|
||||
proxy_buffer_size 128k;
|
||||
proxy_buffers 4 256k;
|
||||
proxy_busy_buffers_size 256k;
|
||||
|
||||
include /etc/nginx/snippets/security_headers.conf;
|
||||
add_header X-Frame-Options "SAMEORIGIN";
|
||||
add_header Strict-Transport-Security "max-age=63072000; includeSubDomains; preload";
|
||||
add_header X-Content-Type-Options nosniff;
|
||||
add_header X-XSS-Protection "1; mode=block";
|
||||
add_header Referrer-Policy "same-origin, strict-origin-when-cross-origin";
|
||||
|
||||
set_real_ip_from ${UPSTREAM_REAL_IP_ADDRESS};
|
||||
real_ip_header ${UPSTREAM_REAL_IP_HEADER};
|
||||
|
|
@ -39,12 +36,10 @@ server {
|
|||
|
||||
location /socket.io {
|
||||
proxy_http_version 1.1;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto $proxy_x_forwarded_proto;
|
||||
proxy_set_header Upgrade $http_upgrade;
|
||||
proxy_set_header Connection "upgrade";
|
||||
proxy_set_header X-Frappe-Site-Name ${FRAPPE_SITE_NAME_HEADER};
|
||||
proxy_set_header Origin $proxy_x_forwarded_proto://${FRAPPE_SITE_NAME_HEADER};
|
||||
proxy_set_header Origin $scheme://$http_host;
|
||||
proxy_set_header Host $host;
|
||||
|
||||
proxy_pass http://socketio-server;
|
||||
|
|
@ -56,7 +51,6 @@ server {
|
|||
rewrite ^(.+)\.html$ $1 permanent;
|
||||
|
||||
location ~ ^/files/.*.(htm|html|svg|xml) {
|
||||
include /etc/nginx/snippets/security_headers.conf;
|
||||
add_header Content-disposition "attachment";
|
||||
try_files /${FRAPPE_SITE_NAME_HEADER}/public/$uri @webserver;
|
||||
}
|
||||
|
|
@ -67,7 +61,7 @@ server {
|
|||
location @webserver {
|
||||
proxy_http_version 1.1;
|
||||
proxy_set_header X-Forwarded-For $remote_addr;
|
||||
proxy_set_header X-Forwarded-Proto $proxy_x_forwarded_proto;
|
||||
proxy_set_header X-Forwarded-Proto $scheme;
|
||||
proxy_set_header X-Frappe-Site-Name ${FRAPPE_SITE_NAME_HEADER};
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Use-X-Accel-Redirect True;
|
||||
|
|
|
|||
|
|
@ -1,5 +0,0 @@
|
|||
add_header X-Frame-Options "SAMEORIGIN" always;
|
||||
add_header Strict-Transport-Security "max-age=63072000; includeSubDomains; preload" always;
|
||||
add_header X-Content-Type-Options nosniff always;
|
||||
add_header X-XSS-Protection "1; mode=block" always;
|
||||
add_header Referrer-Policy "same-origin, strict-origin-when-cross-origin" always;
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
#!/bin/bash
|
||||
set -e
|
||||
|
||||
#Gunicorn defaults
|
||||
GUNICORN_THREADS=${GUNICORN_THREADS:-4}
|
||||
GUNICORN_WORKERS=${GUNICORN_WORKERS:-2}
|
||||
GUNICORN_TIMEOUT=${GUNICORN_TIMEOUT:-120}
|
||||
|
||||
echo "Booting Gunicorn with $GUNICORN_WORKERS workers and $GUNICORN_THREADS threads..."
|
||||
|
||||
exec /home/frappe/frappe-bench/env/bin/gunicorn \
|
||||
--chdir=/home/frappe/frappe-bench/sites \
|
||||
--bind=0.0.0.0:8000 \
|
||||
--threads="$GUNICORN_THREADS" \
|
||||
--workers="$GUNICORN_WORKERS" \
|
||||
--worker-class=gthread \
|
||||
--worker-tmp-dir=/dev/shm \
|
||||
--timeout="$GUNICORN_TIMEOUT" \
|
||||
--preload \
|
||||
frappe.app:application
|
||||
|
|
@ -5,7 +5,7 @@ from typing import Any
|
|||
import pytest
|
||||
|
||||
from tests.conftest import S3ServiceResult
|
||||
from tests.utils import Compose, check_url_content, wait_for_url
|
||||
from tests.utils import Compose, check_url_content
|
||||
|
||||
BACKEND_SERVICES = (
|
||||
"backend",
|
||||
|
|
@ -81,30 +81,6 @@ def test_files_reachable(frappe_site: str, tmp_path: Path, compose: Compose):
|
|||
)
|
||||
|
||||
|
||||
def test_files_html_security_headers(
|
||||
frappe_site: str, tmp_path: Path, compose: Compose
|
||||
):
|
||||
file_path = tmp_path / "testfile.html"
|
||||
file_path.write_text(
|
||||
"<html><body>This is a Frappe Docker test html file</body></html>"
|
||||
)
|
||||
|
||||
compose(
|
||||
"cp",
|
||||
str(file_path),
|
||||
f"backend:/home/frappe/frappe-bench/sites/{frappe_site}/public/files/",
|
||||
)
|
||||
|
||||
response = wait_for_url(
|
||||
url=f"http://127.0.0.1/files/{file_path.name}",
|
||||
site_name=frappe_site,
|
||||
)
|
||||
|
||||
assert response.headers["Content-Disposition"] == "attachment"
|
||||
assert response.headers["X-Frame-Options"] == "SAMEORIGIN"
|
||||
assert response.headers["X-Content-Type-Options"] == "nosniff"
|
||||
|
||||
|
||||
@pytest.mark.parametrize("service", BACKEND_SERVICES)
|
||||
@pytest.mark.usefixtures("frappe_site")
|
||||
def test_frappe_connections_in_backends(
|
||||
|
|
|
|||
|
|
@ -4,7 +4,6 @@ import subprocess
|
|||
import sys
|
||||
import time
|
||||
from contextlib import suppress
|
||||
from http.client import HTTPResponse
|
||||
from typing import Callable, Optional
|
||||
from urllib.error import HTTPError, URLError
|
||||
from urllib.request import Request, urlopen
|
||||
|
|
@ -60,11 +59,24 @@ class Compose:
|
|||
def check_url_content(
|
||||
url: str, callback: Callable[[str], Optional[str]], site_name: str
|
||||
):
|
||||
request = Request(url, headers={"Host": site_name})
|
||||
|
||||
# This is needed to check https override
|
||||
ctx = ssl.create_default_context()
|
||||
ctx.check_hostname = False
|
||||
ctx.verify_mode = ssl.CERT_NONE
|
||||
|
||||
for _ in range(100):
|
||||
try:
|
||||
response = wait_for_url(url=url, site_name=site_name, attempts=1)
|
||||
except RuntimeError:
|
||||
response = urlopen(request, context=ctx)
|
||||
|
||||
except HTTPError as exc:
|
||||
if exc.code not in (404, 502):
|
||||
raise
|
||||
|
||||
except URLError:
|
||||
pass
|
||||
|
||||
else:
|
||||
text: str = response.read().decode()
|
||||
ret = callback(text)
|
||||
|
|
@ -74,26 +86,4 @@ def check_url_content(
|
|||
|
||||
time.sleep(0.1)
|
||||
|
||||
raise RuntimeError(f"Couldn't verify expected content from {url}")
|
||||
|
||||
|
||||
def wait_for_url(url: str, site_name: str, attempts: int = 100) -> HTTPResponse:
|
||||
request = Request(url, headers={"Host": site_name})
|
||||
|
||||
# This is needed to check https override
|
||||
ctx = ssl.create_default_context()
|
||||
ctx.check_hostname = False
|
||||
ctx.verify_mode = ssl.CERT_NONE
|
||||
|
||||
for _ in range(attempts):
|
||||
try:
|
||||
return urlopen(request, context=ctx)
|
||||
except HTTPError as exc:
|
||||
if exc.code not in (404, 502):
|
||||
raise
|
||||
except URLError:
|
||||
pass
|
||||
|
||||
time.sleep(0.1)
|
||||
|
||||
raise RuntimeError(f"Couldn't ping {url}")
|
||||
|
|
|
|||
Loading…
Reference in a new issue