Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 61 additions & 11 deletions docs/openhound/community.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: "Learn about the OpenHound framework for BHCE."

In BloodHound Community Edition, you can run OpenHound as a standalone CLI application to execute built-in collectors or community-built collectors. You can configure OpenHound with environment variables, configuration files, or both. See the [configuration](/openhound/configuration) page to set up OpenHound.

## Installing the OpenHound CLI
## Install the OpenHound CLI

OpenHound is typically installed and executed inside a dedicated Python virtual environment. We recommend using a Python
package and project manager such as [uv](https://docs.astral.sh/uv/) to manage the virtual environment and dependencies.
Expand All @@ -24,19 +24,69 @@ additional packages that can be installed along with the core OpenHound package:

- Okta
- Jamf
- Github
- GitHub

You can specify which collector(s) to include by adding the collector name as an extra dependency with the install
command. You can specify one or more collectors by separating them with a comma.

For example, to install OpenHound with
the Okta, Jamf, and Github collectors, run the following command:

```bash
uv tool install "openhound[okta,jamf,github]"
```

<Tip>Use the `openhound[all]` alias to install all the built-in collectors.</Tip>
Choose the install command that matches the collectors you want to use:

<Tabs>
<Tab title="All built-in collectors" icon="layer-group">
Install OpenHound with every built-in collector:

```bash
uv tool install "openhound[all]"
```
</Tab>
<Tab title="Specific collectors" icon="sliders">
Install OpenHound with only the collectors you need. For example, to install the Okta, Jamf, and GitHub collectors:

```bash
uv tool install "openhound[okta,jamf,github]"
```
</Tab>
</Tabs>

## Upgrade the OpenHound CLI

When you install OpenHound with `uv`, the CLI runs from an isolated tool environment that stays on your system until you replace or upgrade it.

<Tip>
If a newer OpenHound release is available, we recommend upgrading the installed tool before you troubleshoot version-specific issues.
</Tip>

<Steps>
<Step title="Upgrade the installed OpenHound tool">
Run the following command:

```bash
uv tool upgrade openhound
```

This upgrades the existing OpenHound tool environment to the latest compatible release.
</Step>
<Step title="Reinstall collectors">
After upgrading the OpenHound CLI, reinstall the collectors to get the latest versions:

<Tabs>
<Tab title="All built-in collectors" icon="layer-group">
Reinstall every built-in collector:

```bash
uv tool install "openhound[all]"
```
</Tab>
<Tab title="Specific collectors" icon="sliders">
Reinstall only the collectors you use. For example:

```bash
uv tool install "openhound[okta,jamf,github]"
```
</Tab>
</Tabs>
</Step>
</Steps>

## CLI Commands

Expand Down Expand Up @@ -85,4 +135,4 @@ The following command converts the collected Okta resources from the `./output/o
openhound convert okta ./output/okta ./graph/okta
```

<Note>OpenHound will automatically split each graph into multiple files based on source node and chunk size to optimize file uploads for BloodHound.</Note>
<Note>OpenHound will automatically split each graph into multiple files based on source node and chunk size to optimize file uploads for BloodHound.</Note>
Loading