Skip to content

Commit 49d4ef9

Browse files
README updated
1 parent c5925dc commit 49d4ef9

File tree

1 file changed

+4
-48
lines changed

1 file changed

+4
-48
lines changed

contrib/docker-compose/README.md

Lines changed: 4 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -24,23 +24,13 @@ NGINX Declarative API - https://github.com/f5devcentral/NGINX-Declarative-API/
2424
=== Options:
2525
2626
-h - This help
27-
-w - Enable NGINX App Protect WAF compiler
2827
-c [start|stop|build] - Deployment command
29-
-C [file.crt] - Certificate to pull packages from the official NGINX repository (mandatory with -w)
30-
-K [file.key] - Key to pull packages from the official NGINX repository (mandatory with -w)
3128
3229
=== Examples:
3330
34-
Deploy NGINX Declarative API:
35-
no NGINX App Protect compiler: ./nginx-dapi.sh -c start
36-
with NGINX App Protect compiler: ./nginx-dapi.sh -c start -w
37-
38-
Remove NGINX Declarative API:
39-
./nginx-dapi.sh -c stop
40-
41-
Build docker images:
42-
no NGINX App Protect compiler: ./nginx-dapi.sh -c build
43-
with NGINX App Protect compiler: ./nginx-dapi.sh -c build -w -C /etc/ssl/nginx/nginx-repo.crt -K /etc/ssl/nginx/nginx-repo.key
31+
Deploy NGINX Declarative API: ./nginx-dapi.sh -c start
32+
Remove NGINX Declarative API: ./nginx-dapi.sh -c stop
33+
Build docker images: ./nginx-dapi.sh -c build
4434
4535
```
4636

@@ -65,17 +55,15 @@ nginx-declarative-api latest 0d76c5a4338b 1 minutes ago 168M
6555
With NGINX App Protect compiler
6656

6757
```
68-
$ ./nginx-dapi.sh -c build -w -C /etc/ssl/nginx/nginx-repo.crt -K /etc/ssl/nginx/nginx-repo.key
58+
$ ./nginx-dapi.sh -c build
6959
-> Building NGINX Declarative API Docker images
70-
-> Including NGINX App Protect WAF compiler tag 5.2.0
7160
[+] Building 118.6s (36/36) FINISHED
7261
[...]
7362
=> => exporting layers
7463
[...]
7564
7665
$ docker images
7766
REPOSITORY TAG IMAGE ID CREATED SIZE
78-
nginx-declarative-api-nap-compiler latest cbdaa70bba4b 33 seconds ago 691MB
7967
nginx-declarative-api-devportal latest ad136e8dc5fd About a minute ago 669MB
8068
nginx-declarative-api latest 4c9f89903b6d About a minute ago 174MB
8169
```
@@ -85,8 +73,6 @@ nginx-declarative-api latest 4c9f89903b6d About a minute ago
8573
1. Start NGINX Declarative API using the provided `nginx-dapi.sh` script
8674
2. Start Postman using the collection provided [here](/contrib/postman)
8775

88-
### Without NGINX App Protect compiler
89-
9076
Starting:
9177

9278
```commandline
@@ -111,33 +97,3 @@ $ ./nginx-dapi.sh -c stop
11197
✔ Container redis Removed
11298
✔ Network nginx-dapi_dapi-network Removed
11399
```
114-
115-
116-
#### With NGINX App Protect compiler:
117-
118-
Starting:
119-
120-
```commandline
121-
$ ./nginx-dapi.sh -c start -w
122-
-> Deploying NGINX Declarative API
123-
[+] Building 0.0s (0/0)
124-
[+] Running 5/5
125-
✔ Network nginx-dapi_dapi-network Created
126-
✔ Container redis Started
127-
✔ Container nap-compiler Started
128-
✔ Container devportal Started
129-
✔ Container nginx-dapi Started
130-
```
131-
132-
Stopping:
133-
134-
```commandline
135-
$ ./nginx-dapi.sh -c stop -w
136-
-> Undeploying NGINX Declarative API
137-
[+] Running 5/5
138-
✔ Container nginx-dapi Removed
139-
✔ Container devportal Removed
140-
✔ Container nap-compiler Removed
141-
✔ Container redis Removed
142-
✔ Network nginx-dapi_dapi-network Removed
143-
```

0 commit comments

Comments
 (0)