Skip to content
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

docs: update README.md #18

Merged
merged 1 commit into from
May 6, 2023
Merged

docs: update README.md #18

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
42 changes: 21 additions & 21 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,31 +16,31 @@ steps:
with:
prevent: true
allowed-ips: ...
allowed-domain-names: ...
allowed-hosts: ...
```

## Usage

The action supports the following parameters:

| Name | Default | Description |
|--------------------------|-------------------------------------|---------------------------------------------------------------------------------|
| `client-id` | | Cimon client ID for authentication |
| `secret` | | Cimon secret for authentication |
| `prevent` | `false` | Enable prevention mode |
| `allowed-ips` | | A comma-separated list of allowed IP addresses |
| `allowed-hosts` | | A comma or white space separated list of domain names |
| `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 |
| `report-artifact-log` | `true` | Report logs through job artifact |
| `slack-webhook-endpoint` | | Slack webhook endpoint to report security events |
| `apply-fs-events` | `false` | Enable processing filesystem events and display them in the process tree report |
| `docker-image` | `docker.io/cycodelabs/cimon:v0.4.0` | Docker image reference |
| `docker-image-pull` | `false` | Skip pulling image from registry (Used for debugging) |
| `docker-username` | `false` | Username to pull image from registry (Used for debugging) |
| `docker-password` | `false` | Password to pull image from registry (Used for debugging) |
| `log-level` | `info` | Log level (Used for debugging) |
| Name | Default | Description |
|--------------------------|-------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `client-id` | | Cimon client ID for authentication |
| `secret` | | Cimon secret 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`). |
| `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 |
| `report-artifact-log` | `true` | Report logs through job artifact |
| `slack-webhook-endpoint` | | Slack webhook endpoint to report security events |
| `apply-fs-events` | `false` | Enable processing filesystem events and display them in the process tree report |
| `docker-image` | `docker.io/cycodelabs/cimon:v0.4.0` | Docker image reference |
| `docker-image-pull` | `false` | Skip pulling image from registry (Used for debugging) |
| `docker-username` | `false` | Username to pull image from registry (Used for debugging) |
| `docker-password` | `false` | Password to pull image from registry (Used for debugging) |
| `log-level` | `info` | Log level (Used for debugging) |

## Scenarios

Expand All @@ -58,8 +58,8 @@ steps:
- uses: cycodelabs/cimon-action@v0
with:
prevent: true
allowed-ips: ""
allowed-domain-names: "cycode.com"
allowed-hosts: >
cycode.com
```

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