Skip to content

SUPPORT.md

Latest commit

 

History

History
436 lines (267 loc) · 12.1 KB

SUPPORT.md

File metadata and controls

436 lines (267 loc) · 12.1 KB

Support

Thank you for using Deploy Center! We're here to help you get the most out of your deployment automation platform.

📚 Documentation

Before seeking support, please check our comprehensive documentation:

Getting Started

API Documentation

Troubleshooting

💬 Community Support

GitHub Discussions

The best place to ask questions and get help from the community:

💬 Join GitHub Discussions

  • ❓ Q&A — Ask questions and get answers
  • 💡 Ideas — Share feature ideas and suggestions
  • 🎓 Show & Tell — Share your Deploy Center setup
  • 📣 Announcements — Stay updated with news

GitHub Issues

For bug reports and feature requests:

🐛 Report a Bug

✨ Request a Feature

Before creating an issue:

  1. ✅ Search existing issues to avoid duplicates
  2. ✅ Read the troubleshooting guide
  3. ✅ Gather relevant information (logs, environment details, steps to reproduce)
  4. ✅ Use the provided issue templates

🔍 Self-Help Resources

Common Questions

Installation & Setup

Q: How do I install Deploy Center?

Q: What are the system requirements?

  • A: Node.js ≥ 18.0.0, npm ≥ 9.0.0, MariaDB ≥ 10.6. See Prerequisites.

Q: Database connection failed, what should I do?

Configuration

Q: How do I generate secure secrets?

  • A: Run: node -e "console.log(require('crypto').randomBytes(64).toString('hex'))" See Configuration.

Q: How do I configure webhooks?

Q: How do I add notifications?

Deployment

Q: My deployment is stuck in queue, why?

  • A: Only one deployment can run per project at a time. Check queue status via API or logs.

Q: How do I retry a failed deployment?

Q: Can I rollback a deployment?

  • A: Rollback feature is planned for v3.0. Currently, you can deploy a previous commit manually.

Security

Q: How do I secure my installation?

Q: How do I report a security vulnerability?

Development

Q: How do I contribute?

Q: What coding standards do you follow?

  • A: We use TypeScript strict mode, PascalCase naming, SOLID principles, and ESLint/Prettier. See Coding Standards.

📧 Email Support

General Support

For general questions and support:

Email: support@futuresolutionsdev.com

Response Time: Within 1-3 business days (usually faster)

Please include:

  • Clear description of your issue
  • Deploy Center version
  • Environment details (OS, Node.js version)
  • Steps to reproduce (if applicable)
  • Relevant logs or error messages

Security Issues

For security-related concerns:

Email: security@futuresolutionsdev.com

Response Time: Within 24 hours for critical issues

Please see: Security Policy

Commercial Support

For business inquiries and commercial support:

Email: licensing@futuresolutionsdev.com

Commercial support includes:

  • Priority email support
  • Phone/video call support
  • Custom feature development
  • On-site installation and training
  • SLA guarantees

💼 Professional Services

Consulting & Integration

Need help with deployment, customization, or integration?

Services:

  • ✅ Custom deployment pipeline design
  • ✅ Multi-server setup and configuration
  • ✅ Integration with existing CI/CD tools
  • ✅ Performance optimization
  • ✅ Security audit and hardening
  • ✅ Team training and onboarding

Contact: consulting@futuresolutionsdev.com

Custom Development

Need custom features for your organization?

We can build:

  • Custom integrations (GitLab, Bitbucket, etc.)
  • Advanced deployment strategies
  • Custom notification channels
  • Enterprise features (SSO, multi-tenancy)
  • White-label solutions

Contact: dev@futuresolutionsdev.com

📞 Contact Channels

Email

Phone & WhatsApp

Office Hours: Sunday - Thursday, 9:00 AM - 5:00 PM (GMT+2)

Social Media

GitHub

🕐 Response Times

Community Support (Free)

Channel Response Time
GitHub Discussions 1-3 days (community-driven)
GitHub Issues 1-5 days (depends on priority)
Email (support@) 1-3 business days

Commercial Support (Paid)

Priority Response Time Resolution Time
Critical < 4 hours 1-2 business days
High < 8 hours 2-5 business days
Normal < 24 hours 5-10 business days
Low < 48 hours 10-15 business days

Commercial support requires an active support contract.

🔍 Troubleshooting Checklist

Before reaching out for support, please try these steps:

1. Check Documentation

2. Search Existing Issues

3. Verify Environment

  • Node.js version ≥ 18.0.0: node --version
  • npm version ≥ 9.0.0: npm --version
  • MariaDB running: systemctl status mariadb
  • Database accessible: mysql -u deploy_user -p

4. Check Logs

  • Check application logs: tail -f logs/combined-*.log
  • Check error logs: tail -f logs/error-*.log
  • Check deployment logs: tail -f logs/deployment-*.log
  • Check PM2 logs (if using PM2): pm2 logs deploy-center

5. Verify Configuration

  • Environment variables set correctly in .env
  • Database credentials correct
  • JWT secrets generated and set
  • Ports not in use by other services

6. Test Connectivity

  • Server responding: curl http://localhost:3000/health
  • Database connection: mysql -u deploy_user -p deploy_center
  • Webhook accessible (if using webhooks)

📊 Diagnostic Information

When reporting an issue, please include:

System Information

# Operating System
cat /etc/os-release

# Node.js version
node --version

# npm version
npm --version

# MariaDB version
mysql --version

# Deploy Center version
cat package.json | grep version

Environment Configuration

# From .env (REMOVE SECRETS!)
NODE_ENV=production
PORT=3000
DB_DIALECT=mariadb
# ... other non-sensitive config

Error Logs

# Last 50 lines of error logs
tail -n 50 logs/error-*.log

# Last 50 lines of combined logs
tail -n 50 logs/combined-*.log

Health Check

# Server health
curl http://localhost:3000/health

# Database connectivity
mysql -u deploy_user -p -e "SELECT 1"

🎓 Learning Resources

Tutorials & Guides

Video Tutorials (Coming Soon)

  • 🎥 Installation walkthrough
  • 🎥 Creating your first project
  • 🎥 Setting up webhooks
  • 🎥 Advanced pipeline configuration

Blog Posts (Coming Soon)

  • 📝 Deploy Center vs. Traditional CI/CD
  • 📝 Best practices for deployment automation
  • 📝 Securing your Deploy Center installation

💖 Community Guidelines

When seeking support, please:

  • ✅ Be respectful and patient
  • ✅ Provide complete information
  • ✅ Follow the Code of Conduct
  • ✅ Search before asking
  • ✅ Share solutions if you find them
  • ❌ Don't post sensitive information (passwords, API keys)
  • ❌ Don't spam or post off-topic content

🤝 Contributing

Found a bug? Have a feature idea? Want to improve the documentation?

We welcome contributions!

See the Contributing Guide to get started.

📜 License

Deploy Center is available under dual licensing:

For licensing questions: licensing@futuresolutionsdev.com

🙏 Thank You

Thank you for using Deploy Center! We appreciate your support and feedback.

If Deploy Center has been helpful, consider:

  • ⭐ Starring the repository on GitHub
  • 📢 Sharing with others who might find it useful
  • 💬 Contributing to the project
  • 💰 Sponsoring development (see FUNDING.yml)

Need more help? Don't hesitate to reach out!

📧 support@futuresolutionsdev.com | 🌐 futuresolutionsdev.com

Made with ❤️ by FutureSolutionDev