From c10e0a46c20b8e9f77fdca3df9ef619aafd97759 Mon Sep 17 00:00:00 2001 From: kxxt Date: Fri, 5 May 2023 09:55:21 +0800 Subject: [PATCH] docs: document auth env vars --- README.md.in | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md.in b/README.md.in index 8a260e4..dccc94e 100644 --- a/README.md.in +++ b/README.md.in @@ -107,7 +107,12 @@ To avoid repetition, you can store your authentication details in your aspeak profile. Read the following section for more details. -From v4.3.0, you can let aspeak use a proxy server to connect to the endpoint. +From v5.2.0, you can also set the authentication secrets via the following environment variables: + +- `ASPEAK_AUTH_KEY` for authentication using subscription key +- `ASPEAK_AUTH_TOKEN` for authentication using authorization token + +From v4.3.0, you can let aspeak use a proxy server to connect to the endpoint. For now, only http and socks5 proxies are supported (no https support yet). For example: ```sh