Skip to content

Commit

Permalink
updated GB installation doc
Browse files Browse the repository at this point in the history
  • Loading branch information
mlodic committed Sep 3, 2024
1 parent 6169681 commit e689604
Showing 1 changed file with 14 additions and 7 deletions.
21 changes: 14 additions & 7 deletions docs/GreedyBear/Installation.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
# Installation

## Requirements
For requirements, please refer to [IntelOwl requirements](https://intelowlproject.github.io/docs/IntelOwl/installation/#requirements) which are the same

Note that GreedyBear _needs_ a running instance of ElasticSearch of a T-POT to function. In `docker/env_file`, set the variable `ELASTIC_ENDPOINT` with the URL of your Elasticsearch T-POT.

If you don't have one, you can make the following changes to make GreeyBear spin up it's own ElasticSearch instance.
(...Care! This option would require enough RAM to run the additional containers. Suggested is >=16GB):

1. In `docker/env_file`, set the variable `ELASTIC_ENDPOINT` to `http://elasticsearch:9200`.
2. Add `:docker/elasticsearch.yml` to the last defined `COMPOSE_FILE` variable or uncomment the `# local development with elasticsearch container` block in `.env` file.


## Installation steps

Start by cloning the project

```bash
Expand Down Expand Up @@ -38,13 +52,6 @@ docker exec -ti greedybear_uwsgi python3 manage.py createsuperuser
The app administrator can enable/disable the extraction of source IPs for specific honeypots from the Django Admin.
This is used for honeypots that are not specifically implemented to extract additional information (so not Log4Pot and Cowrie).

Note that GreedyBear _needs_ a running instance of ElasticSearch of a TPoT to function.
If you don't have one, you can make the following changes to make GreeyBear spin up it's own ElasticSearch instance.
(...Care! This option would require enough RAM to run the additional containers. Suggested is >=16GB):

1. In `docker/env_file`, set the variable `ELASTIC_ENDPOINT` to `http://elasticsearch:9200`.
2. Add `:docker/elasticsearch.yml` to the last defined `COMPOSE_FILE` variable or uncomment the `# local development with elasticsearch container` block in `.env` file.

### Environment configuration

In the `env_file`, configure different variables as explained below.
Expand Down

0 comments on commit e689604

Please sign in to comment.