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.

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

Docker Compose Edits for BloodHound CLI #997

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

Conversation

chrismaddalena
Copy link
Member

Description

This PR adds a name label to the containers and uncomments the bloodhound.config.json volume mounting by default. These changes enable some of the functionality built into the upcoming BloodHound CLI.

The most significant change here is using bloodhound.config.json by default. The CLI ensures the file is present, but someone could run into issues if they do not use the CLI. We have been discussing switching the getbhce link to pull down pre-built binaries so new users would download the CLI and run ./bloodhound-cli install to get started. I am unaware of any decision or movement on that. For now, I think this change will need some consideration.

Motivation and Context

The name labels allow human-identifiable names to be displayed alongside container information when BloodHound CLI's running command is used. It also makes it easier for someone to pull logs from a container (e.g., ./bloodhound-cli logs postgres).

How Has This Been Tested?

I have been testing the changes with the main branch and the current version of BloodHound CLI with Stephen Hinck and others. The changes do not impact the containers.

Screenshots (optional):

Example of the name labels in output:

$ ./bloodhound-cli running        
[+] Checking the status of Docker and the Compose plugin...
[+] Collecting list of running BloodHound containers...
[+] Found 3 running BloodHound containers

 Name            Container ID                                                     Image                                  Status               Ports
 ––––––––––––    ––––––––––––                                                     ––––––––––––                           ––––––––––––         ––––––––––––
 bhce_bloodhound d08a11f9cd5ce7a15a21d632601b979e65121bac1dd7055c10a77ac21a8f4fb7 docker.io/specterops/bloodhound:latest Up 5 hours           127.0.0.1:8080:8080 » 8080/tcp
 bhce_neo4j      30f4e3de52b5c719e195bd8ee880a96e927bafe824432be833682570f9f666e5 docker.io/library/neo4j:4.4            Up 5 hours (healthy) 127.0.0.1:7474:7474 » 7474/tcp, 127.0.0.1:7687:7687 » 7687/tcp, 7473/tcp
 bhce_postgres   17b18be3b847f19696d5f6336be738eb781a45b654e10480881b0ad25a1c6304 docker.io/library/postgres:16          Up 5 hours (healthy) 5432/tcp

Types of changes

  • Chore (a change that does not modify the application functionality)

Checklist:

@chrismaddalena chrismaddalena self-assigned this Dec 3, 2024
Copy link

github-actions bot commented Dec 3, 2024

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

@StephenHinck StephenHinck added the ticketed Ticket has been created internally for tracking label Dec 3, 2024
@chrismaddalena
Copy link
Member Author

I have read the CLA Document and I hereby sign the CLA

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ticketed Ticket has been created internally for tracking
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants