Conversation
… and set up example .dlt config folders
… in the documentations
… sure .dlt exists, updated docker-compose.yml to include github and okta along with jamf, redeuced volume and secrets by adding per-collector YAML anchors, similar to how the x-cli anchor works
… example-configurations, added READMEs to both folders for quick start
juggernot325
left a comment
There was a problem hiding this comment.
I requested a few minor changes inline, but one other thing I think would be useful to add here is a call out in the overall project README to check out the newly added example-configurations for a quick start.
| @@ -0,0 +1,16 @@ | |||
| ## Quick-start | |||
|
|
|||
| 1. Copy the contents from `bloodhound-enterprise` folder to `${HOME}`. | |||
There was a problem hiding this comment.
This part was confusing as I walked through it. By default on Mac, running cp ./* ~/ didn't copy the .dlt folder, which I think is the main thing we care about here. Maybe we can make this more explicit, like "Copy .dlt-example to ${HOME}/.dlt". We could then remove this step from item 2.
| 1. Copy the contents from `bloodhound-enterprise` folder to `${HOME}`. | ||
| 2. Rename `.dlt-example` to `.dlt` and fill in your credentials in the toml files. | ||
| 3. Place any required key files (github.pem, okta.json) in `${HOME}/.dlt`. | ||
| 4. Pull image from SpecterOps Docker Hub: `docker pull specterops/openhound:0.1.1-enterprise` |
There was a problem hiding this comment.
I get why we're doing this, but having to update this with each release seems like it will be a future headache.
| token_key = "client_token_key" | ||
| token_id = "client_token_id" |
There was a problem hiding this comment.
The BHE UI puts the ID first and key second, we should put them in that order, too, for consistency.
| @@ -0,0 +1,13 @@ | |||
| # Example configuration for bhe secrets: https://bloodhound.specterops.io/openhound/enterprise#full-configuration-example | |||
| [destination.bloodhoundenterprise] | |||
There was a problem hiding this comment.
I talked with @d3vzer0 and he said we should be able to keep this in the config.toml if it's the same for all collectors. I think that will be the default for most customers, so let's move it there to avoid having to set it in multiple places.
Description
Separated
bloodhound-enterpriseandbloodhound-communityconfig set ups to help with user setup so they can go to either and copy the example .dlt folders and fill out the information. They can also copy the docker-compose.yml and run that directly as well. Everything is as simple asbloodhound-enterpriseandbloodhound-communityfolders and place them in $HOMEdocker compose pulldocker compose up -dMotivation and Context
Want to make the setup process easier for the user
Resolves: BED-7996
How Has This Been Tested?
Screenshots (if appropriate):
Types of changes