If you discover a security vulnerability in this project, please report it by opening an issue on GitHub. Include as much detail as possible, such as steps to reproduce the vulnerability, expected behavior, and actual behavior.
-
Never Commit Real API Keys:
- Never commit real API keys or sensitive information to the repository. Use environment variables or configuration files to store sensitive information.
-
Use .env or Environment Variables:
- Use
.envfiles or environment variables to store sensitive information.
- Use
-
Rotate Exposed Secrets Immediately:
- If a secret is exposed, rotate it immediately.
-
Add .gitignore Requirements:
- Ensure that
.envfiles and other sensitive files are included in.gitignore.
- Ensure that
-
What to Do If a Key Was Leaked:
- If a key is leaked, rotate it immediately and update any affected systems.
-
Safe Sharing Practices for Sample Configs:
- When sharing sample configurations, use placeholder values for sensitive information.
-
Warning Against Exposing Local Ports Publicly:
- Do not expose local ports publicly. Use firewalls and other security measures to protect your system.