Skip to content

Security Policy

Supported Versions

This section describes which versions of the Ultimate MkDocs documentation platform are currently being supported with security updates.

Version Supported
1.x.x ✅
< 1.0 ❌

Reporting a Vulnerability

We take the security of our documentation platform seriously. If you have discovered a security vulnerability, please follow these steps:

How to Report

  1. DO NOT open a public issue
  2. Email your findings to the project maintainers
  3. Include the following information:
  4. Type of vulnerability
  5. Full paths of source file(s) related to the vulnerability
  6. The location of the affected source code
  7. Any special configuration required to reproduce the issue
  8. Step-by-step instructions to reproduce the issue
  9. Proof-of-concept or exploit code (if possible)
  10. Impact of the issue

What to Expect

  • Acknowledgment: We will acknowledge receipt of your vulnerability report within 48 hours
  • Initial Assessment: Within 7 days, we will provide an initial assessment of the vulnerability
  • Resolution Timeline: We aim to resolve critical vulnerabilities within 30 days
  • Communication: We will keep you informed about the progress of addressing the vulnerability
  • Credit: We will credit you for the discovery in our release notes (unless you prefer to remain anonymous)

Security Best Practices

When using this documentation platform:

  1. Keep Dependencies Updated: Regularly update MkDocs and its dependencies
  2. Use HTTPS: Always serve documentation over HTTPS in production
  3. Access Control: Implement appropriate access controls for sensitive documentation
  4. Regular Audits: Perform regular security audits of your documentation infrastructure
  5. Secrets Management: Never commit secrets or API keys to documentation

Security Features

Our documentation platform includes:

  • Content Security Policy (CSP) headers
  • XSS protection
  • CSRF protection for interactive features
  • Secure cookie handling
  • Input sanitization

Thank you for helping keep the Ultimate MkDocs documentation platform secure!