Skip to content

Commit

Permalink
Change directions on configuring directories
Browse files Browse the repository at this point in the history
Update README
Update config.example.json
  • Loading branch information
binarymist committed Feb 27, 2021
1 parent 4324d85 commit e810ebb
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 5 deletions.
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,7 @@ npm install
Copy the config/config.example.json to config/config.local.json.
Use the config/config.js for documentation and further examples.

**`outcomes.dir`** Configure this value. This needs to be a directory of your choosing that both the orchestrator and app-scanner containers use. The `outcomes.dir` value should be the same as the testers `emissary.report.dir` and `results.dir` value. The directory you choose and configure needs group `rwx` permissions applied to it because the orchestrator and tester containers share the same group, they also read, write and delete outcome files within this directory.

**`testerFeedbackComms.medium`** Long Polling `lp` is supported in both `local` and `cloud` environments. Server Sent Events `sse` is only supported in the `local` environment due to AWS limitations. Both `lp` and `sse` are real-time. Both implementations have their pros and cons.

See the CLI documentation for further details around this value.
See the [CLI documentation](https://github.com/purpleteam-labs/purpleteam#configure) for further details around this value.

2 changes: 1 addition & 1 deletion config/config.example.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
}
},
"outcomes": {
"dir": "</absolute-path-to/purpleteam/outcomes/>"
"dir": "/var/log/purpleteam/outcomes/"
},
"testerFeedbackComms": {
"medium": "lp"
Expand Down
2 changes: 1 addition & 1 deletion config/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ const schema = {
},
outcomes: {
dir: {
doc: 'The directory that stores Tester results and Emissary reports. This directory needs group rwx permissions.',
doc: 'The directory that stores Tester results and Emissary reports.',
format: String,
default: '/var/log/purpleteam/outcomes/'
},
Expand Down

0 comments on commit e810ebb

Please sign in to comment.