Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed name file #33

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fixed name file #33

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,27 +49,27 @@ geolocate_key: <GEOLOCATE_API_KEY>

### A Basic Command

`python3 Goreport.py --id 26 --format excel`
`python3 GoReport.py --id 26 --format excel`

That would fetch the results of campaign 26 from https://localhost:3333/api/campaigns/26/?api_key=<Your_API_Key> and output the results to an xlsx file.

Multiple IDs can be provided at one time for multiple reports. The IDs can be provided using a comma-separated list, a range, or both.

Example: `python3 Goreport.py --id 26,29-33,54 --format csv`
Example: `python3 GoReport.py --id 26,29-33,54 --format csv`

### Changing Config Files

If you use multiple Gophish user accounts or servers, then you will have multiple API keys. To make it easier to switch between keys, Goreport's `--config` option enables you to override the default config file, gophish.config, with a config file you name. If this argument is provided with a valid, readable config file, Goreport will use it instead of gophish.config to setup the API connections.

You might use this option if you have, for example, three phishing servers running Gophish. You could setup three config files, each with a different Gophish API key, and then use them as needed.

Example: `python3 Goreport.py --id 26,29-33,54 --format csv --config phish_server_2.config`
Example: `python3 GoReport.py --id 26,29-33,54 --format csv --config phish_server_2.config`

### Combining Reports

If you ran multiple campaigns using the same settings for different target groups, you may wish to run Goreport against these campaigns all at once and then combine the results into one report. This can be accomplished by adding Goreports `--combine` flag.

Example: `python3 Goreport.py --id 26,29-33,54 --format excel --combine`
Example: `python3 GoReport.py --id 26,29-33,54 --format excel --combine`

This command would collect the results for campaigns 26, 29, 30, 31, 32, 33, and 54. Normally, Goreport would output seven xlsx files, but the addition of `--combine` tells Goreport to combine the results and output just one report as if they were all one large campaign.

Expand Down