Skip to content

Commit

Permalink
docs(#14): add example for mounting a local config file
Browse files Browse the repository at this point in the history
  • Loading branch information
nickamzol committed Jul 31, 2024
1 parent 6ca6c6e commit 31ac152
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions docs/topics/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,36 @@

This configuration will be loaded from a file named `config.yaml` next to the binary.

When using Docker, you can use [volumes](https://docs.docker.com/storage/volumes/) to mount a local config file into the
container.
In the container, the config file is always located in the root directory.
The `:ro` option will mount the file into the container as read-only.

<tabs>
<tab id="docker-compose" title="Docker Compose">
<code-block lang="yaml">
services:
dicom-rst:
image: ghcr.io/umessen/dicom-rst:v0.2.1
ports:
- "8080:8080"
- "7001:7001"
volumes:
- ./dicom-rst.yaml:/config.yaml:ro
</code-block>
</tab>
<tab id="docker-run" title="Docker Run">
<code-block lang="shell">
docker run \
-p 8080:8080 \
-p 7001:7001 \
-v ./dicom-rst.yaml:/config.yaml:ro \
ghcr.io/umessen/dicom-rst:latest
</code-block>
</tab>

</tabs>

## Example Config

The following configuration provides all relevant settings.
Expand Down

0 comments on commit 31ac152

Please sign in to comment.