Skip to content

Commit 804975a

Browse files
authored
Update installation.md
Update the documentation based on the recent change in docker compose files.
1 parent 9fd414f commit 804975a

File tree

1 file changed

+25
-9
lines changed

1 file changed

+25
-9
lines changed

docs/deployment/installation.md

+25-9
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ manual [installation packages](https://github.com/OpenBAS-Platform/openbas/relea
1313

1414
---
1515

16-
Deploy OpenBAS using Docker and the default `docker-compose.yml` provided
16+
Deploy OpenBAS using Docker and the default `docker-compose.base.yml` provided
1717
in the [docker](https://github.com/OpenBAS-Platform/docker).
1818

1919
[:octicons-arrow-right-24:{ .middle } Setup](#using-docker)
@@ -59,11 +59,11 @@ cd docker
5959

6060
### Configure the environment
6161

62-
Before running the `docker compose` command, the `docker-compose.yml` file should be configured. By default, the
63-
`docker-compose.yml` file is using environment variables available in the `.env.sample` file.
62+
Before running the `docker compose` command, the `docker-compose.base.yml` file should be configured. By default, the
63+
`docker-compose.base.yml` file is using environment variables available in the `.env.sample` file.
6464

6565
You can either rename the file `.env.sample` in `.env` and put the expected values or just fill directly the
66-
`docker-compose.yml` with the values corresponding to your environment.
66+
`docker-compose.base.yml` with the values corresponding to your environment.
6767

6868
#### Docker compose env
6969

@@ -106,7 +106,7 @@ export $(cat .env | grep -v "#" | xargs)
106106

107107
The default for OpenBAS data is to be persistent.
108108

109-
In the `docker-compose.yml`, you will find at the end the list of necessary persistent volumes for the dependencies:
109+
In the `docker-compose.base.yml`, you will find at the end the list of necessary persistent volumes for the dependencies:
110110

111111
```yaml
112112
volumes:
@@ -123,8 +123,24 @@ After changing your `.env` file run `docker compose` in detached (-d) mode:
123123

124124
```bash
125125
sudo systemctl start docker.service
126-
# Run docker compose in detached
127-
docker compose up -d
126+
```
127+
128+
To start OpenBAS with the essential services, run:
129+
130+
```bash
131+
docker compose -f docker-compose.base.yml up -d
132+
```
133+
134+
To start OpenBAS with Atomic Red Team threat library, run:
135+
136+
```bash
137+
docker compose -f docker-compose.base.yml -f docker-compose.atomic-red-team.yml up -d
138+
```
139+
140+
To start OpenBAS with Caldera, run:
141+
142+
```bash
143+
docker compose -f docker-compose.base.yml -f docker-compose.caldera.yml up -d
128144
```
129145

130146
#### Using Docker swarm
@@ -143,7 +159,7 @@ Put your environment variables in `/etc/environment`:
143159
# If you already exported your variables to .env from above:
144160
sudo cat .env >> /etc/environment
145161
sudo bash -c 'cat .env >> /etc/environment’
146-
sudo docker stack deploy --compose-file docker-compose.yml openbas
162+
sudo docker stack deploy --compose-file docker-compose.base.yml openbas
147163
```
148164

149165
!!! success "Installation done"
@@ -160,7 +176,7 @@ You can deploy Caldera alongside OpenBAS to manage agent deployment and execute
160176

161177
---
162178

163-
Deploy Caldera using Docker and the default `docker-compose.yml` provided
179+
Deploy Caldera using Docker and the default `docker-compose.base.yml` provided
164180
in the [docker](https://github.com/OpenBAS-Platform/caldera/tree/filigran/docker).
165181

166182
[:octicons-arrow-right-24:{ .middle } Setup](#using-docker)

0 commit comments

Comments
 (0)