Skip to content

docs(readme): document IPv6 entries on allowed-ips / allowed-hosts #123

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ronens88 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(readme): document IPv6 entries on allowed-ips / allowed-hosts #123

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,9 @@ The action supports the following parameters:
| `secret` | | Cimon secret for authentication |
| `url` | | Cimon endpoint for authentication |
| `prevent` | `false` | Enable prevention mode |
| `allowed-ips` | | A comma or white space separated list of allowed IP addresses |
| `allowed-hosts` | | A comma or white space separated list of allowed domain names. The left-most label can be the wildcard character (`*`) to match multiple subdomains (e.g. `*.example.com`). |
| `ignored-ip-nets` | | A comma or white space separated list of ignored IP networks in CIDR notation, e.g. 10.0.0.0/8, 172.16.0.0/12. This setting is mandatory if your workflow runs containers attached to a custom network with configured sub-range. In other words, inter-container networking is usually ignored by Cimon. Cimon implicitly ignores 10.0.0.0/8 and 172.16.0.0/12 networks. |
| `allowed-ips` | | A comma or white space separated list of allowed IP addresses (IPv4 or IPv6, e.g. `8.8.8.8, 2606:4700::1111`). |
| `allowed-hosts` | | A comma or white space separated list of allowed domain names. The left-most label can be the wildcard character (`*`) to match multiple subdomains (e.g. `*.example.com`). Both A (IPv4) and AAAA (IPv6) DNS answers for the host are honored (since cimon `v1.0.18`). |
| `ignored-ip-nets` | | A comma or white space separated list of ignored IP networks in CIDR notation (IPv4 or IPv6, e.g. `10.0.0.0/8, 172.16.0.0/12, fc00::/7`). This setting is mandatory if your workflow runs containers attached to a custom network with configured sub-range. In other words, inter-container networking is usually ignored by Cimon. Cimon implicitly ignores 10.0.0.0/8 and 172.16.0.0/12 networks. |
| `github-token` | `${{ github.token }}` | GitHub token (used to overcome GitHub rate limiting) |
| `report-job-summary` | `true` | Report results through job summary output |
| `report-process-tree` | `false` | Enable to report the process tree |
Expand Down
Loading