Skip to content

Commit e026f7e

Browse files
Update Helium Security action and add deployment info
Updated the action used for Helium Security scans and added on-premise deployment instructions.
1 parent a58e811 commit e026f7e

1 file changed

Lines changed: 37 additions & 5 deletions

File tree

README.md

Lines changed: 37 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ This GitHub Action allows you to automatically run security scans using Helium S
5151
```yaml
5252
steps:
5353
- name: Helium Security Website Scan (No Auth)
54-
uses: CyberArmyID/Helium-Security-Vulnerability-Scanner@v1.0.0
54+
uses: CyberArmyID/helium-security-action@v1.0.1
5555
with:
5656
api_key: ${{ secrets.HELIUM_API_KEY }}
5757
workspace_id: abcd1234-abcd-abcd-abcd
@@ -88,7 +88,7 @@ steps:
8888
```yaml
8989
steps:
9090
- name: Helium Security Website Scan (Cookie Auth)
91-
uses: CyberArmyID/Helium-Security-Vulnerability-Scanner@v1.0.0
91+
uses: CyberArmyID/helium-security-action@v1.0.1
9292
with:
9393
api_key: ${{ secrets.HELIUM_API_KEY }}
9494
workspace_id: abcd1234-abcd-abcd-abcd
@@ -128,7 +128,7 @@ steps:
128128
```yaml
129129
steps:
130130
- name: Helium Security Website Scan (Form Auth)
131-
uses: CyberArmyID/Helium-Security-Vulnerability-Scanner@v1.0.0
131+
uses: CyberArmyID/helium-security-action@v1.0.1
132132
with:
133133
api_key: ${{ secrets.HELIUM_API_KEY }}
134134
workspace_id: abcd1234-abcd-abcd-abcd
@@ -167,7 +167,7 @@ steps:
167167
```yaml
168168
steps:
169169
- name: Helium Security API Scan (No Auth)
170-
uses: CyberArmyID/Helium-Security-Vulnerability-Scanner@v1.0.0
170+
uses: CyberArmyID/helium-security-action@v1.0.1
171171
with:
172172
api_key: ${{ secrets.HELIUM_API_KEY }}
173173
workspace_id: abcd1234-abcd-abcd-abcd
@@ -206,7 +206,7 @@ steps:
206206
```yaml
207207
steps:
208208
- name: Helium Security API Scan (Auth)
209-
uses: CyberArmyID/Helium-Security-Vulnerability-Scanner@v1.0.0
209+
uses: CyberArmyID/helium-security-action@v1.0.1
210210
with:
211211
api_key: ${{ secrets.HELIUM_API_KEY }}
212212
workspace_id: abcd1234-abcd-abcd-abcd
@@ -222,3 +222,35 @@ steps:
222222
auth_token_prefix: Bearer
223223
fail_on: high
224224
```
225+
226+
### On-Premise Deployment (Optional)
227+
228+
##### Inputs
229+
230+
| Name | Type | Default | Required | Description |
231+
|-------------------|--------|-----------------------|----------|----------------------------------------------------------------------------|
232+
| helium_base_url | string | https://api.helium.sh | No | Base URL for the Helium API. Set this to your server address (e.g., http://127.0.0.1:1337) for on-premise deployments. |
233+
| api_key | string | - | Yes | Helium API Key |
234+
| workspace_id | string | - | Yes | Workspace ID |
235+
| tool | string | - | Yes | Scanner type (`website-scanner`) |
236+
| scan_option | string | - | Yes | Scanner option (`basic_scan`, `full_scan`) |
237+
| target | string | - | Yes | Target URL to scan |
238+
| target_path | string | - | No | Path to the target file or directory for scanning |
239+
| fail_on | string | high | No | Fail the build if severity >= value (`low`, `medium`, `high`, `critical`) |
240+
241+
##### Example Usage:
242+
243+
```yaml
244+
steps:
245+
- name: Helium Security Website Scan (No Auth, On-Premise)
246+
uses: CyberArmyID/helium-security-action@v1.0.1
247+
with:
248+
helium_base_url: ${{ secrets.HELIUM_BASE_URL }}
249+
api_key: ${{ secrets.HELIUM_API_KEY }}
250+
workspace_id: abcd1234-abcd-abcd-abcd
251+
tool: website-scanner
252+
scan_option: basic_scan
253+
target: example.com
254+
target_path: /path
255+
fail_on: high
256+
```

0 commit comments

Comments
 (0)