Skip to content

Commit 3798cca

Browse files
committed
Restructure user manual in readme
1 parent 73ce284 commit 3798cca

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

readme.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,6 @@ Continue reading for details on making use of LDT to test APIs.
1111

1212
# Leakdown Tester User Manual
1313
Here are listed the currently implemented user commands, environmental variables, and instructions for use.
14-
## Environmental Variables
15-
1) `CSVPATH` - Filepath to a local CSV file.
16-
The script checks for this on startup, as JSON content to send as a POST request is currently required. You can specify this filepath with the csv argument, or you can set the env var and specify a different filepath with the csv argument which will override the environment variable. A filepath must be specified if not using the `useGit` argument.
17-
2) `PFP` - URL of the PFP API endpoint where the POST requests are sent.
18-
It is likely faster to use the `--target` argument to set the API endpoint rather than to set the environment variable here, however both methods are implemented. Use what works for you.
19-
3) `TARGET_AUDIENCE` - Variable which contains the "target audience" part of the authentication process for connecting with the GCP PFP API.
20-
4) `SAPATH` - Variable that sets path to your own Service Account JSON file for use in authorizing POSTs to the GCP PFP instance.
2114

2215
## Arguments
2316
Below are the arguments that can be used to run LDT. Initializing with all default values will yield a single post request from CSV file sent to a locally hosted API instance.
@@ -121,4 +114,15 @@ Options for configuring the JSON payload pulled from a user-specified CSV file.
121114
`--servAcc` `string`
122115
- Default: None
123116
- Enter the filepath to the Service Account file used to read from for OAuth2.0 authenticating POST requests to IAP-protected APIs.
124-
- When specified, overwrites 'SAPATH' environmental variable.
117+
- When specified, overwrites 'SAPATH' environmental variable.
118+
119+
## Environmental Variables
120+
1) `CSVPATH` - Filepath to a local CSV file.
121+
- The script checks for this on startup, as JSON content to send as a POST request is currently required. You can specify this filepath with the csv argument, or you can set the env var and specify a different filepath with the csv argument which will override the environment variable. A filepath must be specified if not using the `useGit` argument.
122+
123+
2) `PFP` - URL of the PFP API endpoint where the POST requests are sent.
124+
- It is likely faster to use the `--target` argument to set the API endpoint rather than to set the environment variable here, however both methods are implemented. Use what works for you.
125+
126+
3) `TARGET_AUDIENCE` - Variable which contains the "target audience" part of the authentication process for connecting with the GCP PFP API.
127+
128+
4) `SAPATH` - Variable that sets path to your own Service Account JSON file for use in authorizing POSTs to the GCP PFP instance.

0 commit comments

Comments
 (0)