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

Refresh the BloodHound quickstarts #1090

Merged
merged 1 commit into from
Jan 22, 2025

Conversation

sblotner
Copy link
Contributor

As part of the Mintlify doc revamp, this PR:

  • Updates the introduction and getting started content based on CJ’s experience testing/onboarding to BloodHound
  • Deletes duplicate pages
  • Fixes the glossary intra-doc links

Motivation and Context

This PR addresses: #1085

Testing

Tested locally with Mintlify for broken links and site rendering

Types of changes

  • Chore
  • Docs

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

```

``` bash Windows CMD
curl -L https://ghst.ly/getbhce > .\docker-compose.yml
Copy link
Contributor Author

Choose a reason for hiding this comment

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

? Can we change this to: curl -L https://ghst.ly/getbhce | docker compose -f - up

Copy link
Contributor

Choose a reason for hiding this comment

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

The comment below for the same question applies here, but additionally, the piped command does not work consistently for Windows like this, hence the change.


<CodeGroup>
```bash Linux/MAC
curl -L https://ghst.ly/getbhce > .\docker-compose.yml
Copy link
Contributor Author

Choose a reason for hiding this comment

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

? Can we change this to: curl -L https://ghst.ly/getbhce | docker compose -f - up

Copy link
Contributor

Choose a reason for hiding this comment

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

I would actually recommend we move this section to point towards using https://github.com/SpecterOps/bloodhound-cli instead.

We changed how the docs were structured away from the CURL one-liner because many of our users thought that they could use that instruction repeatedly and always maintain access to the latest version of BloodHound. Unfortunately, because of how Docker image library caching works, this would mean that customers would repeatedly use the same, originally downloaded version for later deployments. It also meant that customers who wanted to customize the deployments had a more complex time doing so.

@StephenHinck StephenHinck merged commit c86f9de into SpecterOps:main Jan 22, 2025
5 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Jan 22, 2025
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