Skip to content

Commit 5fb4e19

Browse files
authored
Audio Analyzer build option simplified (open-edge-platform#1159)
1 parent 5a7938a commit 5fb4e19

File tree

2 files changed

+9
-12
lines changed

2 files changed

+9
-12
lines changed

microservices/audio-analyzer/docs/user-guide/how-to-build-from-source.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -56,22 +56,24 @@ chmod +x ./setup_docker.sh
5656

5757
#### Docker Setup Options
5858

59-
The `setup_docker.sh` script supports the following options:
59+
The `setup_docker.sh` script when run without any parameters builds and runs the production docker images. It additionally supports the following options:
6060

6161
```
6262
Options:
6363
--dev Build and run development environment
64-
--build-only Only build Docker images (don't run containers)
65-
--build-dev Only build development Docker image
66-
--build-prod Only build production Docker image
64+
--build Only build production Docker image
65+
--build-dev Only build development Docker image
66+
--down Stop and remove all contianers, networks,
67+
and volumes
6768
-h, --help Show this help message
6869
```
6970

7071
Examples:
7172
- Production setup: `./setup_docker.sh`
7273
- Development setup: `./setup_docker.sh --dev`
73-
- Build production image only: `./setup_docker.sh --build-prod`
74+
- Build production image only: `./setup_docker.sh --build`
7475
- Build development image only: `./setup_docker.sh --build-dev`
76+
- Stop and remove all contianers: `./setup_docker.sh --down`
7577

7678
#### Additional Configuration
7779

microservices/audio-analyzer/setup_docker.sh

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ show_help() {
2424
echo "Usage: $0 [options]"
2525
echo ""
2626
echo "Options:"
27+
echo " (no options) Build and run production environment"
2728
echo " --dev Build and run development environment"
28-
echo " --build Only build production Docker images (alias for --build-prod)"
29+
echo " --build Only build production Docker images"
2930
echo " --build-dev Only build development Docker image"
30-
echo " --build-prod Only build production Docker image"
3131
echo " --down Stop and remove all containers, networks, and volumes"
3232
echo " -h, --help Show this help message"
3333
echo ""
@@ -36,7 +36,6 @@ show_help() {
3636
echo " $0 --dev Build and run development environment"
3737
echo " $0 --build Build production Docker image only"
3838
echo " $0 --build-dev Build development Docker image only"
39-
echo " $0 --build-prod Build production Docker image only"
4039
echo " $0 --down Stop and remove all containers"
4140
echo ""
4241
}
@@ -57,10 +56,6 @@ while [[ $# -gt 0 ]]; do
5756
DEV_MODE=true
5857
shift
5958
;;
60-
--build-prod)
61-
BUILD_ONLY=true
62-
shift
63-
;;
6459
--down)
6560
DOWN_CONTAINERS=true
6661
shift

0 commit comments

Comments
 (0)