Skip to content

Commit 13906c4

Browse files
committed
adjusted GB doc
1 parent 103dacd commit 13906c4

File tree

1 file changed

+9
-17
lines changed

1 file changed

+9
-17
lines changed

docs/GreedyBear/Installation.md

Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ The app administrator can enable/disable the extraction of source IPs for specif
3939
This is used for honeypots that are not specifically implemented to extract additional information (so not Log4Pot and Cowrie).
4040

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

4545
1. In `docker/env_file`, set the variable `ELASTIC_ENDPOINT` to `http://elasticsearch:9200`.
@@ -65,6 +65,14 @@ In the `env_file`, configure different variables as explained below.
6565
- `SLACK_TOKEN`: Slack token of your Slack application that will be used to send/receive notifications
6666
- `DEFAULT_SLACK_CHANNEL`: ID of the Slack channel you want to post the message to
6767

68+
## ElasticSearch compatibility.
69+
Greedybear leverages a [python client](https://elasticsearch-dsl.readthedocs.io/en/latest/) for interacting with ElasticSearch which requires to be at the exact major version of the related T-POT ElasticSearch instance.
70+
This means that there could problems if those versions do not match.
71+
72+
The actual version of the client installed is the 8.15.0 which allows to run TPOT version from 22.04.0 to 24.04.0 without any problems (and some later ones...we regularly check T-POT releases but we could miss one or two here.)
73+
74+
If you want to have compatibility with previous versions, you need to change the `elasticsearch-dsl` version [here](https://github.com/intelowlproject/GreedyBear/blob/main/requirements/project-requirements.txt) and [re-build](https://intelowlproject.github.io/docs/GreedyBear/Installation/#rebuilding-the-project-creating-custom-docker-build) locally the project.
75+
6876
## Update and Re-build
6977

7078
### Rebuilding the project / Creating custom docker build
@@ -86,19 +94,3 @@ $ docker pull intelowlproject/greedybear:prod # pull new docker images
8694
$ docker-compose down # stop and destroy the currently running GreedyBear containers
8795
$ docker-compose up # restart the GreedyBear application
8896
```
89-
90-
## Installer for TPot Instance
91-
92-
The file 'installer_on_tpot.sh' allows the automatic installation of Greedybear on an existing TPot instance.
93-
You can choose the type of Greedybear you want to install (http, https or local).
94-
The installer will either clone Greedybear to '/opt/GreedyBear' or if Greedybear exists on your system you need to input the absolute path to the existing Greedybear folder.
95-
It will prompt you for the necessary information/secrets needed.
96-
97-
Example: `sudo ./installer.sh --type=http --folder=/opt/GreedyBear`
98-
99-
<div class="admonition warning">
100-
<p class="admonition-title">Warning</p>
101-
This installer is not officialy supported neither by Greedybear nor by TPOT maintainers.
102-
It must be considered as a POC to have GB and TPOT installed in the same place.
103-
Greedybear is supported to be executed only in a separate instance and to connect externally with the TPOTs.
104-
</div>

0 commit comments

Comments
 (0)