Skip to content

Commit 40b4b73

Browse files
committed
Fix horizontal scrolling in Config docs
1 parent ca8e022 commit 40b4b73

File tree

1 file changed

+59
-6
lines changed

1 file changed

+59
-6
lines changed

documentation/docs/getting-started/configuration.mdx

Lines changed: 59 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,15 @@ Let's get OPAL running! You'll need to set a few environment variables that tell
1818
export OPAL_POLICY_REPO_URL=https://github.com/your-org/policy-repo.git
1919

2020
# Where clients get initial data
21-
export OPAL_DATA_CONFIG_SOURCES='{"config":{"entries":[{"url":"http://localhost:7002/policy-data","topics":["policy_data"],"dst_path":"/static"}]}}'
21+
export OPAL_DATA_CONFIG_SOURCES='{
22+
"config": {
23+
"entries": [{
24+
"url": "http://localhost:7002/policy-data",
25+
"topics": ["policy_data"],
26+
"dst_path": "/static"
27+
}]
28+
}
29+
}'
2230

2331
# Broadcast channel for scaling (use Redis or PostgreSQL)
2432
export OPAL_BROADCAST_URI=postgres://postgres:postgres@localhost:5432/postgres
@@ -774,7 +782,17 @@ Enforce webhook events only from a specific branch.
774782

775783
#### OPAL_POLICY_REPO_WEBHOOK_PARAMS
776784

777-
Default: `{"secret_header_name": "x-hub-signature-256", "secret_type": "signature", "secret_parsing_regex": "sha256=(.*)", "event_header_name": "X-GitHub-Event", "event_request_key": null, "push_event_value": "push"}`
785+
Default:
786+
```json
787+
{
788+
"secret_header_name": "x-hub-signature-256",
789+
"secret_type": "signature",
790+
"secret_parsing_regex": "sha256=(.*)",
791+
"event_header_name": "X-GitHub-Event",
792+
"event_request_key": null,
793+
"push_event_value": "push"
794+
}
795+
```
778796

779797
Additional parameters for webhook processing.
780798

@@ -866,7 +884,17 @@ Default route for data callbacks (exists as a sane default in case the user did
866884

867885
#### OPAL_DATA_CONFIG_SOURCES
868886

869-
Default: `{"config": {"entries": [{"url": "http://localhost:7002/policy-data", "topics": ["data"]}]}}`
887+
Default:
888+
```json
889+
{
890+
"config": {
891+
"entries": [{
892+
"url": "http://localhost:7002/policy-data",
893+
"topics": ["data"]
894+
}]
895+
}
896+
}
897+
```
870898

871899
Configuration of data sources by topics.
872900

@@ -1186,7 +1214,15 @@ For more information, see [tracking a Git repository](/tutorials/track_a_git_rep
11861214

11871215
#### OPAL_POLICY_UPDATER_CONN_RETRY
11881216

1189-
Default: `{"wait_strategy": "random_exponential", "max_wait": 10, "attempts": 5, "wait_time": 1}`
1217+
Default:
1218+
```json
1219+
{
1220+
"wait_strategy": "random_exponential",
1221+
"max_wait": 10,
1222+
"attempts": 5,
1223+
"wait_time": 1
1224+
}
1225+
```
11901226

11911227
Retry options when connecting to the policy source (e.g., the policy bundle server).
11921228

@@ -1230,7 +1266,16 @@ For more information, see [monitoring OPAL](/tutorials/monitoring_opal).
12301266

12311267
#### OPAL_DEFAULT_UPDATE_CALLBACK_CONFIG
12321268

1233-
Default: `{"method": "POST", "headers": {"content-type": "application/json"}, "process_data": false}`
1269+
Default:
1270+
```json
1271+
{
1272+
"method": "POST",
1273+
"headers": {
1274+
"content-type": "application/json"
1275+
},
1276+
"process_data": false
1277+
}
1278+
```
12341279

12351280
Default configuration for update callbacks.
12361281

@@ -1246,7 +1291,15 @@ For more information, see [monitoring OPAL](/tutorials/monitoring_opal).
12461291

12471292
#### OPAL_DATA_UPDATER_CONN_RETRY
12481293

1249-
Default: `{"wait_strategy": "random_exponential", "max_wait": 10, "attempts": 5, "wait_time": 1}`
1294+
Default:
1295+
```json
1296+
{
1297+
"wait_strategy": "random_exponential",
1298+
"max_wait": 10,
1299+
"attempts": 5,
1300+
"wait_time": 1
1301+
}
1302+
```
12501303

12511304
Retry options when connecting to the base data source (e.g., an external API server which returns data snapshot).
12521305

0 commit comments

Comments
 (0)