The following files contain sensitive information and should NEVER be committed to version control:
config.yaml- Contains APRS passcodes and Discord bot tokens.envfiles - Environment variables with credentialscallsigns.txt- May contain personal callsign information
- Use Example Files: Copy
config.example.yamltoconfig.yamland fill in your values - Environment Variables: Use environment variables for production deployments
- Local Overrides: Create
config.local.yamlfor development-specific settings - Docker Secrets: Use Docker secrets or external secret management in production
- Calculate your APRS-IS passcode at: https://apps.magicbug.co.uk/passcode/
- Never share your passcode - it's unique to your callsign
- Obtain from Discord Developer Portal: https://discord.com/developers/applications
- Treat bot tokens like passwords - regenerate if compromised
- These are not secret, but specific to your Discord server setup
- Get them by enabling Developer Mode in Discord
- Firewall: Restrict APRS-IS connections to known ports (14580)
- Access Control: Use
authorized_callsignsto limit who can send messages - Monitoring: Enable logging to track message activity
- Updates: Keep dependencies updated for security patches
-
config.yamlis in.gitignore - No credentials in commit history
- Bot token has minimal required permissions
- APRS passcode is kept private
- Authorized callsigns list is configured
- Logs are monitored for unauthorized access
If you discover a security vulnerability, please:
- Do not open a public issue
- Email the maintainer privately
- Include steps to reproduce the issue
- Allow time for a patch before public disclosure
- Rotate Discord bot tokens annually
- Review authorized callsigns quarterly
- Monitor logs for suspicious activity
- Update dependencies monthly
- Review access permissions semi-annually