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

Clarify configuration process in documentation #549

Merged
merged 1 commit into from
Apr 11, 2024

Conversation

juggernot325
Copy link
Contributor

Description

This PR adds some additional verbiage to the examples/README.md file on how to configure BloodHound using the bloodhound.config.json file. Issue #207 highlighted that this is not clear in the previous version of the README as it was only documented in the docker-compose.yml file.

Motivation and Context

  • Avoid confusion when configuring BloodHound

How Has This Been Tested?

  • Verified the steps documented correctly apply the desired changes

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)

Checklist:

  • Documentation updates are needed, and have been made accordingly.
  • I have added and/or updated tests to cover my changes.
  • All new and existing tests passed.
  • My changes include a database migration.

@urangel urangel self-assigned this Apr 11, 2024
@juggernot325 juggernot325 merged commit 95b2d24 into main Apr 11, 2024
3 checks passed
@juggernot325 juggernot325 deleted the config-readme-updates branch April 11, 2024 15:21
@github-actions github-actions bot locked and limited conversation to collaborators Apr 11, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants