Skip to content

Commit 91bd210

Browse files
authored
Document the usage of .env file in getting-started.md (#6)
2 parents 5a0878b + 413cfe5 commit 91bd210

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

getting-started.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,3 +161,21 @@ Run:
161161
```bash
162162
curl -v -H "X-Debug: true" https://<your_domain>/
163163
```
164+
165+
### (Optional) Use environment variables
166+
167+
Every command line argument of `hlx` can also be provided via an _environment variable_, by prefixing its name with `HLX_`. For example the `--wsk-namespace` via `HLX_WSK_NAMESPACE`, the `--log-level` can be set via the `HLX_LOG_LEVEL` variable etc. You can store those variables in an `.env` file which will be picked up automatically by `hlx`.
168+
169+
The relevant environment variables are
170+
- `HLX_WSK_NAMESPACE`
171+
- `HLX_WSK_HOST`
172+
- `HLX_WSK_AUTH`
173+
- `HLX_CIRCLECI_AUTH`
174+
- `HLX_FASTLY_NAMESPACE`
175+
- `HLX_FASTLY_AUTH`
176+
- `HLX_LOGGLY_AUTH`
177+
- `HLX_LOGGLY_HOST`
178+
- `HLX_LOG_LEVEL`
179+
- `HLX_HOST`
180+
- `HLX_LOCAL_REPO`
181+
- `HLX_OPEN`

0 commit comments

Comments
 (0)