This repository contains configuration templates that MUST be customized with your own values before use.
- Copy
.env.exampleto.env - Replace
your_github_personal_access_token_herewith your actual GitHub token - NEVER commit the real
.envfile
- Copy
config.example.yamltoconfig.yaml - Replace all placeholder values:
[email protected]→ Your actual WhatsApp group IDYOUR_WHATSAPP_API_SERVER→ Your WhatsApp API server IP/domainyour-org/your-frontend-repo→ Your actual repository namesyour-branch→ Your actual branch namesyour-workflow.yml→ Your actual workflow file names
- Update namespace names (
your-namespace→ your actual namespace) - Update deployment names (
your-frontend,your-backend→ your actual deployments) - Update kubectl configuration paths if needed
The following information should NEVER be committed to version control:
- GitHub personal access tokens
- WhatsApp group IDs
- WhatsApp API server IPs
- Internal server IPs or hostnames
- Any production credentials
These files are safe to commit:
config.example.yaml(with placeholders).env.example(with placeholders)- All Python scripts
- Documentation files
- Installation scripts
The included .gitignore file prevents accidental commits of:
.envfiles- Log files
- State files
- Cache directories
- Backup files
Always verify your changes before committing!