Skip to content

Commit 545d1f9

Browse files
author
Timothy MacDonald
committed
docs: added quickstart to readme.md
Signed-off-by: Timothy MacDonald <[email protected]>
1 parent 6f598d7 commit 545d1f9

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,27 @@
44

55
A project to abstract the gathering, transformations, and rendering of datasets from Lacework into auto-generated reports.
66

7+
## Quickstart
8+
9+
1. Download the binary for your platform from the releases section
10+
11+
2. Ensure you have some method of authenticating against your FortiCNAPP API. The easiest
12+
way is to download an API key file from your FortiCNAPP UI under Settings -> API Keys.
13+
14+
3. Run the binary <i> from the command line </i> using the following flags:
15+
16+
`--gui --api-key-file <keyfile>`
17+
18+
Where \<keyfile> is the name of the api key file you downloaded.
19+
20+
For example on an ARM based Mac download the ARM binary file from the "Releases" section of this page (lw_report_gen_mac_arm
21+
) and execute it:
22+
23+
`./lw_report_gen_mac_arm --gui --api-key-file example.json`
24+
25+
On Mac you may get an error regarding it being an unsigned application. If so you can read the following article on how to run the binary:
26+
27+
https://support.apple.com/guide/mac-help/open-a-mac-app-from-an-unknown-developer-mh40616/mac
728

829
## Usage for CSA Reports
930

0 commit comments

Comments
 (0)