Skip to content

rtCamp/Frappe-Manager

Repository files navigation

🚀 Frappe Manager

Python 3.11+ GHCR License: MIT PyPI version

Simplify Your Frappe Development & Deployment Workflow

A powerful CLI tool that streamlines the entire lifecycle of Frappe applications using Docker - from development to deployment.

Quick StartDocumentationExamplesSupport

Frappe-Manager-Create-Site.svg

✨ Features

🔥 Easy Setup

• Get a new Frappe environment running in minutes
• Zero configuration needed

🐳 Docker-Based

• Consistent environments across all platforms
• Isolated development environments

🌐 Multi-Bench Support

• Manage multiple Frappe benches from one server

👨‍💻 Development Tools

• VSCode integration with debugger support
• Automatic environment switching between dev/prod

🔒 SSL Management

• Built-in Let's Encrypt integration
• Automatic certificate renewal

🛠️ Admin Tools

• Mailpit for email testing
• Redis Queue Dashboard
• Adminer for db management

🛠️ Requirements

  • Python 3.11 or higher
  • Docker
  • VSCode (optional, for development features)

🚀 Quick Start

# Install Frappe Manager (stable)
pipx install frappe-manager 

# Install Frappe Manager (latest develop)
pipx install git+https://github.com/rtcamp/frappe-manager@develop 

# Setup shell completion
fm --install-completion

# Create your first site
fm create mysite

📚 Examples

Development Setup

# Create a dev environment with ERPNext
fm create devsite --apps erpnext:version-15 --environment dev

# Start coding (in VSCode)
fm code devsite --debugger

Production Setup

# Create Production Site
fm create example.com --environment prod

# Create production site with SSL using HTTP01 challenge
fm create example.com --environment prod \
  --ssl letsencrypt --letsencrypt-preferred-challenge http01 \
  --letsencrypt-email [email protected]

# Create production site with SSL using DNS01 challenge 
fm create example.com --environment prod \
  --ssl letsencrypt --letsencrypt-preferred-challenge dns01 \
  --letsencrypt-email [email protected]

Daily Operations

# Common commands
fm start mysite      # Start site
fm stop mysite       # Stop site
fm info mysite       # View site info
fm logs mysite -f    # View logs
fm shell mysite      # Access shell

📖 Documentation

Visit our Wiki for:

  • 📋 Detailed guides
  • ⚙️ Configuration options
  • 💡 Best practices
  • ❓ Troubleshooting

🤝 Support

👏 Credits

Based on official Frappe Docker images.

📄 License

MIT License - see LICENSE file for details

About

A CLI tool based on Docker Compose to easily manage Frappe based projects.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors 6