If you discover a security vulnerability in this project, please report it by opening an issue on GitHub.

This project uses configuration files that may contain sensitive information. To protect your data:

1. Environment Variables (.env): Contains login credentials

   • Never commit .env files to git
   • Always use .env.example as a template
   • Store credentials securely

2. Config File (config.ini): Contains personal information

   • Never commit config.ini with real data to git
   • Always use config.ini.example as a template
   • Replace placeholder values with your actual data locally

The following types of information should never be committed to the repository:

• Login passwords and usernames
• Phone numbers
• Email addresses
• Personal rates or pricing information
• User IDs
• Any other personally identifiable information (PII)

Important Notice: Earlier versions of this repository may have contained example personal data in configuration files. This has been removed from the current version, but may still exist in git history.

If you have forked this repository and need to clean the history:

1. For the main repository owner: Consider using tools like git filter-repo or BFG Repo-Cleaner to remove sensitive data from all commits. Note that this requires force-pushing and will affect all forks.

2. For contributors: Always ensure your fork has the latest changes and never commit real credentials or personal data.

1. Never commit sensitive data: Always review your changes before committing
2. Use templates: Always start from .example files
3. Keep local: Sensitive configuration should only exist in your local development environment
4. Regular audits: Periodically check your git history for accidentally committed secrets
5. Environment separation: Use different credentials for development and production

Consider using these tools to detect accidentally committed secrets:

• git-secrets: Prevents committing secrets and credentials
• truffleHog: Searches through git history for secrets
• detect-secrets: Prevents secrets from being committed

We take security seriously. If you find a vulnerability:

1. Do not disclose it publicly until it has been addressed
2. Provide detailed information about the vulnerability
3. Give us reasonable time to address the issue

Security patches will be applied to the main branch. Users are encouraged to:

• Keep their forks up to date
• Review security advisories
• Update dependencies regularly