Skip to content

Repository navigation

Use shebang-style headers in environment variables docs #1260

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
florimondmanca merged 1 commit into from
Sep 5, 2020
Merged

Use shebang-style headers in environment variables docs #1260

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 6 additions & 12 deletions docs/environment_variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Environment Variables
=====================
# Environment Variables

The HTTPX library can be configured via environment variables.
Environment variables are used by default. To ignore environment variables, `trust_env` has to be set `False`. There are two ways to set `trust_env` to disable environment variables:
Expand All @@ -9,8 +8,7 @@ Environment variables are used by default. To ignore environment variables, `tru

Here is a list of environment variables that HTTPX recognizes and what function they serve:

`HTTPX_LOG_LEVEL`
-----------------
## `HTTPX_LOG_LEVEL`

Valid values: `debug`, `trace` (case-insensitive)

Expand Down Expand Up @@ -74,8 +72,7 @@ TRACE [2019-11-06 19:18:56] httpx._dispatch.connection_pool - release_connection
TRACE [2019-11-06 19:18:56] httpx._dispatch.connection - close_connection
```

`SSLKEYLOGFILE`
-----------
## `SSLKEYLOGFILE`

Valid values: a filename

Expand Down Expand Up @@ -109,8 +106,7 @@ CLIENT_HANDSHAKE_TRAFFIC_SECRET XXXX
CLIENT_TRAFFIC_SECRET_0 XXXX
```

`SSL_CERT_FILE`
-----------
## `SSL_CERT_FILE`

Valid values: a filename

Expand All @@ -124,8 +120,7 @@ Example:
SSL_CERT_FILE=/path/to/ca-certs/ca-bundle.crt python -c "import httpx; httpx.get('https://example.com')"
```

`SSL_CERT_DIR`
-----------
## `SSL_CERT_DIR`

Valid values: a directory

Expand All @@ -139,8 +134,7 @@ Example:
SSL_CERT_DIR=/path/to/ca-certs/ python -c "import httpx; httpx.get('https://example.com')"
```

`HTTP_PROXY`, `HTTPS_PROXY`, `ALL_PROXY`
----------------------------------------
## `HTTP_PROXY`, `HTTPS_PROXY`, `ALL_PROXY`

Valid values: A URL to a proxy

Expand Down