Skip to content

Commit 4bd1856

Browse files
committed
docs: document possible environment variables for docker use
1 parent a26aff4 commit 4bd1856

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

site/docker/index.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,21 @@ The Docker image is hosted on GitHub Container Registry and can be pulled using
66

77
Before running the command below, make sure you have a local `config.yaml` file and a proper `output` directory. Adjust the mount points accordingly, if necessary.
88

9+
## Environment variables
10+
11+
| Variable | Required | Description |
12+
| ----------------------- | :------: | ----------------------------------------------------------------------- |
13+
| `AUTH_HEADER` | Yes | Authorization header |
14+
| `BASE_URL` | Yes | Base URL of the SCIM server` |
15+
| `CONFIG_FILE` | No | Path to YAML configuration file |
16+
| `CONFIG` | No\* | YAML configuration |
17+
| `HAR_FILE_NAME` | No | Path to write HAR file output |
18+
19+
\* `CONFIG` is required when `CONFIG_FILE` is not set
20+
921
## Example command
1022

11-
~~~.sh
23+
```sh
1224
docker run \
1325
-e CONFIG_FILE=/app/config.yaml \
1426
-e AUTH_HEADER="Bearer REPLACE_THIS" \
@@ -17,11 +29,11 @@ docker run \
1729
-v $(pwd)/site/.vitepress/theme/components/config.yaml:/app/config.yaml \
1830
-v $(pwd)/output/:/output \
1931
ghcr.io/limosa-io/scimverify
20-
~~~
32+
```
2133

2234
## Example configuration
2335

24-
~~~.yaml
36+
```yaml
2537
detectSchema: true
2638
detectResourceTypes: true
2739

@@ -446,4 +458,4 @@ groups:
446458
}
447459
delete_tests:
448460
- id: AUTO
449-
~~~
461+
```

0 commit comments

Comments
 (0)