-
-
+## ๐ Quick Start
-### Try on your Dev environment
+For detailed deployment instructions, see [DEPLOYMENT.md](DEPLOYMENT.md).
-First clone the repo:
+### Prerequisites
-```sh
-git clone https://github.com/frappe/frappe_docker
-cd frappe_docker
+- GitHub account with access to all repositories
+- Hetzner server (Ubuntu 20.04+ recommended)
+- GitHub Personal Access Token
+- OpenAI API key (for AI features)
+
+### Basic Setup
+
+1. Fork this repository
+2. Configure GitHub secrets:
+ - `HETZNER_SSH_KEY`
+ - `ACADEMY_DOCKER_PAT`
+3. Add webhook workflows to watched repositories
+4. Run setup script on Hetzner server
+5. Configure environment variables
+6. Trigger initial deployment
+
+## ๐ Automated Workflow
+
+```mermaid
+graph LR
+ A[Code Push] --> B[Webhook Trigger]
+ B --> C[Build Docker Image]
+ C --> D[Push to GHCR]
+ D --> E[Deploy to Hetzner]
+ E --> F[Run Migrations]
+ F --> G[Health Check]
```
-Then run: `docker compose -f pwd.yml up -d`
+## ๐ Repository Structure
-### To run on ARM64 architecture follow this instructions
+```
+academy_docker/
+โโโ .github/workflows/ # CI/CD workflows
+โ โโโ deploy.yml # Main deployment workflow
+โ โโโ webhook-*.yml # Webhook templates for watched repos
+โโโ images/ # Docker image definitions
+โ โโโ custom/ # Custom Frappe image with apps
+โโโ nginx/ # Nginx configuration
+โโโ scripts/ # Utility scripts
+โ โโโ migrate-all-sites.sh
+โ โโโ setup-hetzner.sh
+โโโ compose.yaml # Docker Compose configuration
+โโโ .env.example # Environment variables template
+โโโ DEPLOYMENT.md # Detailed deployment guide
+```
-After cloning the repo run this command to build multi-architecture images specifically for ARM64.
+## ๐ง Configuration
-`docker buildx bake --no-cache --set "*.platform=linux/arm64"`
+Key environment variables:
-and then
+- `MARIADB_ROOT_PASSWORD` - Database root password
+- `ADMIN_PASSWORD` - Frappe admin password
+- `OPENAI_API_KEY` - OpenAI API key for AI features
+- `FRAPPE_SITE_NAME_HEADER` - Your domain name
+- `LANGCHAIN_API_URL` - LangChain service URL
-- add `platform: linux/arm64` to all services in the `pwd.yml`
-- replace the current specified versions of erpnext image on `pwd.yml` with `:latest`
+## ๐ก๏ธ Security
-Then run: `docker compose -f pwd.yml up -d`
+- All secrets stored in GitHub Secrets
+- Firewall rules configured automatically
+- SSL/TLS support for production
+- Regular automated backups
-## Final steps
+## ๐ Monitoring
-Wait for 5 minutes for ERPNext site to be created or check `create-site` container logs before opening browser on port 8080. (username: `Administrator`, password: `admin`)
+- Check service status: `docker compose ps`
+- View logs: `docker compose logs -f`
+- System health: `docker compose exec backend bench doctor`
-If you ran in a Dev Docker environment, to view container logs: `docker compose -f pwd.yml logs -f create-site`. Don't worry about some of the initial error messages, some services take a while to become ready, and then they go away.
+## ๐ค Contributing
-# Documentation
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Submit a pull request
-### [Frequently Asked Questions](https://github.com/frappe/frappe_docker/wiki/Frequently-Asked-Questions)
+## ๐ License
-### [Production](#production)
+This project inherits the license from the original [frappe_docker](https://github.com/frappe/frappe_docker) repository.
-- [List of containers](docs/list-of-containers.md)
-- [Single Compose Setup](docs/single-compose-setup.md)
-- [Environment Variables](docs/environment-variables.md)
-- [Single Server Example](docs/single-server-example.md)
-- [Setup Options](docs/setup-options.md)
-- [Site Operations](docs/site-operations.md)
-- [Backup and Push Cron Job](docs/backup-and-push-cronjob.md)
-- [Port Based Multi Tenancy](docs/port-based-multi-tenancy.md)
-- [Migrate from multi-image setup](docs/migrate-from-multi-image-setup.md)
-- [running on linux/mac](docs/setup_for_linux_mac.md)
-- [TLS for local deployment](docs/tls-for-local-deployment.md)
+## ๐ Support
-### [Custom Images](#custom-images)
+- Check [DEPLOYMENT.md](DEPLOYMENT.md) for detailed instructions
+- Review GitHub Actions logs for deployment issues
+- Open an issue for bugs or feature requests
-- [Custom Apps](docs/custom-apps.md)
-- [Custom Apps with podman](docs/custom-apps-podman.md)
-- [Build Version 10 Images](docs/build-version-10-images.md)
+---
-### [Development](#development)
-
-- [Development using containers](docs/development.md)
-- [Bench Console and VSCode Debugger](docs/bench-console-and-vscode-debugger.md)
-- [Connect to localhost services](docs/connect-to-localhost-services-from-containers-for-local-app-development.md)
-
-### [Troubleshoot](docs/troubleshoot.md)
-
-# Contributing
-
-If you want to contribute to this repo refer to [CONTRIBUTING.md](CONTRIBUTING.md)
-
-This repository is only for container related stuff. You also might want to contribute to:
-
-- [Frappe framework](https://github.com/frappe/frappe#contributing),
-- [ERPNext](https://github.com/frappe/erpnext#contributing),
-- [Frappe Bench](https://github.com/frappe/bench).
+Built with โค๏ธ for automated Academy LMS deployment
diff --git a/compose.yaml b/compose.yaml
index 7c8e64f2..43ef41f7 100644
--- a/compose.yaml
+++ b/compose.yaml
@@ -1,8 +1,7 @@
-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/custom-apps.md
- # about using custom images.
- image: ${CUSTOM_IMAGE:-frappe/erpnext}:${CUSTOM_TAG:-$ERPNEXT_VERSION}
+x-customizable-image:
+ # Custom Academy LMS image with all required apps
+ &customizable_image
+ image: ${CUSTOM_IMAGE:-ghcr.io/exarlabs/academy-frappe}:${CUSTOM_TAG:-latest}
pull_policy: ${PULL_POLICY:-always}
restart: ${RESTART_POLICY:-unless-stopped}
@@ -12,39 +11,120 @@ x-depends-on-configurator: &depends_on_configurator
condition: service_completed_successfully
x-backend-defaults: &backend_defaults
- <<: [*depends_on_configurator, *customizable_image]
+ <<: [ *depends_on_configurator, *customizable_image ]
volumes:
- sites:/home/frappe/frappe-bench/sites
+ networks:
+ - frappe-network
+ - langchain-network
services:
+ # Nginx reverse proxy for multi-site support
+ nginx-proxy:
+ image: nginx:alpine
+ ports:
+ - "80:80"
+ - "443:443"
+ volumes:
+ - ./nginx/conf.d:/etc/nginx/conf.d:ro
+ - ./nginx/nginx.conf:/etc/nginx/nginx.conf:ro
+ - sites:/var/www/html/sites:ro
+ - ./ssl:/etc/nginx/ssl:ro
+ depends_on:
+ - frontend
+ networks:
+ - frappe-network
+ restart: unless-stopped
+
+ # MariaDB database (from academy-lms)
+ mariadb:
+ image: mariadb:10.8
+ command:
+ - --character-set-server=utf8mb4
+ - --collation-server=utf8mb4_unicode_ci
+ - --skip-character-set-client-handshake
+ - --skip-innodb-read-only-compressed
+ environment:
+ MARIADB_ROOT_PASSWORD: ${MARIADB_ROOT_PASSWORD}
+ volumes:
+ - mariadb-data:/var/lib/mysql
+ - ./backups:/backups
+ networks:
+ - frappe-network
+ restart: unless-stopped
+
+ # Redis (shared between frappe and langchain)
+ redis:
+ image: redis:alpine
+ networks:
+ - frappe-network
+ - langchain-network
+ restart: unless-stopped
+
+ # PostgreSQL for LangChain service
+ postgres:
+ image: postgres:15
+ environment:
+ POSTGRES_DB: ${LANGCHAIN_DB_NAME:-langchain_db}
+ POSTGRES_USER: ${LANGCHAIN_DB_USER:-langchain_user}
+ POSTGRES_PASSWORD: ${LANGCHAIN_DB_PASSWORD:-langchain_pass}
+ volumes:
+ - postgres-data:/var/lib/postgresql/data
+ networks:
+ - langchain-network
+ restart: unless-stopped
+
+ # LangChain service for AI functionality
+ langchain-service:
+ image: ${LANGCHAIN_IMAGE:-ghcr.io/exarlabs/academy-langchain}:${LANGCHAIN_TAG:-latest}
+ environment:
+ - OPENAI_API_KEY=${OPENAI_API_KEY}
+ - ANTHROPIC_API_KEY=${ANTHROPIC_API_KEY}
+
+ - DATABASE_URL=postgresql://${LANGCHAIN_DB_USER:-langchain_user}:${LANGCHAIN_DB_PASSWORD:-langchain_pass}@postgres:5432/${LANGCHAIN_DB_NAME:-langchain_db}
+ - REDIS_URL=redis://redis:6379
+ - ENV=${LANGCHAIN_ENV:-development}
+ - DEBUG=${LANGCHAIN_DEBUG:-true}
+ networks:
+ - langchain-network
+ depends_on:
+ - postgres
+ - redis
+ restart: unless-stopped
+ ports:
+ - "8001:8000" # Expose on different port to avoid conflict
+
configurator:
<<: *backend_defaults
platform: linux/amd64
entrypoint:
- bash
- -c
- # add redis_socketio for backward compatibility
command:
- >
- ls -1 apps > sites/apps.txt;
- bench set-config -g db_host $$DB_HOST;
- bench set-config -gp db_port $$DB_PORT;
- bench set-config -g redis_cache "redis://$$REDIS_CACHE";
- bench set-config -g redis_queue "redis://$$REDIS_QUEUE";
- bench set-config -g redis_socketio "redis://$$REDIS_QUEUE";
- bench set-config -gp socketio_port $$SOCKETIO_PORT;
+ ls -1 apps > sites/apps.txt; bench set-config -g db_host mariadb; bench set-config -gp db_port 3306; bench set-config -g redis_cache "redis://redis:6379"; bench set-config -g redis_queue "redis://redis:6379"; bench set-config -g redis_socketio "redis://redis:6379"; bench set-config -gp socketio_port 9000; bench set-config -g ai_tutor_api_url "${AI_TUTOR_API_URL}";
environment:
- DB_HOST: ${DB_HOST:-}
- DB_PORT: ${DB_PORT:-}
- REDIS_CACHE: ${REDIS_CACHE:-}
- REDIS_QUEUE: ${REDIS_QUEUE:-}
+ DB_HOST: mariadb
+ DB_PORT: 3306
+ REDIS_CACHE: redis:6379
+ REDIS_QUEUE: redis:6379
SOCKETIO_PORT: 9000
- depends_on: {}
+ AI_TUTOR_API_URL: ${AI_TUTOR_API_URL:-http://langchain-service:8000}
+ depends_on:
+ - mariadb
+ - redis
restart: on-failure
backend:
<<: *backend_defaults
platform: linux/amd64
+ environment:
+ - LANGCHAIN_SERVICE_URL=http://langchain-service:8000
+ - AI_TUTOR_API_URL=${AI_TUTOR_API_URL:-http://langchain-service:8000}
+ depends_on:
+ - mariadb
+ - redis
+ - langchain-service
frontend:
<<: *customizable_image
@@ -62,18 +142,23 @@ services:
CLIENT_MAX_BODY_SIZE: ${CLIENT_MAX_BODY_SIZE:-50m}
volumes:
- sites:/home/frappe/frappe-bench/sites
+ networks:
+ - frappe-network
depends_on:
- backend
- websocket
+ restart: unless-stopped
websocket:
- <<: [*depends_on_configurator, *customizable_image]
+ <<: [ *depends_on_configurator, *customizable_image ]
platform: linux/amd64
command:
- node
- /home/frappe/frappe-bench/apps/frappe/socketio.js
volumes:
- sites:/home/frappe/frappe-bench/sites
+ networks:
+ - frappe-network
queue-short:
<<: *backend_defaults
@@ -90,6 +175,15 @@ services:
platform: linux/amd64
command: bench schedule
-# ERPNext requires local assets access (Frappe does not)
+# Volumes for persistent data
volumes:
sites:
+ mariadb-data:
+ postgres-data:
+
+ # Networks for service communication
+networks:
+ frappe-network:
+ driver: bridge
+ langchain-network:
+ driver: bridge
diff --git a/images/custom/Containerfile b/images/custom/Containerfile
index 208f13e3..d90f1ae2 100644
--- a/images/custom/Containerfile
+++ b/images/custom/Containerfile
@@ -12,123 +12,132 @@ ENV NVM_DIR=/home/frappe/.nvm
ENV PATH=${NVM_DIR}/versions/node/v${NODE_VERSION}/bin/:${PATH}
RUN useradd -ms /bin/bash frappe \
- && apt-get update \
- && apt-get install --no-install-recommends -y \
- curl \
- git \
- vim \
- nginx \
- gettext-base \
- file \
- # weasyprint dependencies
- libpango-1.0-0 \
- libharfbuzz0b \
- libpangoft2-1.0-0 \
- libpangocairo-1.0-0 \
- # For backups
- restic \
- gpg \
- # MariaDB
- mariadb-client \
- less \
- # Postgres
- libpq-dev \
- postgresql-client \
- # For healthcheck
- wait-for-it \
- jq \
- # NodeJS
- && mkdir -p ${NVM_DIR} \
- && curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.5/install.sh | bash \
- && . ${NVM_DIR}/nvm.sh \
- && nvm install ${NODE_VERSION} \
- && nvm use v${NODE_VERSION} \
- && npm install -g yarn \
- && nvm alias default v${NODE_VERSION} \
- && rm -rf ${NVM_DIR}/.cache \
- && echo 'export NVM_DIR="/home/frappe/.nvm"' >>/home/frappe/.bashrc \
- && echo '[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm' >>/home/frappe/.bashrc \
- && echo '[ -s "$NVM_DIR/bash_completion" ] && \. "$NVM_DIR/bash_completion" # This loads nvm bash_completion' >>/home/frappe/.bashrc \
- # Install wkhtmltopdf with patched qt
- && if [ "$(uname -m)" = "aarch64" ]; then export ARCH=arm64; fi \
- && if [ "$(uname -m)" = "x86_64" ]; then export ARCH=amd64; fi \
- && downloaded_file=wkhtmltox_${WKHTMLTOPDF_VERSION}.${WKHTMLTOPDF_DISTRO}_${ARCH}.deb \
- && curl -sLO https://github.com/wkhtmltopdf/packaging/releases/download/$WKHTMLTOPDF_VERSION/$downloaded_file \
- && apt-get install -y ./$downloaded_file \
- && rm $downloaded_file \
- # Clean up
- && rm -rf /var/lib/apt/lists/* \
- && rm -fr /etc/nginx/sites-enabled/default \
- && pip3 install frappe-bench \
- # Fixes for non-root nginx and logs to stdout
- && sed -i '/user www-data/d' /etc/nginx/nginx.conf \
- && ln -sf /dev/stdout /var/log/nginx/access.log && ln -sf /dev/stderr /var/log/nginx/error.log \
- && touch /run/nginx.pid \
- && chown -R frappe:frappe /etc/nginx/conf.d \
- && chown -R frappe:frappe /etc/nginx/nginx.conf \
- && 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
+ && apt-get update \
+ && apt-get install --no-install-recommends -y \
+ curl \
+ git \
+ vim \
+ nginx \
+ gettext-base \
+ file \
+ # weasyprint dependencies
+ libpango-1.0-0 \
+ libharfbuzz0b \
+ libpangoft2-1.0-0 \
+ libpangocairo-1.0-0 \
+ # For backups
+ restic \
+ gpg \
+ # MariaDB
+ mariadb-client \
+ less \
+ # Postgres
+ libpq-dev \
+ postgresql-client \
+ # For healthcheck
+ wait-for-it \
+ jq \
+ # NodeJS
+ && mkdir -p ${NVM_DIR} \
+ && curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.5/install.sh | bash \
+ && . ${NVM_DIR}/nvm.sh \
+ && nvm install ${NODE_VERSION} \
+ && nvm use v${NODE_VERSION} \
+ && npm install -g yarn \
+ && nvm alias default v${NODE_VERSION} \
+ && rm -rf ${NVM_DIR}/.cache \
+ && echo 'export NVM_DIR="/home/frappe/.nvm"' >>/home/frappe/.bashrc \
+ && echo '[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm' >>/home/frappe/.bashrc \
+ && echo '[ -s "$NVM_DIR/bash_completion" ] && \. "$NVM_DIR/bash_completion" # This loads nvm bash_completion' >>/home/frappe/.bashrc \
+ # Install wkhtmltopdf with patched qt
+ && if [ "$(uname -m)" = "aarch64" ]; then export ARCH=arm64; fi \
+ && if [ "$(uname -m)" = "x86_64" ]; then export ARCH=amd64; fi \
+ && downloaded_file=wkhtmltox_${WKHTMLTOPDF_VERSION}.${WKHTMLTOPDF_DISTRO}_${ARCH}.deb \
+ && curl -sLO https://github.com/wkhtmltopdf/packaging/releases/download/$WKHTMLTOPDF_VERSION/$downloaded_file \
+ && apt-get install -y ./$downloaded_file \
+ && rm $downloaded_file \
+ # Clean up
+ && rm -rf /var/lib/apt/lists/* \
+ && rm -fr /etc/nginx/sites-enabled/default \
+ && pip3 install frappe-bench \
+ # Fixes for non-root nginx and logs to stdout
+ && sed -i '/user www-data/d' /etc/nginx/nginx.conf \
+ && ln -sf /dev/stdout /var/log/nginx/access.log && ln -sf /dev/stderr /var/log/nginx/error.log \
+ && touch /run/nginx.pid \
+ && chown -R frappe:frappe /etc/nginx/conf.d \
+ && chown -R frappe:frappe /etc/nginx/nginx.conf \
+ && 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 \
- && DEBIAN_FRONTEND=noninteractive apt-get install --no-install-recommends -y \
- # For frappe framework
- wget \
- #for building arm64 binaries
- libcairo2-dev \
- libpango1.0-dev \
- libjpeg-dev \
- libgif-dev \
- librsvg2-dev \
- # For psycopg2
- libpq-dev \
- # Other
- libffi-dev \
- liblcms2-dev \
- libldap2-dev \
- libmariadb-dev \
- libsasl2-dev \
- libtiff5-dev \
- libwebp-dev \
- pkg-config \
- redis-tools \
- rlwrap \
- tk8.6-dev \
- cron \
- # For pandas
- gcc \
- build-essential \
- libbz2-dev \
- && rm -rf /var/lib/apt/lists/*
+ && DEBIAN_FRONTEND=noninteractive apt-get install --no-install-recommends -y \
+ # For frappe framework
+ wget \
+ #for building arm64 binaries
+ libcairo2-dev \
+ libpango1.0-dev \
+ libjpeg-dev \
+ libgif-dev \
+ librsvg2-dev \
+ # For psycopg2
+ libpq-dev \
+ # Other
+ libffi-dev \
+ liblcms2-dev \
+ libldap2-dev \
+ libmariadb-dev \
+ libsasl2-dev \
+ libtiff5-dev \
+ libwebp-dev \
+ pkg-config \
+ redis-tools \
+ rlwrap \
+ tk8.6-dev \
+ cron \
+ # For pandas
+ gcc \
+ build-essential \
+ 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; \
+ mkdir /opt/frappe && echo "${APPS_JSON_BASE64}" | base64 -d > /opt/frappe/apps.json; \
fi
USER frappe
ARG FRAPPE_BRANCH=version-15
ARG FRAPPE_PATH=https://github.com/frappe/frappe
-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}\
- --frappe-branch=${FRAPPE_BRANCH} \
- --frappe-path=${FRAPPE_PATH} \
- --no-procfile \
- --no-backups \
- --skip-redis-config-generation \
- --verbose \
- /home/frappe/frappe-bench && \
- cd /home/frappe/frappe-bench && \
- echo "{}" > sites/common_site_config.json && \
+ARG LMS_REPO_URL=https://github.com/ExarLabs/academy-lms
+ARG AI_TUTOR_REPO_URL=https://github.com/ExarLabs/academy-ai-tutor-chat
+
+# Initialize Frappe bench
+RUN bench init \
+ --frappe-branch=${FRAPPE_BRANCH} \
+ --frappe-path=${FRAPPE_PATH} \
+ --no-procfile \
+ --no-backups \
+ --skip-redis-config-generation \
+ --verbose \
+ /home/frappe/frappe-bench
+
+WORKDIR /home/frappe/frappe-bench
+
+# Install Academy LMS app
+RUN bench get-app lms ${LMS_REPO_URL}
+
+# Install AI Tutor Chat app
+RUN bench get-app ai_tutor_chat ${AI_TUTOR_REPO_URL}
+
+# Setup common site config
+RUN echo "{}" > sites/common_site_config.json && \
find apps -mindepth 1 -path "*/.git" | xargs rm -fr
FROM base AS backend
@@ -143,7 +152,7 @@ VOLUME [ \
"/home/frappe/frappe-bench/sites", \
"/home/frappe/frappe-bench/sites/assets", \
"/home/frappe/frappe-bench/logs" \
-]
+ ]
CMD [ \
"/home/frappe/frappe-bench/env/bin/gunicorn", \
@@ -156,4 +165,4 @@ CMD [ \
"--timeout=120", \
"--preload", \
"frappe.app:application" \
-]
+ ]
diff --git a/nginx/502.html b/nginx/502.html
new file mode 100644
index 00000000..3326012a
--- /dev/null
+++ b/nginx/502.html
@@ -0,0 +1,59 @@
+
+
+
+
+
+
+ The server is temporarily unable to service your request. This may be due to maintenance or capacity problems. +
+Please try again in a few moments.
+