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

[docs] add emphasis on configuring rabbitmq postgres minio (#89) #95

Merged
merged 5 commits into from
Jan 31, 2025
Merged
Changes from 3 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
44 changes: 30 additions & 14 deletions docs/deployment/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,16 +81,16 @@ MINIO_ROOT_USER=ChangeMeAccess
MINIO_ROOT_PASSWORD=ChangeMeKey
RABBITMQ_DEFAULT_USER=ChangeMe
RABBITMQ_DEFAULT_PASS=ChangeMe
SPRING_MAIL_HOST=smtp.changeme.com
SPRING_MAIL_HOST=smtp.example.com
RomuDeuxfois marked this conversation as resolved.
Show resolved Hide resolved
SPRING_MAIL_PORT=465
SPRING_MAIL_USERNAME=ChangeMe@domain.com
SPRING_MAIL_USERNAME=ChangeMe@example.com
SPRING_MAIL_PASSWORD=ChangeMe
OPENBAS_MAIL_IMAP_ENABLED=true
OPENBAS_MAIL_IMAP_HOST=imap.changeme.com
OPENBAS_MAIL_IMAP_HOST=imap.example.com
OPENBAS_MAIL_IMAP_PORT=993
OPENBAS_ADMIN_EMAIL=ChangeMe@domain.com # Should be a valid email address
OPENBAS_ADMIN_EMAIL=ChangeMe@example.com # must be a valid email address
OPENBAS_ADMIN_PASSWORD=ChangeMe
OPENBAS_ADMIN_TOKEN=ChangeMe # Should be a valid UUI
OPENBAS_ADMIN_TOKEN=ChangeMe # must be a valid UUID
COLLECTOR_MITRE_ATTACK_ID=3050d2a3-291d-44eb-8038-b4e7dd107436 # No need for change
COLLECTOR_ATOMIC_RED_TEAM_ID=0f2a85c1-0a3b-4405-a79c-c65398ee4a76 # No need for change
```
Expand Down Expand Up @@ -214,12 +214,18 @@ OpenBAS will use the red user.

#### Installation of dependencies

You have to install all the needed dependencies for the main application if you would like to play breach and attack
simulation scenarios. The example below is for Ubuntu:
You have to install all the mandatory dependencies for the main application if you would like to play breach and attack
simulation scenarios.
You need at least Java 22, RabbitMQ, MinIO (for object storage) and PostgreSQL (database). See the [Dependencies section](overview.md#dependencies)
for details on the recommended (and supported) versions of the dependencies.

The example below is for Ubuntu 24.04 LTS (not guaranteed to yield the recommended versions):
antoinemzs marked this conversation as resolved.
Show resolved Hide resolved

```bash
sudo apt install openjdk-22-jre
# Install Java 22, RabbitMQ and Postgres 16
antoinemzs marked this conversation as resolved.
Show resolved Hide resolved
sudo apt install openjdk-22-jre rabbitmq-server postgresql-16
```
Additionally, instructions to install MinIO for your platform can be found on the [MinIO website](https://min.io/docs).

#### Download the application files

Expand All @@ -235,14 +241,24 @@ tar xvfz openbas-release-{RELEASE_VERSION}.tar.gz

#### Configure the application

The main application has just one environment configuration file to change.
You may change the `application.properties` file (located at the root of the extracted release archive)
antoinemzs marked this conversation as resolved.
Show resolved Hide resolved
according to your needs; alternatively you may set the equivalent environment variables.

```bash
cd openbas
```shell
$ cd openbas
$ ls
application.properties openbas-api.jar
```

Change the *application.properties* file according to your configuration of PostgreSQL, RabbitMQ, Minio and to your
platform.
!!! note "Mandatory configuration"

Note that the configuration keys relevant to the mandatory dependencies listed above must be set in the file or as environment variables.

See the Configuration section for more details:

- [PostgreSQL](configuration.md#postgresql)
- [RabbitMQ](configuration.md#rabbitmq)
- [MinIO](configuration.md#s3-bucket)

#### Start the application
antoinemzs marked this conversation as resolved.
Show resolved Hide resolved

Expand Down Expand Up @@ -273,7 +289,7 @@ java -jar openbas-api.jar

### Deploy behind a reverse proxy

If you want to use OpenBAS behind a reverse proxy with a context path, like `https://domain.com/openbas`, please change
If you want to use OpenBAS behind a reverse proxy with a context path, like `https://example.com/openbas`, please change
the `base_path` static parameter.

- `APP__BASE_PATH=/openbas`
Expand Down