Always provide complete documentation for configuration variables, including their exact format, purpose, and behavior. For environment variables and connection strings, specify the full expected format with examples and explain why specific formats are required.
Always provide complete documentation for configuration variables, including their exact format, purpose, and behavior. For environment variables and connection strings, specify the full expected format with examples and explain why specific formats are required.
When documenting configuration options:
# Good: Full connection string format explained
# export PROWLER_DB_CONNECTION=sqlite://
# Format includes "://" to support future DB integrations like MongoDB or Redis
???+ note
The Mutelist configuration takes effect on the next scans.
If no token is explicitly provided, Prowler will automatically attempt to authenticate using environment variables in the following order of precedence:
1. `GITHUB_PERSONAL_ACCESS_TOKEN`
2. `OAUTH_APP_TOKEN`
3. `GITHUB_APP_ID` and `GITHUB_APP_KEY`
The necessary modules will not be installed automatically by Prowler. Nevertheless, if you want Prowler to install them for you, you can execute the provider with the flag `--init-modules`, which will run the script to install and import them.
Thorough configuration documentation prevents confusion, reduces support requests, and ensures users can correctly configure the system for their specific needs.
Enter the URL of a public GitHub repository