You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: readme.md
+12-8Lines changed: 12 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,13 +11,6 @@ Continue reading for details on making use of LDT to test APIs.
11
11
12
12
# Leakdown Tester User Manual
13
13
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.
21
14
22
15
## Arguments
23
16
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.
121
114
`--servAcc``string`
122
115
- Default: None
123
116
- 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