Skip to content

Commit abc8dd6

Browse files
authored
Renaming to openaev
1 parent e41c1e9 commit abc8dd6

File tree

7 files changed

+100
-100
lines changed

7 files changed

+100
-100
lines changed

.env.sample

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ RABBITMQ_DEFAULT_PASS=ChangeMe
1313
# ElasticSearch Configuration
1414
ELASTIC_MEMORY_SIZE=4G
1515

16-
# OpenBAS General Configuration
17-
OPENBAS_BASE_URL=http://localhost:8080
18-
OPENBAS_ADMIN_EMAIL= # [email protected]
19-
OPENBAS_ADMIN_PASSWORD= # ChangeMe
20-
OPENBAS_ADMIN_TOKEN=00000000-0000-0000-0000-000000000000 # [MANDATORY] Replace with a valid UUIDv4
21-
OPENBAS_HEALTHCHECK_KEY=ChangeMe
16+
# OpenAEV General Configuration
17+
OPENAEV_BASE_URL=http://localhost:8080
18+
OPENAEV_ADMIN_EMAIL= # [email protected]
19+
OPENAEV_ADMIN_PASSWORD= # ChangeMe
20+
OPENAEV_ADMIN_TOKEN=00000000-0000-0000-0000-000000000000 # [MANDATORY] Replace with a valid UUIDv4
21+
OPENAEV_HEALTHCHECK_KEY=ChangeMe
2222

2323
# Spring Mail Configuration
2424
SPRING_MAIL_HOST=smtp.gmail.com
@@ -29,19 +29,19 @@ SPRING_MAIL_PROPERTIES_MAIL_SMTP_AUTH=true
2929
SPRING_MAIL_PROPERTIES_MAIL_SMTP_SSL_ENABLE=false
3030
SPRING_MAIL_PROPERTIES_MAIL_SMTP_STARTTLS_ENABLE=true
3131

32-
# OpenBAS IMAP Configuration
33-
OPENBAS_MAIL_IMAP_ENABLED=false
34-
OPENBAS_MAIL_IMAP_HOST=imap.changeme.com
35-
OPENBAS_MAIL_IMAP_PORT=993
36-
OPENBAS_MAIL_IMAP_AUTH=true
37-
OPENBAS_MAIL_IMAP_SSL_ENABLE=true
38-
OPENBAS_MAIL_IMAP_STARTTLS_ENABLE=false
32+
# OpenAEV IMAP Configuration
33+
OPENAEV_MAIL_IMAP_ENABLED=false
34+
OPENAEV_MAIL_IMAP_HOST=imap.changeme.com
35+
OPENAEV_MAIL_IMAP_PORT=993
36+
OPENAEV_MAIL_IMAP_AUTH=true
37+
OPENAEV_MAIL_IMAP_SSL_ENABLE=true
38+
OPENAEV_MAIL_IMAP_STARTTLS_ENABLE=false
3939

4040
# Collector MITRE ATT&CK Configuration
4141
COLLECTOR_MITRE_ATTACK_ID=3050d2a3-291d-44eb-8038-b4e7dd107436
4242

43-
# Collector OpenBAS Datasets Configuration
44-
COLLECTOR_OPENBAS_ID=63544750-19a1-435f-ada4-b44e39cf3cdb
43+
# Collector OpenAEV Datasets Configuration
44+
COLLECTOR_OPENAEV_ID=63544750-19a1-435f-ada4-b44e39cf3cdb
4545

4646
# Collector Atomic Red Team Configuration
4747
COLLECTOR_ATOMIC_RED_TEAM_ID=c34e3f19-e0b9-45cb-83e0-3b329e4c53d3

.github/workflows/release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ jobs:
2323
- name: checkout repo content
2424
uses: actions/checkout@v4
2525
with:
26-
repository: OpenBAS-Platform/docker
26+
repository: OpenAEV-Platform/docker
2727
# Replace all the occurrences of '{0}' with '42' in the README.md file
2828
- name: Find and Replace
2929
uses: jacobtomlinson/gha-find-replace@v3

README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
1-
# OpenBAS Docker Deployment
1+
# OpenAEV Docker Deployment
22

3-
Welcome to the OpenBAS Docker deployment guide! This guide provides resources and information to help you deploy and
4-
manage OpenBAS using Docker.
3+
Welcome to the OpenAEV Docker deployment guide! This guide provides resources and information to help you deploy and
4+
manage OpenAEV using Docker.
55

66
---
77

88
## 📚 Documentation
99

10-
For detailed instructions on installing OpenBAS using Docker, refer to
11-
the [OpenBAS documentation space](https://docs.openbas.io/latest/deployment/installation/#using-docker).
10+
For detailed instructions on installing OpenAEV using Docker, refer to
11+
the [OpenAEV documentation space](https://docs.openaev.io/latest/deployment/installation/#using-docker).
1212

1313
---
1414

1515
## 👥 Community
1616

1717
### 🛠️ Status & Bugs
1818

19-
OpenBAS is actively under development. If you encounter bugs, have feature requests, or need help, please report them
20-
using the [GitHub Issues module](https://github.com/OpenBAS-Platform/openbas/issues). We appreciate your feedback and
19+
OpenAEV is actively under development. If you encounter bugs, have feature requests, or need help, please report them
20+
using the [GitHub Issues module](https://github.com/OpenAEV-Platform/openaev/issues). We appreciate your feedback and
2121
contributions to improve the platform.
2222

2323
### 💬 Discussions
@@ -32,34 +32,34 @@ Join our community to engage in discussions, share ideas, and get support:
3232

3333
### Quick Start with Docker Compose
3434

35-
The OpenBAS stack is modular and uses multiple Docker Compose files for easier configuration:
35+
The OpenAEV stack is modular and uses multiple Docker Compose files for easier configuration:
3636

3737
> [!IMPORTANT]
3838
> Remember to create a .env file from .env.sample and customize the configuration as needed.
3939
40-
To start OpenBAS with the essential services, run:
40+
To start OpenAEV with the essential services, run:
4141
```bash
42-
docker compose -p openbas -f docker-compose.yml up -d
42+
docker compose -p openaev -f docker-compose.yml up -d
4343
```
4444

45-
To start OpenBAS with the Caldera executor (Caldera used as an agent), run:
45+
To start OpenAEV with the Caldera executor (Caldera used as an agent), run:
4646
```bash
47-
docker compose -p openbas -f docker-compose.yml -f docker-compose.caldera.yml -f docker-compose.caldera-executor.yml up -d
47+
docker compose -p openaev -f docker-compose.yml -f docker-compose.caldera.yml -f docker-compose.caldera-executor.yml up -d
4848
```
4949

50-
To start OpenBAS with the Caldera injector (Caldera used as an implant), run:
50+
To start OpenAEV with the Caldera injector (Caldera used as an implant), run:
5151
```bash
52-
docker compose -p openbas -f docker-compose.yml -f docker-compose.caldera.yml -f docker-compose.caldera-injector.yml up -d
52+
docker compose -p openaev -f docker-compose.yml -f docker-compose.caldera.yml -f docker-compose.caldera-injector.yml up -d
5353
```
5454

5555
#### Build Your Own Stack
56-
OpenBAS allows you to customize your stack by selecting specific collectors and injectors to meet your unique needs:
56+
OpenAEV allows you to customize your stack by selecting specific collectors and injectors to meet your unique needs:
5757

58-
- Additional Collectors: Explore a variety of collectors available [here](https://filigran.notion.site/OpenBAS-Ecosystem-30d8eb73d7d04611843e758ddef8941b#fb5f20e515df428994bed1438131cbd1).
59-
- Additional Injectors: Discover injectors to enhance your simulations [here](https://filigran.notion.site/OpenBAS-Ecosystem-30d8eb73d7d04611843e758ddef8941b#90cfcc2895d441d68b54eda9b57d5d31).
58+
- Additional Collectors: Explore a variety of collectors available [here](https://filigran.notion.site/OpenAEV-Ecosystem-30d8eb73d7d04611843e758ddef8941b#fb5f20e515df428994bed1438131cbd1).
59+
- Additional Injectors: Discover injectors to enhance your simulations [here](https://filigran.notion.site/OpenAEV-Ecosystem-30d8eb73d7d04611843e758ddef8941b#90cfcc2895d441d68b54eda9b57d5d31).
6060

6161
## About
6262

63-
OpenBAS is a product designed and developed by the company [Filigran](https://filigran.io).
63+
OpenAEV is a product designed and developed by the company [Filigran](https://filigran.io).
6464

65-
<a href="https://filigran.io" alt="Filigran"><img src="https://github.com/OpenBAS-Platform/openbas/raw/master/.github/img/logo_filigran.png" width="300" /></a>
65+
<a href="https://filigran.io" alt="Filigran"><img src="https://github.com/OpenAEV-Platform/openaev/raw/master/.github/img/logo_filigran.png" width="300" /></a>

docker-compose.caldera-injector.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
services:
2-
openbas:
2+
openaev:
33
environment:
44
- INJECTOR_CALDERA_ENABLE=true
55
- INJECTOR_CALDERA_URL=${CALDERA_URL:-http://caldera:8888}

docker-compose.caldera.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
services:
22
caldera:
3-
image: openbas/caldera-server:5.1.0
3+
image: openaev/caldera-server:5.1.0
44
restart: always
55
ports:
66
- "8888:8888" # If you change the host port (the left one) do not forget to update CALDERA_PUBLIC_URL everywhere

docker-compose.dev.yml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
version: '3'
22
services:
3-
openbas-dev-pgsql:
4-
container_name: openbas-dev-pgsql
3+
openaev-dev-pgsql:
4+
container_name: openaev-dev-pgsql
55
image: postgres:17-alpine
66
environment:
77
POSTGRES_USER: ${POSTGRES_USER}
88
POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
9-
POSTGRES_DB: openbas
9+
POSTGRES_DB: openaev
1010
ports:
1111
- "5432:5432"
1212
restart: unless-stopped
13-
openbas-dev-minio:
14-
container_name: openbas-dev-minio
13+
openaev-dev-minio:
14+
container_name: openaev-dev-minio
1515
image: minio/minio:RELEASE.2025-06-13T11-33-47Z
1616
ports:
1717
- "9000:9000"
@@ -21,8 +21,8 @@ services:
2121
MINIO_ROOT_PASSWORD: ${MINIO_ROOT_PASSWORD}
2222
command: server /data --console-address ":9001"
2323
restart: unless-stopped
24-
openbas-dev-rabbitmq:
25-
container_name: openbas-dev-rabbitmq
24+
openaev-dev-rabbitmq:
25+
container_name: openaev-dev-rabbitmq
2626
image: rabbitmq:4.1-management
2727
volumes:
2828
- type: bind

docker-compose.yml

Lines changed: 56 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ services:
44
environment:
55
POSTGRES_USER: ${POSTGRES_USER}
66
POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
7-
POSTGRES_DB: openbas
7+
POSTGRES_DB: openaev
88
volumes:
99
- pgsqldata:/var/lib/postgresql/data
1010
restart: always
1111
healthcheck:
12-
test: [ "CMD", "pg_isready", "-U", "${POSTGRES_USER}", "-d", "openbas" ]
12+
test: [ "CMD", "pg_isready", "-U", "${POSTGRES_USER}", "-d", "openaev" ]
1313
interval: 10s
1414
timeout: 5s
1515
retries: 5
@@ -75,32 +75,32 @@ services:
7575
interval: 30s
7676
timeout: 10s
7777
retries: 50
78-
openbas:
79-
image: openbas/platform:2.0.0
80-
# If you need (see the doc), uncomment to use a bind mount and set the attribute $OPENBAS_EXTRA_TRUSTED_CERTS_DIR (host folder) in your .env
78+
openaev:
79+
image: openaev/platform:2.0.0
80+
# If you need (see the doc), uncomment to use a bind mount and set the attribute $OPENAEV_EXTRA_TRUSTED_CERTS_DIR (host folder) in your .env
8181
#volumes:
82-
# - $OPENBAS_EXTRA_TRUSTED_CERTS_DIR:/opt/openbas/additional_certs
82+
# - $OPENAEV_EXTRA_TRUSTED_CERTS_DIR:/opt/openaev/additional_certs
8383
environment:
84-
# OpenBAS General Configuration
85-
- OPENBAS_BASE-URL=${OPENBAS_BASE_URL}
86-
- OPENBAS_AUTH-LOCAL-ENABLE=true
87-
- OPENBAS_ADMIN_EMAIL=${OPENBAS_ADMIN_EMAIL}
88-
- OPENBAS_ADMIN_PASSWORD=${OPENBAS_ADMIN_PASSWORD}
89-
- OPENBAS_ADMIN_TOKEN=${OPENBAS_ADMIN_TOKEN}
90-
- OPENBAS_HEALTHCHECK_KEY=${OPENBAS_HEALTHCHECK_KEY:-ChangeMe}
91-
- OPENBAS_EXTRA-TRUSTED-CERTS-DIR=/opt/openbas/additional_certs
84+
# OpenAEV General Configuration
85+
- OPENAEV_BASE-URL=${OPENAEV_BASE_URL}
86+
- OPENAEV_AUTH-LOCAL-ENABLE=true
87+
- OPENAEV_ADMIN_EMAIL=${OPENAEV_ADMIN_EMAIL}
88+
- OPENAEV_ADMIN_PASSWORD=${OPENAEV_ADMIN_PASSWORD}
89+
- OPENAEV_ADMIN_TOKEN=${OPENAEV_ADMIN_TOKEN}
90+
- OPENAEV_HEALTHCHECK_KEY=${OPENAEV_HEALTHCHECK_KEY:-ChangeMe}
91+
- OPENAEV_EXTRA-TRUSTED-CERTS-DIR=/opt/openaev/additional_certs
9292
# POSTGRES
93-
- SPRING_DATASOURCE_URL=jdbc:postgresql://pgsql:5432/openbas
93+
- SPRING_DATASOURCE_URL=jdbc:postgresql://pgsql:5432/openaev
9494
- SPRING_DATASOURCE_USERNAME=${POSTGRES_USER}
9595
- SPRING_DATASOURCE_PASSWORD=${POSTGRES_PASSWORD}
9696
# MINIO
9797
- MINIO_ENDPOINT=minio
9898
- MINIO_ACCESS-KEY=${MINIO_ROOT_USER}
9999
- MINIO_ACCESS-SECRET=${MINIO_ROOT_PASSWORD}
100100
# RABBITMQ
101-
- OPENBAS_RABBITMQ_HOSTNAME=rabbitmq
102-
- OPENBAS_RABBITMQ_USER=${RABBITMQ_DEFAULT_USER}
103-
- OPENBAS_RABBITMQ_PASS=${RABBITMQ_DEFAULT_PASS}
101+
- OPENAEV_RABBITMQ_HOSTNAME=rabbitmq
102+
- OPENAEV_RABBITMQ_USER=${RABBITMQ_DEFAULT_USER}
103+
- OPENAEV_RABBITMQ_PASS=${RABBITMQ_DEFAULT_PASS}
104104
# ELASTICSEARCH
105105
- ENGINE_URL=http://elasticsearch:9200
106106
# SPRING MAIL Configurations
@@ -113,17 +113,17 @@ services:
113113
- SPRING_MAIL_PROPERTIES_MAIL_SMTP_SSL_TRUST=*
114114
- SPRING_MAIL_PROPERTIES_MAIL_SMTP_STARTTLS_ENABLE=${SPRING_MAIL_PROPERTIES_MAIL_SMTP_STARTTLS_ENABLE}
115115
# IMAP Configurations
116-
- OPENBAS_MAIL_IMAP_ENABLED=${OPENBAS_MAIL_IMAP_ENABLED}
117-
- OPENBAS_MAIL_IMAP_HOST=${OPENBAS_MAIL_IMAP_HOST}
118-
- OPENBAS_MAIL_IMAP_PORT=${OPENBAS_MAIL_IMAP_PORT}
119-
- OPENBAS_MAIL_IMAP_USERNAME=${SPRING_MAIL_USERNAME}
120-
- OPENBAS_MAIL_IMAP_PASSWORD=${SPRING_MAIL_PASSWORD}
121-
- OPENBAS_MAIL_IMAP_AUTH=${OPENBAS_MAIL_IMAP_AUTH}
122-
- OPENBAS_MAIL_IMAP_SSL_ENABLE=${OPENBAS_MAIL_IMAP_SSL_ENABLE}
123-
- OPENBAS_MAIL_IMAP_SSL_TRUST=*
124-
- OPENBAS_MAIL_IMAP_STARTTLS_ENABLE=${OPENBAS_MAIL_IMAP_STARTTLS_ENABLE}
116+
- OPENAEV_MAIL_IMAP_ENABLED=${OPENAEV_MAIL_IMAP_ENABLED}
117+
- OPENAEV_MAIL_IMAP_HOST=${OPENAEV_MAIL_IMAP_HOST}
118+
- OPENAEV_MAIL_IMAP_PORT=${OPENAEV_MAIL_IMAP_PORT}
119+
- OPENAEV_MAIL_IMAP_USERNAME=${SPRING_MAIL_USERNAME}
120+
- OPENAEV_MAIL_IMAP_PASSWORD=${SPRING_MAIL_PASSWORD}
121+
- OPENAEV_MAIL_IMAP_AUTH=${OPENAEV_MAIL_IMAP_AUTH}
122+
- OPENAEV_MAIL_IMAP_SSL_ENABLE=${OPENAEV_MAIL_IMAP_SSL_ENABLE}
123+
- OPENAEV_MAIL_IMAP_SSL_TRUST=*
124+
- OPENAEV_MAIL_IMAP_STARTTLS_ENABLE=${OPENAEV_MAIL_IMAP_STARTTLS_ENABLE}
125125
ports:
126-
- "8080:8080" # If you change the host port (the left one) do not forget to update OPENBAS_BASE-URL in you .env
126+
- "8080:8080" # If you change the host port (the left one) do not forget to update OPENAEV_BASE-URL in you .env
127127
depends_on:
128128
pgsql:
129129
condition: service_healthy
@@ -135,81 +135,81 @@ services:
135135
condition: service_healthy
136136
restart: always
137137
healthcheck:
138-
test: [ "CMD", "wget", "-qO-", "http://openbas:8080/api/health?health_access_key=${OPENBAS_HEALTHCHECK_KEY}" ]
138+
test: [ "CMD", "wget", "-qO-", "http://openaev:8080/api/health?health_access_key=${OPENAEV_HEALTHCHECK_KEY}" ]
139139
interval: 10s
140140
timeout: 5s
141141
retries: 20
142142
collector-mitre-attack:
143-
image: openbas/collector-mitre-attack:2.0.0
143+
image: openaev/collector-mitre-attack:2.0.0
144144
environment:
145-
- OPENBAS_URL=http://openbas:8080
146-
- OPENBAS_TOKEN=${OPENBAS_ADMIN_TOKEN}
145+
- OPENAEV_URL=http://openaev:8080
146+
- OPENAEV_TOKEN=${OPENAEV_ADMIN_TOKEN}
147147
- COLLECTOR_ID=${COLLECTOR_MITRE_ATTACK_ID} # Valid UUIDv4
148148
- "COLLECTOR_NAME=MITRE ATT&CK"
149149
- COLLECTOR_LOG_LEVEL=info
150150
depends_on:
151-
openbas:
151+
openaev:
152152
condition: service_healthy
153153
restart: always
154-
collector-openbas:
155-
image: openbas/collector-openbas:2.0.0
154+
collector-openaev:
155+
image: openaev/collector-openaev:2.0.0
156156
environment:
157-
- OPENBAS_URL=http://openbas:8080
158-
- OPENBAS_TOKEN=${OPENBAS_ADMIN_TOKEN}
159-
- COLLECTOR_ID=${COLLECTOR_OPENBAS_ID} # Valid UUIDv4
160-
- "COLLECTOR_NAME=OpenBAS Datasets"
157+
- OPENAEV_URL=http://openaev:8080
158+
- OPENAEV_TOKEN=${OPENAEV_ADMIN_TOKEN}
159+
- COLLECTOR_ID=${COLLECTOR_OPENAEV_ID} # Valid UUIDv4
160+
- "COLLECTOR_NAME=OpenAEV Datasets"
161161
- COLLECTOR_LOG_LEVEL=info
162162
depends_on:
163-
openbas:
163+
openaev:
164164
condition: service_healthy
165165
restart: always
166166
collector-atomic-red-team:
167-
image: openbas/collector-atomic-red-team:2.0.0
167+
image: openaev/collector-atomic-red-team:2.0.0
168168
environment:
169-
- OPENBAS_URL=http://openbas:8080
170-
- OPENBAS_TOKEN=${OPENBAS_ADMIN_TOKEN}
169+
- OPENAEV_URL=http://openaev:8080
170+
- OPENAEV_TOKEN=${OPENAEV_ADMIN_TOKEN}
171171
- COLLECTOR_ID=${COLLECTOR_ATOMIC_RED_TEAM_ID} # Valid UUIDv4
172172
- "COLLECTOR_NAME=Atomic Red Team"
173173
- COLLECTOR_LOG_LEVEL=info
174174
depends_on:
175-
openbas:
175+
openaev:
176176
condition: service_healthy
177177
restart: always
178178
collector-nvd-nist-cve:
179-
image: openbas/collector-nvd-nist-cve:prerelease
179+
image: openaev/collector-nvd-nist-cve:2.0.0
180180
environment:
181-
- OPENBAS_URL=http://openbas:8080
182-
- OPENBAS_TOKEN=${OPENBAS_ADMIN_TOKEN}
181+
- OPENAEV_URL=http://openaev:8080
182+
- OPENAEV_TOKEN=${OPENAEV_ADMIN_TOKEN}
183183
- COLLECTOR_ID=${COLLECTOR_NVD_NIST_CVE_ID} # Valid UUIDv4
184184
- NVD_NIST_CVE_API_KEY=${COLLECTOR_NVD_NIST_CVE_API_KEY}
185185
- "COLLECTOR_NAME=CVE by NVD NIST"
186186
- COLLECTOR_LOG_LEVEL=info
187187
depends_on:
188-
openbas:
188+
openaev:
189189
condition: service_healthy
190190
restart: always
191191
injector-nmap:
192-
image: openbas/injector-nmap:2.0.0
192+
image: openaev/injector-nmap:2.0.0
193193
environment:
194-
- OPENBAS_URL=http://openbas:8080
195-
- OPENBAS_TOKEN=${OPENBAS_ADMIN_TOKEN}
194+
- OPENAEV_URL=http://openaev:8080
195+
- OPENAEV_TOKEN=${OPENAEV_ADMIN_TOKEN}
196196
- INJECTOR_ID=${INJECTOR_NMAP_ID} # Valid UUIDv4
197197
- "INJECTOR_NAME=Nmap"
198198
- INJECTOR_LOG_LEVEL=info
199199
depends_on:
200-
openbas:
200+
openaev:
201201
condition: service_healthy
202202
restart: always
203203
injector-nuclei:
204-
image: openbas/injector-nuclei:2.0.0
204+
image: openaev/injector-nuclei:2.0.0
205205
environment:
206-
- OPENBAS_URL=http://openbas:8080
207-
- OPENBAS_TOKEN=${OPENBAS_ADMIN_TOKEN}
206+
- OPENAEV_URL=http://openaev:8080
207+
- OPENAEV_TOKEN=${OPENAEV_ADMIN_TOKEN}
208208
- INJECTOR_ID=${INJECTOR_NUCLEI_ID} # Valid UUIDv4
209209
- "INJECTOR_NAME=Nuclei"
210210
- INJECTOR_LOG_LEVEL=info
211211
depends_on:
212-
openbas:
212+
openaev:
213213
condition: service_healthy
214214
restart: always
215215
volumes:

0 commit comments

Comments
 (0)