Welcome to the Deploy Center user guides. These guides are designed to help you get the most out of Deploy Center, whether you're setting up your first project or configuring advanced deployment pipelines.
Current version: v3.0.0 — released 2026-05-24. v3.0 added a persistent BullMQ queue, encrypted environment variables, multi-channel notifications (Discord + Slack + Email), manual rollback UI, project templates, workspaces, log download, and a CI pipeline. The guides below reflect v3.0 behavior; see CHANGELOG.md for the full release history and migration-v2-to-v3.md for the upgrade path.
Creating Projects ⭐ Start Here
A comprehensive guide to creating and configuring your first project in Deploy Center. This guide covers:
- Project basic information (name, repository, branch)
- Configuration settings (environment, auto-deploy, variables)
- Pre-deployment pipeline (build steps, tests)
- Post-deployment pipeline (service restarts, migrations)
- Notifications setup
- Webhook configuration
- Real-world examples for different project types
Who should read this: Everyone new to Deploy Center
Time to complete: 15-20 minutes
Learn how deployments work in Deploy Center:
- Deployment lifecycle and phases
- Manual vs automatic deployments
- Deployment queue and concurrency
- Viewing deployment logs
- Troubleshooting failed deployments
Who should read this: Users who want to understand the deployment process
Time to complete: 10 minutes
Master the art of creating powerful deployment pipelines:
- Pre-deployment vs post-deployment pipelines
- Conditional step execution
- Using environment variables in commands
- Error handling and rollback strategies
- Pipeline best practices
- Advanced examples (monorepos, microservices)
Who should read this: Users who need custom deployment logic
Time to complete: 20 minutes
Everything about managing environment variables:
- Adding and editing variables
- Using variables in pipelines
- Using variables in your application
- Security considerations
- Common variable patterns
Who should read this: Developers configuring application settings
Time to complete: 10 minutes
Working with private Git repositories:
- Generating SSH keys
- Adding deploy keys to GitHub/GitLab/Bitbucket
- Key rotation and security
- Troubleshooting SSH connection issues
Who should read this: Users deploying from private repositories
Time to complete: 10 minutes
Configure automatic deployments with webhooks:
- GitHub webhook configuration
- GitLab webhook configuration
- Bitbucket webhook configuration
- Webhook security and verification
- Testing webhooks
- Troubleshooting webhook issues
Who should read this: Users setting up auto-deploy
Time to complete: 10 minutes
Get notified about your deployments. v3.0 (F-006) rebuilt notifications around a Provider → Channel → Subscription model with encrypted credentials. Shipped channels: Discord, Slack, Email. Telegram is on the v3.x backlog.
- v3.0 Provider/Channel/Subscription architecture
- Discord, Slack, and Email channel setup
- Per-project and global subscriptions
- Event filtering (started / success / failed / rolled back)
- Testing a channel before going live
Who should read this: Teams who want deployment notifications
Time to complete: 15 minutes
Deploy a static website
- Creating Projects - Example 1: Simple Static Website
- Webhook Setup - For auto-deploy
Deploy a React application
- Creating Projects - Example 2: React Application
- Pipeline Configuration - Build optimization
- Environment Variables - API URLs, etc.
Deploy a Node.js API
- Creating Projects - Example 3: Node.js API with PM2
- SSH Key Management - If private repo
- Pipeline Configuration - Testing and restarts
Deploy a PHP/Laravel application
- Creating Projects - Example 5: PHP Laravel Application
- Pipeline Configuration - Migrations and caching
- Environment Variables - Database credentials
Deploy to multiple servers
- Creating Projects - Example 4: Multi-Server Deployment
- Deployment Workflows - Understanding parallel deployments
Set up private repository
- SSH Key Management - Generate and configure SSH keys
- Creating Projects - Create project with SSH
Get deployment notifications
- Notifications Setup - Configure your notification channel
-
Week 1: Start with Creating Projects
- Create your first simple project
- Run your first manual deployment
- Watch the deployment logs
-
Week 2: Set up automation
- Follow Webhook Setup
- Configure auto-deploy
- Push code and watch it deploy automatically
-
Week 3: Add notifications
- Follow Notifications Setup
- Get notified about deployments
- Share with your team
- Understand the process: Read Deployment Workflows
- Master pipelines: Study Pipeline Configuration
- Manage secrets: Learn Environment Variables
- Complex pipelines: Advanced examples in Pipeline Configuration
- Security hardening: Review all security sections
- Multi-environment setups: Multiple projects with different configs
Deployment fails at clone step → Check SSH Key Management
Build commands not working → See pipeline examples in Creating Projects
Webhook not triggering → Follow Webhook Setup troubleshooting section
Variables not available → Review Environment Variables
Post-deployment commands fail → Check permissions in Pipeline Configuration
-
Start Simple
- Begin with a basic project
- Add complexity gradually
- Test each feature before moving to the next
-
Test Locally First
- Run all commands on your server manually first
- Make sure they work before adding to pipeline
- Verify permissions and paths
-
Use Version Control
- Keep your deployment configs in Git
- Document your pipeline steps
- Track changes over time
-
Monitor Your Deployments
- Watch the first few deployments closely
- Set up notifications
- Review logs for warnings
-
Security First
- Use environment variables for secrets
- Never commit credentials
- Rotate SSH keys regularly
- Limit deployment user permissions
- docs/README.md — Full documentation index
- API Documentation — REST API reference
docs/versions/v3.0-foundation.md— v3.0 feature specs (Workspaces, Templates, EnvVars, Notifications, Rollback)- FAQ — Frequently asked questions (includes v3.0 New & Changed section)
- Migration v2 → v3 — Upgrade guide
- Roadmap — Every F-NNN feature mapped to its target version
(Coming soon)
- Creating Your First Project
- Setting Up Webhooks
- Advanced Pipeline Configuration
- Multi-Server Deployments
- Check the guides - Your answer might be here
- Review deployment logs - Error messages are helpful
- Test manually - Try commands on your server directly
- Search existing issues - Someone might have had the same problem
- Documentation: You're here! 📖
- GitHub Issues: Report bugs or request features
- GitHub Discussions: Ask questions and share tips
- Community Forum: Connect with other users
Deployment: The process of copying your code from Git to your server
Pipeline: A series of commands that run during deployment
Pre-Deployment: Commands that run before files are synced (build, test)
Post-Deployment: Commands that run after files are synced (restart, migrate)
Webhook: A way for Git platforms to notify Deploy Center of new commits
SSH Key: Encrypted key used to authenticate with Git repositories
Environment Variable: Configuration value available during deployment
Rollback: Restoring the previous version after a failed deployment
Need help? Start with Creating Projects or jump to the guide that matches your needs!
Last updated: 2026-05-24 (v3.0.0 GA — refreshed for v3.0 features).