| Version | Supported |
|---|---|
| 1.0.x | ✅ |
| < 1.0 | ❌ |
We take the security of this project seriously. If you believe you have found a security vulnerability, please follow these steps:
-
Do not disclose the vulnerability publicly
-
Email the details to [email protected]
- Provide a detailed description of the vulnerability
- Include steps to reproduce the issue
- Attach any proof-of-concept code if applicable
- Let us know how you'd like to be credited (or if you prefer to remain anonymous)
-
Allow time for response
- We will acknowledge receipt of your report within 48 hours
- We will provide an estimated timeline for a fix
- We will keep you updated on our progress
When using this project, please consider the following security aspects:
-
Database Credentials: The application requires database credentials to perform backups. These should be kept secure and provided via environment variables or a secure secrets management system.
-
Encryption Passwords: If you enable backup encryption, ensure you store the encryption password securely and have a process for recovery.
-
Storage Provider Credentials: Credentials for cloud storage providers should be kept secure and rotated regularly.
-
HTTP Endpoint Token: The token for the health check endpoint should be kept secret to prevent unauthorized access to backup status information.
-
Container Security: Follow Docker security best practices when deploying the container.
We will announce security updates through:
- GitHub Security Advisories
- Release notes
- Notifications to users who have starred or watched the repository
When deploying this application, consider the following best practices:
- Run the container with the least privileges necessary
- Keep the container and its dependencies updated
- Use a read-only database user for backups when possible
- Encrypt sensitive backups
- Regularly test backup restoration
- Monitor the backup process and set up alerts for failures