Skip to content

Commit

Permalink
Improve Docker documentation in README (jhipster#27702)
Browse files Browse the repository at this point in the history
  • Loading branch information
mraible authored Oct 28, 2024
1 parent a5c1f6d commit 0fe9a40
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions generators/spring-boot/templates/README.md.jhi.spring-boot.ejs
Original file line number Diff line number Diff line change
Expand Up @@ -331,21 +331,21 @@ For more information, refer to the [Code quality page][].
### Docker Compose support
JHipster generates a number of docker-compose configuration files in the [<%- dockerServicesDir %>](<%- dockerServicesDir %>) folder to launch required third party services.
JHipster generates a number of Docker Compose configuration files in the [<%- dockerServicesDir %>](<%- dockerServicesDir %>) folder to launch required third party services.
For example, to start required services in docker containers, run:
For example, to start required services in Docker containers, run:
```
docker compose -f <%- dockerServicesDir %>services.yml up -d
```
To stop it and remove the containers, run:
To stop and remove the containers, run:
```
docker compose -f <%- dockerServicesDir %>services.yml down
```
[Spring Docker Compose Integration](https://docs.spring.io/spring-boot/reference/features/dev-services.html) is enable by default. Is possible to disable it in application.yml:
[Spring Docker Compose Integration](https://docs.spring.io/spring-boot/reference/features/dev-services.html) is enable by default. It's possible to disable it in application.yml:
```yaml
spring:
Expand All @@ -356,13 +356,13 @@ spring:
```
You can also fully dockerize your application and all the services that it depends on.
To achieve this, first build a docker image of your app by running:
To achieve this, first build a Docker image of your app by running:
```sh
npm run java:docker
```
Or build a arm64 docker image when using an arm64 processor os like MacOS with M1 processor family running:
Or build a arm64 Docker image when using an arm64 processor os like MacOS with M1 processor family running:
```sh
npm run java:docker:arm64
Expand All @@ -374,7 +374,7 @@ Then run:
docker compose -f <%- dockerServicesDir %>app.yml up -d
```
For more information refer to [Using Docker and Docker-Compose][], this page also contains information on the docker-compose sub-generator (`jhipster docker-compose`), which is able to generate docker configurations for one or several JHipster applications.
For more information refer to [Using Docker and Docker-Compose][], this page also contains information on the Docker Compose sub-generator (`jhipster docker-compose`), which is able to generate Docker configurations for one or several JHipster applications.
## Continuous Integration (optional)
Expand Down

0 comments on commit 0fe9a40

Please sign in to comment.