Skip to content

Commit 00633cd

Browse files
README updated (#105)
1 parent 7b4d29a commit 00633cd

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

contrib/docker-compose/README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,21 +25,23 @@ NGINX Declarative API - https://github.com/f5devcentral/NGINX-Declarative-API/
2525

2626
-h - This help
2727
-c [start|stop|build] - Deployment command
28+
-m [full|dev] - Deployment mode: full (with webui container) or dev (backend only for local webui development) (default: full)
2829
-a <port> - Custom port for NGINX Declarative API (default: 5000)
29-
-w <port> - Custom port for Web UI (default: 3000)
30+
-w <port> - Custom port for Web UI (default: 3000, only for full mode)
3031
-d <port> - Custom port for Developer Portal (default: 5001)
3132
-r <port> - Custom port for Redis (default: 6379)
3233

3334
=== Examples:
3435

35-
Deploy NGINX Declarative API: ./nginx-dapi.sh -c start
36+
Deploy NGINX Declarative API (full): ./nginx-dapi.sh -c start
37+
Deploy in dev mode (no webui container): ./nginx-dapi.sh -c start -m dev
3638
Deploy with custom Declarative API port: ./nginx-dapi.sh -c start -a 8080
39+
Deploy dev mode with custom ports: ./nginx-dapi.sh -c start -m dev -a 8080 -d 8081 -r 6380
3740
Deploy with custom Web UI port: ./nginx-dapi.sh -c start -w 8080
3841
Deploy with custom DevPortal port: ./nginx-dapi.sh -c start -d 8081
3942
Deploy with all custom ports: ./nginx-dapi.sh -c start -a 8080 -w 8081 -d 8082 -r 6380
4043
Remove NGINX Declarative API: ./nginx-dapi.sh -c stop
4144
Build docker images: ./nginx-dapi.sh -c build
42-
4345
```
4446

4547
## Building docker images
@@ -54,8 +56,9 @@ $ ./nginx-dapi.sh -c build
5456

5557
$ docker images
5658
REPOSITORY TAG IMAGE ID CREATED SIZE
57-
nginx-declarative-api-devportal latest e1bd3cf9965a 1 minutes ago 669MB
58-
nginx-declarative-api latest 0d76c5a4338b 1 minutes ago 168MB
59+
nginx-declarative-api-webui latest 65d93e68ab9f 1 minutes ago 62.4MB
60+
nginx-declarative-api latest baa9086d4779 1 minutes ago 123MB
61+
nginx-declarative-api-devportal latest 6df48ac0c209 1 minutes ago 400MB
5962
```
6063

6164
## How to run

0 commit comments

Comments
 (0)