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

Update README.md: Error Handling & Deployment Experience Video #401

Merged
Changes from 1 commit
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
27 changes: 23 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,33 @@ original BloodHound was created by [@_wald0](https://www.twitter.com/_wald0), [@

The easiest way to get up and running is to use our pre-configured Docker Compose setup. The following steps will get BloodHound CE up and running with the least amount of effort.

1. Install Docker Compose. This should be included with the [Docker Desktop](https://www.docker.com/products/docker-desktop/) installation
2. Run `curl -L https://ghst.ly/getbhce | docker compose -f - up`
3. Locate the randomly generated password in the terminal output of Docker Compose
4. In a browser, navigate to `http://localhost:8080/ui/login`. Login with a username of `admin` and the randomly generated password from the logs
1. Install Docker Compose and ensure Docker is running. This should be included with the [Docker Desktop](https://www.docker.com/products/docker-desktop/) installation
3. Run `curl -L https://ghst.ly/getbhce | docker compose -f - up`
StephenHinck marked this conversation as resolved.
Show resolved Hide resolved
4. Locate the randomly generated password in the terminal output of Docker Compose
5. In a browser, navigate to `http://localhost:8080/ui/login`. Login with a username of `admin` and the randomly generated password from the logs

NOTE: going forward, the default `docker-compose.yml` example binds only to localhost (127.0.0.1). If you want to access BloodHound outside of localhost,
you'll need to follow the instructions in [examples/docker-compose/README.md](examples/docker-compose/README.md) to configure the host binding for the container.

## Installation Error Handling

<i> Affects: Windows Users </i>

- If you encounter a "failed to get console mode for stdin: The handle is invalid." ensure Docker Desktop (and associated Engine is running). Docker Desktop does not automatically register as a startup entry. <img width="302" alt="image" src="https://github.com/kaydaskalakis/BloodHoundCE/assets/8494920/4ff6f784-b60d-4b59-821d-d3d351f6df3b">
StephenHinck marked this conversation as resolved.
Show resolved Hide resolved

- If you encounter an "Error response from daemon: Ports are not available: exposing port TCP 127.0.0.1:7474 -> 0.0.0.0:0: listen tcp 127.0.0.1:7474: bind: Only one usage of each socket address (protocol/network address/port) is normally permitted." this is normally attributed to the "Neo4J Graph Database - neo4j" service already running on your local system. Please stop or delete the service to continue.

```
# Verify if Docker Engine is Running
docker info

# Attempt to stop Neo4j Service if running
Stop-Service "Neo4j" -ErrorAction SilentlyContinue
```
- A succesfull installation of BloodHound CE would look like below:

https://github.com/kaydaskalakis/BloodHoundCE/assets/8494920/537b346d-0451-4c39-898f-da5a57575272
StephenHinck marked this conversation as resolved.
Show resolved Hide resolved

## Useful Links

- [BloodHound Slack](https://ghst.ly/BHSlack)
Expand Down
Loading