Skip to content

Commit 7de0110

Browse files
committed
update docs
1 parent 331ce96 commit 7de0110

File tree

1 file changed

+26
-9
lines changed

1 file changed

+26
-9
lines changed

docs/exporting/export-html.md

Lines changed: 26 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The HTML report is entirely independent of the JSON or CSV report. As a result,
2626

2727
## Exporting options
2828

29-
Monkey365 HTML reports uses CDN (jsDelivr) to load assets by default. The base [configuration](../configuration/configuration-file.md) is as follows:
29+
Monkey365 HTML reports use the `jsDelivr` CDN to load resources directly from GitHub. By default, `htmlReportFromCDN` is set to `true`, and the `assetsRepository` property points to the standard assets repository at https://github.com/silverhack/monkey365assets. The base [configuration](../configuration/configuration-file.md) is structured as follows:
3030

3131
```json
3232
"htmlSettings": {
@@ -39,19 +39,36 @@ Monkey365 HTML reports uses CDN (jsDelivr) to load assets by default. The base [
3939
"htmlReportFromCDN": "true"
4040
},
4141
```
42-
As an alternative, you can enable the legacy mode, which will download a local copy of all the assets and set local links within the report.
42+
43+
As an alternative, you can enable the legacy UNC mode. This mode downloads a local copy of all required assets and updates the report to use local links. To activate it, specify a local or UNC path in the `assetsPath` property and set `enabled` to `true`.
4344

4445
???+ note
4546
Downloading assets significantly increases the size of a report. The size can exceed 20MB.
4647

4748
### In-House CDN
4849

49-
There is an option to use an in-house CDN by configuring CDN URL via `assetsRepository` property (defaults to https://github.com/silverhack/monkey365assets).
50+
There is an option to use an in-house CDN by configuring your own GitHub repository via `assetsRepository` property (defaults to https://github.com/silverhack/monkey365assets).
5051

5152
* Download assets via GitHub
5253
* Unpack it and upload files into your CDN (e.g. private GitHub repository)
5354
* Set the `assetsRepository`property to new CDN link
5455

56+
### Local Server
57+
58+
Monkey365 can also serve static HTML assets (CSS, JavaScript, images, fonts, and more) through a dedicated local web server endpoint rather than loading them from GitHub. To enable this option, set the assetsPath property to the base URL where the static assets are hosted.
59+
60+
```json
61+
"htmlSettings": {
62+
"convertPassFindingToGood": true,
63+
"assetsRepository":"https://github.com/silverhack/monkey365assets",
64+
"localHtmlReport": {
65+
"assetsPath": "http(s)://your_local_server/localassets/",
66+
"enabled": "true"
67+
},
68+
"htmlReportFromCDN": "true"
69+
}
70+
```
71+
5572
## Compliance
5673

5774
A [ruleset](../security_checks/overview.md) allows you to organize multiple rules that work towards a common goal. These rulesets represent your governance rules that you want Monkey365 to analyze for you. Monkey365 will alert you when a rule is violated.
@@ -122,7 +139,7 @@ In the above example, this will result in the data being rendered in a single ta
122139

123140
![](../assets/images/tableAsList.png)
124141

125-
### Normal Table
142+
### Default Table
126143

127144
In this example, the following code that was extracted from the <a href='https://github.com/silverhack/monkey365/blob/main/rules/findings/Azure/Storage%20Accounts/CIS1.4/azure-storage-accounts-https-traffic-enabled.json' target='_blank'>azure-storage-accounts-https-traffic-enabled.json</a> Monkey365 rule is used to render data for *Storage accounts missing key rotation* finding into a default table.
128145

@@ -137,7 +154,7 @@ In this example, the following code that was extracted from the <a href='https:/
137154
},
138155
"expandObject": null
139156
},
140-
"table": "Normal",
157+
"table": "default",
141158
"decorate": [
142159

143160
],
@@ -170,11 +187,11 @@ Table elements can be configured to show raw data on Bootstrap Modal. In order t
170187
}
171188
}
172189
```
173-
The above example will result in the data being rendered in a single table formatted as normal table, and a modal button in last column.
190+
The above example will result in the data being rendered in a single table formatted as default table, and a modal button in last column.
174191

175192
![](../assets/images/modalButton.png)
176193

177-
**Note** This feature is only supported in tables formatted as a ```Normal``` table.
194+
**Note** This feature is only supported in tables formatted as a ```default``` table.
178195

179196
<!--
180197
@@ -200,10 +217,10 @@ Table elements can be configured to add a direct link to the Azure console secti
200217
}
201218
}
202219
```
203-
The above example will result in the data being rendered in a single table formatted as normal table, and a direct link button in last column.
220+
The above example will result in the data being rendered in a single table formatted as default table, and a direct link button in last column.
204221
205222
![](../assets/images/directLinkButton.png)
206223
207-
**Note** This feature is only supported in tables formatted as a ```Normal``` table. Please, also note that since this feature is experimental, we welcome your feedback.
224+
**Note** This feature is only supported in tables formatted as a ```default``` table. Please, also note that since this feature is experimental, we welcome your feedback.
208225
209226
-->

0 commit comments

Comments
 (0)