DDEV Kanopi WordPress Add-on
A comprehensive DDEV add-on that provides Kanopi’s battle-tested workflow for WordPress development with multi-provider hosting support.
🚀 Quick Start
# Intialize a project (adjust docroot/database if needed)
ddev config --project-type=wordpress --docroot=web --database=mariadb:10.6
# Install the add-on
ddev add-on get kanopi/ddev-kanopi-wp
# Configure your hosting provider
ddev project-configure
# Initialize your development environment
ddev project-init
✨ Features
- 26+ Custom Commands - Complete WordPress development workflow
- Multi-Provider Hosting - Pantheon, WPEngine, and Kinsta support
- Smart Database Refresh - 12-hour backup age detection
- Modern Asset Pipeline - Webpack with
@wordpress/scripts - Block Development - WordPress block scaffolding and tooling
- E2E Testing - Cypress integration with user management
- Performance Tools - Critical CSS generation and optimization
- Service Integration - Redis support for Pantheon object caching
📚 Documentation
Quick Links
| Topic | Description |
|---|---|
| 🏁 Getting Started | Installation and setup guide |
| ⚙️ Configuration | Hosting provider setup |
| 🛠 Commands | Complete command reference |
| 🎨 Theme Development | Asset compilation and blocks |
| 🗄 Database Operations | Smart refresh and migrations |
| 🧪 Testing | Cypress E2E and automated testing |
| ☁️ Hosting Providers | Platform-specific guides |
| 🔧 Troubleshooting | Common issues and solutions |
🏗 Key Commands
| Command | Description |
|---|---|
ddev project-init |
Complete development environment setup |
ddev project-configure |
Interactive configuration wizard |
ddev db-refresh [env] |
Smart database refresh with backup detection |
ddev theme-watch |
Start theme development with file watching |
ddev theme-create-block <name> |
Create new WordPress blocks |
ddev wp-open [admin] |
Open site or admin in browser |
🌐 Hosting Provider Support
| Provider | Authentication | Features | Docroot |
|---|---|---|---|
| Pantheon | Machine Token | Terminus integration, multidev support | web (recommended) or root (legacy) |
| WPEngine | SSH Key (local config) | Nightly backup utilization | Configurable |
| Kinsta | SSH Key | Direct server access | public |
📋 Installation Options
Existing DDEV Projects
ddev add-on get kanopi/ddev-kanopi-wp
ddev project-configure
ddev restart
New Projects
# Initialize DDEV (Adjust webroot/database as needed)
ddev config --project-type=wordpress --docroot=web --database=mariadb:10.6
# Install add-on
ddev add-on get kanopi/ddev-kanopi-wp
ddev project-configure
ddev project-init
🔧 Management
# Update to latest version
ddev add-on get kanopi/ddev-kanopi-wp
ddev restart
# View installed add-ons
ddev add-on list
# Remove add-on
ddev add-on remove kanopi-wp
📖 Project Integration
For Project Maintainers
- README Updates - Template for updating project documentation
- Pull Request Guide - Comprehensive PR template and validation
For Developers
- wp-config.php Setup - Integration with existing WordPress configurations
- Environment Variables - Complete configuration reference
- Contributing Guide - How to contribute to the add-on
🤝 Support
- 📚 Documentation - Comprehensive guides and references
- 🐛 Issues - Bug reports and feature requests
- 💬 Discussions - Community support and questions
📄 License
This project is licensed under the GNU General Public License v2 - see the LICENSE file for details.
Originally Contributed by Kanopi Studios