Skip to content

SUPPORT.md

Latest commit

 

History

History
197 lines (132 loc) · 5.64 KB

SUPPORT.md

File metadata and controls

197 lines (132 loc) · 5.64 KB

Support

Need help with Keyspace? We're here to help!

Getting Help

Documentation

Start with our comprehensive documentation:

Community Support

Join our community for help and discussions:

Bug Reports

Found a bug? Please report it:

  1. Check if it's already reported in Issues
  2. If not, create a new issue
  3. Use the bug report template and provide as much detail as possible

Feature Requests

Have an idea? We'd love to hear it:

  1. Check if it's already requested in Issues
  2. If not, create a feature request
  3. Describe your use case and the feature you'd like to see

Support Channels

Free Community Support

  • GitHub Issues (bug reports and feature requests)
  • GitHub Discussions (Q&A and general discussion)
  • Discord community chat
  • Stack Overflow (programming questions)

Commercial Support

For enterprise users requiring dedicated support:

  • Email: support@keyspace.example.com

  • Priority Response: 24-hour response time

  • Custom Development: Feature development and customization

  • Training: On-site or remote training sessions

  • Consulting: Security assessment and implementation guidance

Contact us at enterprise@keyspace.example.com for commercial support options.

What We Support

We Can Help With

  • Installation and setup issues
  • Configuration problems
  • Bug reports and feature requests
  • Usage questions
  • Performance optimization
  • Integration guidance
  • Security best practices

We Cannot Help With

  • Cracking passwords you don't own or have permission to test
  • Bypassing security systems illegally
  • Recovering lost passwords for third-party services
  • Any illegal or unethical activities

Before Asking for Help

Please check these items before reaching out:

  1. Read the documentation - Your question might already be answered
  2. Search existing issues - Someone might have had the same problem
  3. Check your version - Make sure you're using the latest version
  4. Try the basics - Restart the application, check your configuration
  5. Gather information - Collect error messages, logs, and system info

Information to Include

When reporting issues, please include:

For Bug Reports

  • Keyspace version

  • Operating system and version

  • Python version

  • Steps to reproduce the issue

  • Expected behavior

  • Actual behavior

  • Error messages (full traceback if available)

  • Screenshots (if applicable)

For Performance Issues

  • System specifications (CPU, RAM, GPU)
  • Attack type and configuration
  • Target type and hash
  • Wordlist size (if applicable)
  • Performance metrics (speed, memory usage)

For Installation Issues

  • Operating system and version
  • Installation method (pip, package, source)
  • Python version
  • Error messages during installation
  • Dependencies installed

Response Times

  • Critical bugs: 24-48 hours
  • Feature requests: 1-2 weeks (evaluation)
  • General questions: 2-5 days
  • Documentation issues: 1-2 weeks

Security Issues

DO NOT report security vulnerabilities publicly.

Instead:

  1. Email security@keyspace.example.com

  2. Or use GitHub Security Advisories

  3. Include detailed description and reproduction steps

  4. Allow time for fix before public disclosure

See SECURITY.md for our security policy.

Professional Services

Training

  • Beginner Workshop: 2-hour introduction
  • Advanced Training: Full-day deep dive
  • Custom Training: Tailored to your needs

Consulting

  • Security assessment
  • Implementation planning
  • Custom feature development
  • Integration architecture

Support Tiers

Tier Response Time Channels Price
Community Best effort GitHub, Discord Free
Basic 48 hours Email $99/month
Professional 24 hours Email, Phone $299/month
Enterprise 4 hours Dedicated manager Custom

Contact enterprise@keyspace.example.com for details.

Contributing to Support

Help others in the community:

  • Answer questions on GitHub Discussions
  • Share your solutions
  • Write tutorials and blog posts
  • Improve documentation

Feedback

We value your feedback:

Stay Updated

Thank you for using Keyspace!

We're committed to helping you succeed with your security testing needs.