Frappe Deployer
A powerful CLI tool for managing and deploying Frappe applications with support for both host and Frappe Manager (FM) modes. Create timestamped releases, manage backups, and deploy with confidence.
- Author: rtCamp
- Repository: https://github.com/rtCamp/frappe-deployer
- GitHub stars: 8
- Forks: 8
- License: MIT
- Category: Manufacturing
- Maintenance: Actively Maintained
Install Frappe Deployer
bench get-app https://github.com/rtCamp/frappe-deployer
Tags
- production
- tier-2
Add the Frappe Gems badge to your README
Maintain Frappe Deployer? Paste this into your README:
[](https://frappegems.com/gems/apps/rtCamp/frappe-deployer)
About Frappe Deployer
Frappe Deployer
A powerful CLI tool for managing and deploying Frappe applications with support for both host and Frappe Manager (FM) modes. Create timestamped releases, manage backups, and deploy with confidence.
Key Features
- Dual Deployment Modes: Host and Frappe Manager (FM) support
- Release Management: Timestamped releases with rollback capability
- Backup & Restore: Automated backups with compression and retention policies
- Database Operations: Cross-site migration, restore, and search/replace functionality
- Symlink & Subdirectory App Support: Symlink apps (including subdirectory apps) for efficient workspace management; configurable globally or per-app
- Custom Scripts: Pre/post deployment hooks and per-app build commands (
fm_pre_build,fm_post_build) - Remote Workers: Distributed deployment across multiple servers
- Maintenance Mode: Built-in maintenance pages with developer bypass tokens
- Configuration Management: TOML-based configuration with CLI overrides
- Frappe Cloud Integration: Import backups and config directly from Frappe Cloud
- Python Version Management: Specify Python versions; UV support for fast Python environments
Quick Start
# Install frappe-deployer
pip install frappe-deployer
# Configure a new site (FM mode)
frappe-deployer configure my-site-name --mode fm
# Deploy Frappe and ERPNext
frappe-deployer pull my-site-name \
-a frappe/frappe:version-14 \
-a frappe/erpnext:version-14 \
--maintenance-mode \
--verbose
# Check deployment status
frappe-deployer --version
Installation
# Install from PyPI (when available)
pip install frappe-deployer
# Install from source
git clone
cd frappe-deployer
pip install -e .
CLI Command Reference
```bash
Configure a new site
frappe-deployer configure --mode [--backups] [--config-path
Related Manufacturing apps for Frappe & ERPNext
- Frappe Manager — The production platform for Frappe/ERPNext. Automatic TLS, versioned migrations, worker orchestration, isolated benches. Everything from a single CLI.
- Process Manufacturing — PROCESS MANUFACTURING
- Textile — Textile App for ERPNext
- Aumms — AuMMS ( Aurum Manufacturing Management System ) is a Frappe App to facilitate the Operations in Gold Manufacturing
- Next Pms —
- Frappe Gmail Thread — Gmail thread tracking app
- Frappe Search — Frappe Search enables powerful, global search functionality across your custom Frappe apps.
- Erpnext Mrp — MRP Tools for ERPNext