Skip to content

Commit 113f7de

Browse files
committed
docs: Update README to reflect the true defaults
1 parent 0914374 commit 113f7de

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,18 @@ End user configuration via environment variables was a goal while creating this.
1212
```text
1313
Format is: VAR=default # info
1414
15-
CODECOV_API_HOST=api # This is the host to access the codecov api
15+
CODECOV_API_HOST=api # This is the host to access the codecov api
1616
CODECOV_API_PORT=8000 # The port to access the codecov api
1717
CODECOV_API_SCHEME=http # The scheme on which to access the codecov api. http or https
18-
CODECOV_API_HOST_HEADER="\$http_host" # The host to send as the host header. Default passes through host. Useful to set for local envs.
19-
CODECOV_IA_HOST=IA
18+
CODECOV_API_HOST_HEADER="%[req.hdr(Host)]" # The host to send as the host header. Default passes through host. Useful to set for local envs.
19+
CODECOV_IA_HOST=api
2020
CODECOV_IA_PORT=8000
2121
CODECOV_IA_SCHEME=http
22-
CODECOV_IA_HOST_HEADER="\$http_host"
22+
CODECOV_IA_HOST_HEADER="%[req.hdr(Host)]"
2323
CODECOV_DEFAULT_HOST=frontend
24-
CODECOV_DEFAULT_PORT=5000
24+
CODECOV_DEFAULT_PORT=8080
2525
CODECOV_DEFAULT_SCHEME=http
26-
CODECOV_DEFAULT_HOST_HEADER="\$http_host"
26+
CODECOV_DEFAULT_HOST_HEADER="%[req.hdr(Host)]"
2727
CODECOV_MINIO_HOST=minio
2828
CODECOV_MINIO_PORT=9000
2929
CODECOV_MINIO_SCHEME=http
@@ -38,7 +38,7 @@ Use public codecov api, local IA and qa for web
3838
3939
CODECOV_API_HOST=api.codecov.io
4040
CODECOV_API_PORT=443
41-
CODECOV_API_SCHEME=https
41+
CODECOV_API_SCHEME=https
4242
CODECOV_API_HOST_HEADER=api.codecov.io
4343
CODECOV_IA_HOST=IA
4444
CODECOV_IA_PORT=8000
@@ -52,11 +52,11 @@ CODECOV_DEFAULT_HOST_HEADER="qa.codecov.dev"
5252

5353
### SSL
5454
1. Mount a valid cert in the container at `/etc/codecov/ssl/certs/cert.crt`
55-
2. Configure the env `CODECOV_GATEWAY_SSL_ENABLED=true`
55+
2. Configure the env `CODECOV_GATEWAY_SSL_ENABLED=true`
5656

5757
### Proxy
5858
1. Configure the env `CODECOV_GATEWAY_PROXY_MODE_ENABLED=true`
59-
All requests will now be sent on to the configured CODECOV_DEFAULT host/port.
59+
All requests will now be sent on to the configured `CODECOV_DEFAULT` host/port.
6060

6161
### Minio
6262
This is mostly intended for when using with docker compose. It makes /export and /archive route to the minio host. To enable minio features use the env var `CODECOV_GATEWAY_MINIO_ENABLED=true`

0 commit comments

Comments
 (0)