We actively support the following versions with security updates:
| Version | Supported |
|---|---|
| 1.0.x | ✅ |
If you discover a security vulnerability, please do not open a public issue. Instead, please report it privately by:
- Email: Contact the repository maintainers directly
- GitHub Security Advisory: Use GitHub's private vulnerability reporting feature (if enabled)
When reporting a security vulnerability, please include:
- Description: Clear description of the vulnerability
- Impact: Potential impact and severity
- Steps to Reproduce: Detailed steps to reproduce the issue
- Suggested Fix: If you have a suggested fix, please include it
- Affected Versions: Which versions are affected
- Initial Response: Within 48 hours
- Status Update: Within 7 days
- Resolution: Depends on severity and complexity
When using this repository:
- Keep Dependencies Updated: Regularly update dependencies to receive security patches
- Review Configuration: Ensure environment variables and configuration files are properly secured
- Use Environment Variables: Never commit API keys, passwords, or sensitive tokens
- Follow Principle of Least Privilege: Run services with minimal required permissions
- Monitor Logs: Regularly review logs for suspicious activity
- Network Security: Use HTTPS/TLS for all network communications
- Regular Backups: Maintain regular backups of detection data and configurations
- Ollama: Runs locally by default. If exposing Ollama over a network, ensure proper authentication and network security
- Model Security: Use trusted models from verified sources
- SQLite: Default database is SQLite (file-based). For production, consider using a more robust database with proper access controls
- ChromaDB: Vector database runs locally. Ensure proper file permissions
- Dashboard: Streamlit dashboard runs on
localhost:8501by default. Do not expose to public networks without proper authentication - API Endpoints: If exposing API endpoints, implement proper authentication and rate limiting
Security updates will be:
- Released as patch versions (e.g., 1.0.1, 1.0.2)
- Documented in CHANGELOG.md
- Tagged with security labels in GitHub
We appreciate responsible disclosure of security vulnerabilities. Contributors who report security issues will be acknowledged (with permission) in our security advisories.