Skip to content

Commit 544f316

Browse files
danielpacakdanielpacak
committed
docs: update README.md
1 parent d55055d commit 544f316

1 file changed

Lines changed: 21 additions & 21 deletions

File tree

‎README.md‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -16,31 +16,31 @@ steps:
1616
with:
1717
prevent: true
1818
allowed-ips: ...
19-
allowed-domain-names: ...
19+
allowed-hosts: ...
2020
```
2121
2222
## Usage
2323
2424
The action supports the following parameters:
2525
26-
| Name | Default | Description |
27-
|--------------------------|-------------------------------------|---------------------------------------------------------------------------------|
28-
| `client-id` | | Cimon client ID for authentication |
29-
| `secret` | | Cimon secret for authentication |
30-
| `prevent` | `false` | Enable prevention mode |
31-
| `allowed-ips` | | A comma-separated list of allowed IP addresses |
32-
| `allowed-hosts` | | A comma or white space separated list of domain names |
33-
| `github-token` | `${{ github.token }}` | GitHub token (used to overcome GitHub rate limiting) |
34-
| `report-job-summary` | `true` | Report results through job summary output |
35-
| `report-process-tree` | `false` | Enable to report the process tree |
36-
| `report-artifact-log` | `true` | Report logs through job artifact |
37-
| `slack-webhook-endpoint` | | Slack webhook endpoint to report security events |
38-
| `apply-fs-events` | `false` | Enable processing filesystem events and display them in the process tree report |
39-
| `docker-image` | `docker.io/cycodelabs/cimon:v0.4.0` | Docker image reference |
40-
| `docker-image-pull` | `false` | Skip pulling image from registry (Used for debugging) |
41-
| `docker-username` | `false` | Username to pull image from registry (Used for debugging) |
42-
| `docker-password` | `false` | Password to pull image from registry (Used for debugging) |
43-
| `log-level` | `info` | Log level (Used for debugging) |
26+
| Name | Default | Description |
27+
|--------------------------|-------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
28+
| `client-id` | | Cimon client ID for authentication |
29+
| `secret` | | Cimon secret for authentication |
30+
| `prevent` | `false` | Enable prevention mode |
31+
| `allowed-ips` | | A comma or white space separated list of allowed IP addresses |
32+
| `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`). |
33+
| `github-token` | `${{ github.token }}` | GitHub token (used to overcome GitHub rate limiting) |
34+
| `report-job-summary` | `true` | Report results through job summary output |
35+
| `report-process-tree` | `false` | Enable to report the process tree |
36+
| `report-artifact-log` | `true` | Report logs through job artifact |
37+
| `slack-webhook-endpoint` | | Slack webhook endpoint to report security events |
38+
| `apply-fs-events` | `false` | Enable processing filesystem events and display them in the process tree report |
39+
| `docker-image` | `docker.io/cycodelabs/cimon:v0.4.0` | Docker image reference |
40+
| `docker-image-pull` | `false` | Skip pulling image from registry (Used for debugging) |
41+
| `docker-username` | `false` | Username to pull image from registry (Used for debugging) |
42+
| `docker-password` | `false` | Password to pull image from registry (Used for debugging) |
43+
| `log-level` | `info` | Log level (Used for debugging) |
4444

4545
## Scenarios
4646

@@ -58,8 +58,8 @@ steps:
5858
- uses: cycodelabs/cimon-action@v0
5959
with:
6060
prevent: true
61-
allowed-ips: ""
62-
allowed-domain-names: "cycode.com"
61+
allowed-hosts: >
62+
cycode.com
6363
```
6464

6565
### Running Cimon on detect mode with a process tree and file system events

0 commit comments

Comments
 (0)