Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
belane committed Sep 1, 2022
1 parent 20aac10 commit 3c27c2b
Showing 1 changed file with 21 additions and 27 deletions.
48 changes: 21 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,62 +1,56 @@
# BloodHound Docker Ready to Use

[BloodHound](https://github.com/BloodHoundAD/BloodHound) Docker image out of the box, with collectors and [tons of custom queries](https://github.com/CompassSecurity/BloodHoundQueries/blob/master/customqueries.json). It creates a `bh-data` folder with the Ingestors, the data folder is also mounted as a volume, use this to drop your data and load it into the BloodHound GUI.

![bloodhound](https://user-images.githubusercontent.com/17031267/48985201-6f587a00-f105-11e8-8355-98e38e08cc5e.png)


## Run from Docker Hub
```
docker run -it \
-p 7474:7474 \
-e DISPLAY=unix$DISPLAY \
-v /tmp/.X11-unix:/tmp/.X11-unix \
--device=/dev/dri:/dev/dri \
-v $(pwd)/data:/data \
-v $(pwd)/bh-data:/data \
--name bloodhound belane/bloodhound
```

**Warning:** You may need to run `xhost +local:$(id -nu)` to allow the local user to access DISPLAY.

## Build Image
### Build

`docker build . -t bloodhound`

### Build with example data
`docker build . -t bloodexample --build-arg data=example`
### Optional Arguments

- **neo4j** version
- **bloodhound** version

`docker build . -t bloodhound --build-arg neo4j=3.4.8 --build-arg bloodhound=2.1.0`
`docker build . -t bloodhound --build-arg neo4j=4.4.10 --build-arg bloodhound=4.2.0`

### Run

## Run
```
docker run -it \
-p 7474:7474 \
-e DISPLAY=unix$DISPLAY \
-v /tmp/.X11-unix:/tmp/.X11-unix \
--device=/dev/dri:/dev/dri \
-v ~/Desktop/bloodhound/data:/data \
-v $(pwd)/bh-data:/data \
--name bloodhound bloodhound
```
### Run with example data
```
docker run -it \
-e DISPLAY=unix$DISPLAY \
-v /tmp/.X11-unix:/tmp/.X11-unix \
--device=/dev/dri:/dev/dri \
-v ~/Desktop/bloodhound/data:/data \
--name bloodexample bloodexample
```

### Start container
```
docker start bloodhound
```
## Start container

## Use
Login:
- **Database URL:** bolt://localhost:7687
`docker start bloodhound`

## Database Login

- **DB URL:** bolt://localhost:7687
- **DB Username:** neo4j
- **DB Password:** blood

There is a `bloodhound/data` folder in your Desktop with the Ingestors.
data folder is also mounted as volume, use it to drop your data and load it in BloodHound GUI.

## Documentation
https://github.com/BloodHoundAD/BloodHound/wiki

[Official BloodHound Documentation](https://bloodhound.readthedocs.io/en/latest/index.html)

0 comments on commit 3c27c2b

Please sign in to comment.