Skip to content

Commit 0ecdcd3

Browse files
authored
Fix filename typos in README.md (OWASP#290)
The current name of the docker compose file is `docker-compose.yml`. The readme command examples indicated that the name was `docker compose.yml`. This commit updates all README cases of this error to reflect the actual name of the file, making the command functional again.
1 parent 785f9ca commit 0ecdcd3

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

Diff for: README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,15 @@ You can use prebuilt images generated by our CI workflow by downloading the dock
3737

3838
docker compose pull
3939

40-
docker compose -f docker compose.yml --compatibility up -d
40+
docker compose -f docker-compose.yml --compatibility up -d
4141
```
4242
4343
To override server configurations, change the values of the variables present in the **.env** file or add the respective variables to the start of the docker compose command.
4444

4545
For example to expose the system to all network interfaces.
4646

4747
```
48-
LISTEN_IP="0.0.0.0" docker compose -f docker compose.yml --compatibility up -d
48+
LISTEN_IP="0.0.0.0" docker compose -f docker-compose.yml --compatibility up -d
4949
```
5050

5151
- Windows Machine
@@ -59,15 +59,15 @@ You can use prebuilt images generated by our CI workflow by downloading the dock
5959

6060
docker compose pull
6161

62-
docker compose -f docker compose.yml --compatibility up -d
62+
docker compose -f docker-compose.yml --compatibility up -d
6363
```
6464
6565
To override server configurations, change the values of the variables present in the **.env** file or add the respective variables to the start of the docker compose command.
6666

6767
For example to expose the system to all network interfaces.
6868

6969
```
70-
LISTEN_IP="0.0.0.0" docker compose -f docker compose.yml --compatibility up -d
70+
LISTEN_IP="0.0.0.0" docker compose -f docker-compose.yml --compatibility up -d
7171
```
7272

7373
- To use the latest development version
@@ -83,15 +83,15 @@ You can use prebuilt images generated by our CI workflow by downloading the dock
8383
8484
docker compose pull
8585
86-
docker compose -f docker compose.yml --compatibility up -d
86+
docker compose -f docker-compose.yml --compatibility up -d
8787
```
8888
8989
To override server configurations, change the values of the variables present in the **.env** file or add the respective variables to the start of the docker compose command.
9090
9191
For example to expose the system to all network interfaces.
9292
9393
```
94-
LISTEN_IP="0.0.0.0" docker compose -f docker compose.yml --compatibility up -d
94+
LISTEN_IP="0.0.0.0" docker compose -f docker-compose.yml --compatibility up -d
9595
```
9696
9797
- Windows Machine
@@ -105,15 +105,15 @@ You can use prebuilt images generated by our CI workflow by downloading the dock
105105
106106
docker compose pull
107107
108-
docker compose -f docker compose.yml --compatibility up -d
108+
docker compose -f docker-compose.yml --compatibility up -d
109109
```
110110
111111
To override server configurations, change the values of the variables present in the **.env** file or add the respective variables to the start of the docker compose command.
112112
113113
For example to expose the system to all network interfaces.
114114
115115
```
116-
LISTEN_IP="0.0.0.0" docker compose -f docker compose.yml --compatibility up -d
116+
LISTEN_IP="0.0.0.0" docker compose -f docker-compose.yml --compatibility up -d
117117
```
118118
119119

0 commit comments

Comments
 (0)