Skip to content

Commit

Permalink
Improve Services and Secrets Section in README.md
Browse files Browse the repository at this point in the history
Grammatical errors correction and fixed sentence structure
  • Loading branch information
AnumDastgir authored Jul 24, 2024
1 parent 46a3852 commit dbd3076
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,11 +65,11 @@ password = ''

## Services

PREvant provides central configuration options for services deployed through its REST-API. For example, you can define that PREvant mounts a secret for a specific service of an application.
PREvant offers centralized configuration options for services deployed via its REST-API. For example, you can specify that PREvant mounts a secret for a specific service of an application.

### Secrets

As secrets in [Docker Swarm](https://docs.docker.com/engine/swarm/secrets/) and [Docker-Compose](https://docs.docker.com/compose/compose-file/#secrets) PREvant mounts secrets und `/run/secrets/<secret_name>`. Therefore, you can use following configuration section to define secrets for each service.
Similar to secrets in [Docker Swarm](https://docs.docker.com/engine/swarm/secrets/) and [Docker-Compose](https://docs.docker.com/compose/compose-file/#secrets), PREvant mounts secrets under `/run/secrets/<secret_name>`. Therefore, you can use the following configuration section to define secrets for each service.

Following example provides two secrets for the service `nginx`, mounted at `/run/secrets/cert.pem` and `/run/secrets/key.pem`, available for the application `master`.

Expand Down

0 comments on commit dbd3076

Please sign in to comment.