Update readme

This commit is contained in:
Steven Polley 2020-05-29 22:16:34 -06:00
parent 343b49e596
commit 0a01dff5ff

View File

@ -13,15 +13,28 @@ go build .
### Usage ### Usage
Arguments of wafredir: Run the built executable from a terminal. Default arguments are used if not specifid
##### Arguments of wafredir:
-action string -action string
action can be either 'config' or 'test'. 'config' will read the input csv file and generate FortiOS compliant configuration to create redirection policies. 'test' will read the input csv file and validate that the redirects are actually working by making requests
at the source URL and validating a redirect to the destination URL actually occurs. (default "config") default (config): action can be either 'config' or 'test'. 'config' will read the input csv file and generate FortiOS compliant configuration to create redirection policies. 'test' will read the input csv file and validate that the redirects are actually working by making requests at the source URL and validating a redirect to the destination URL actually occurs.
-concurrentReq int -concurrentReq int
only used with the action 'test'. Determines the maximum number concurrent HTTP GET requests which can be in flight at any given time. (default 8)
default (8): only used with the action 'test'. Determines the maximum number concurrent HTTP GET requests which can be in flight at any given time.
-csvfile string -csvfile string
path to an input csv file. The first column of the file should be the source URL, the second column of the file should be the destination URL, and the third column should be the status code (for example 301 or 302). (default "redirects.csv") path to an input csv file. The first column of the file should be the source URL, the second column of the file should be the destination URL, and the third column should be the status code (for example 301 or 302). (default "redirects.csv")
##### Example Usage:
```shell
./wafredir -action="test" -concurrentReq 420 -csvfile "path/to/file.csv"
```
### Example input csv ### Example input csv
The first column is the source URL, the second column is the destination URL, the third column is the redirect type, must be either 301 or 302. The first column is the source URL, the second column is the destination URL, the third column is the redirect type, must be either 301 or 302.