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
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
12 changes: 12 additions & 0 deletions examples/docker-compose/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,11 @@ what ports different services run on and what credentials should be used):
- `bloodhound.config.json`: Configuration file used by the BloodHound API server. This example is a direct copy of the one included
in the official `bloodhound` docker image to be used as a starting point for modifying the configuration. If you want to change
database credentials, you'll need to update them here as well so `bloodhound` will know how to connect to them.
- To utilize this file you must also uncomment the following lines in `docker-compose.yml`:
```
volumes:
- ./bloodhound.config.json:/bloodhound.config.json:ro
```
- `.env.example`: Copying this file to `.env` in the same directory as your `docker-compose.yml` will allow you to change
the environment variables easily. Changes to database credentials here will need to be reflected in the `bloodhound.config.json`.

Expand Down Expand Up @@ -140,3 +145,10 @@ A: By default, we generate a secure random 256-bit key for JWT signing. Because
any existing sessions will be invalidated. If you need sessions to survive a server restart, there is a configuration
value available that will allow you to specify your own `base64` encoded 256-bit key. It is recommended that you configure
this when running Bloodhound on a standalone server, alongside other security configurations.

### Q: "My configuration changes in bloodhound.config.json are being ignored. Why?"

A: A copy of this file is already included within the Docker container by default. The BloodHound instance will continue to use
that file until you copy your local version into the Docker container. This can be done by uncommenting the lines in the
`docker-compose.yml` file as specified in [this section](#configuring-bloodhound-community-edition). This requires a restart of
the Docker environment using the commands `docker compose down` and following with `docker compose up`.
Loading