Skip to content

Commit

Permalink
updated greedybear doc
Browse files Browse the repository at this point in the history
  • Loading branch information
mlodic committed Aug 28, 2024
1 parent 940b99a commit 5c6a89d
Show file tree
Hide file tree
Showing 6 changed files with 2 additions and 43 deletions.
2 changes: 1 addition & 1 deletion docs/GreedyBear/Contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## General Guidance

Please refer to [IntelOwl Documentation](https://intelowl.readthedocs.io/en/latest/) for everything missing here.
Please refer to [IntelOwl Documentation](https://intelowlproject.github.io/docs/IntelOwl/introduction/) for everything missing here.

## Rules

Expand Down
18 changes: 0 additions & 18 deletions docs/GreedyBear/Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ cp .env_template .env
cd docker/
cp env_file_template env_file
cp env_file_postgres_template env_file_postgres
cd ..
cp frontend/public/env_template.js frontend/public/env.js
```

Now you can start by building the image using docker-compose and run the project.
Expand Down Expand Up @@ -67,22 +65,6 @@ In the `env_file`, configure different variables as explained below.
- `SLACK_TOKEN`: Slack token of your Slack application that will be used to send/receive notifications
- `DEFAULT_SLACK_CHANNEL`: ID of the Slack channel you want to post the message to

#### Recaptcha configuration

The Registration Page and the Login Page contain a Recaptcha form from Google. By default, that Recaptcha is not configured and is not shown.
If your intention is to publish GreedyBear as a Service you should configure different variables as explained below.

In the `frontend/public/env.js` set the variable:

- `RECAPTCHA_SITEKEY`: Recaptcha Key for your site

In the `docker/env_file` set the variables:

- `RECAPTCHA_SECRET_KEY_GB_LOCAL`: your recaptcha secret key internal deployment
- `RECAPTCHA_SECRET_KEY_GB_PUBLIC`: your recaptcha secret key for public deployment

In that case, you would need to [re-build](/Installation.md#update-and-rebuild) the application to have the changes properly reflected.

## Update and Re-build

### Rebuilding the project / Creating custom docker build
Expand Down
4 changes: 0 additions & 4 deletions docs/GreedyBear/Usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,6 @@ If you have GreedyBear deployed on an AWS instance you can use the SES service.

In a development environment the emails that would be sent are written to the standard output.

### Recaptcha configuration

The Registration Page contains a Recaptcha form from Google. By default, that Recaptcha is not configured and is not shown.
If your intention is to publish GreedyBear as a Service you should [configure the Recaptcha](/Installation.md#recaptcha-configuration).

### Amazon SES

Expand Down
11 changes: 0 additions & 11 deletions docs/IntelOwl/advanced_usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,17 +51,6 @@ To have the "Registration" page to work correctly, you must configure some varia

In a development environment the emails that would be sent are written to the standard output.

#### Recaptcha configuration

The Registration Page contains a Recaptcha form from Google. By default, that Recaptcha is not configured and is not shown.

If your intention is to publish IntelOwl as a Service you should first remember to comply to the [AGPL License](https://github.com/intelowlproject/IntelOwl/blob/master/LICENSE).

Then you need to add the generated Recaptcha Secret in the `RECAPTCHA_SECRET_KEY` value in the `env_file_app` file.

Afterwards you should configure the Recaptcha Key for your site and add that value in the `RECAPTCHA_SITEKEY` in the `frontend/public/env.js` file.
In that case, you would need to [re-build](/Installation.md#update-and-rebuild) the application to have the changes properly reflected.

## Optional Analyzers

Some analyzers which run in their own Docker containers are kept disabled by default. They are disabled by default to prevent accidentally starting too many containers and making your computer unresponsive.
Expand Down
8 changes: 0 additions & 8 deletions docs/IntelOwl/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,14 +134,6 @@ Configuration required to enable integration with Slack:
- `SLACK_TOKEN`: Slack token of your Slack application that will be used to send/receive notifications
- `DEFAULT_SLACK_CHANNEL`: ID of the Slack channel you want to post the message to

Configuration required to enable Re-Captcha in the Login and the Registration Page:
In the `docker/env_file_app`:

- `USE_RECAPTCHA`: if you want to use recaptcha on your login
- `RECAPTCHA_SECRET_KEY`: your recaptcha secret key
In the `frontend/public/env.js`:
- `RECAPTCHA_SITEKEY`: Recaptcha Key for your site

Configuration required to have InteOwl sending Emails (registration requests, mail verification, password reset/change, etc)

- `DEFAULT_FROM_EMAIL`: email address used for automated correspondence from the site manager (example: `[email protected]`)
Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ nav:
- GreedyBear:
- Introduction: "GreedyBear/Introduction.md"
- Installation: "GreedyBear/Installation.md"
- Usage.md: "GreedyBear/Usage.md"
- Usage: "GreedyBear/Usage.md"
- Contribute: "GreedyBear/Contribute.md"
- API docs: "GreedyBear/Api-docs.md"
- PyIntelOwl:
Expand Down

0 comments on commit 5c6a89d

Please sign in to comment.