Skip to content

Fix/BED-7996 improve first time setup#2

Merged
ktstrader merged 11 commits intomainfrom
fix/BED-7996-improve-first-time-setup
May 1, 2026
Merged

Fix/BED-7996 improve first time setup#2
ktstrader merged 11 commits intomainfrom
fix/BED-7996-improve-first-time-setup

Conversation

@ktstrader
Copy link
Copy Markdown
Contributor

Description

Separated bloodhound-enterprise and bloodhound-community config 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 as

  1. Copy bloodhound-enterprise and bloodhound-community folders and place them in $HOME
  2. Fill out auth keys, IDs or anything else required by the images
  3. Run docker compose pull
  4. Run docker compose up -d

Motivation 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

  • Chore (a change that does not modify the application functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Copy link
Copy Markdown
Member

@juggernot325 juggernot325 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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}`.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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`
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I get why we're doing this, but having to update this with each release seems like it will be a future headache.

Comment on lines +4 to +5
token_key = "client_token_key"
token_id = "client_token_id"
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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]
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@ktstrader ktstrader merged commit 31a4dd2 into main May 1, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants