Skip to content

Commit e1b5c0c

Browse files
committed
clarify secrets usage in CLI docs and monitoring overview.
1 parent cf4cb5e commit e1b5c0c

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

site/content/docs/cli/using-environment-variables.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ npx checkly env ls
146146
Create a new variable.
147147

148148
```bash
149-
npx checkly env add MY_PASSWORD 123test --locked
149+
npx checkly env add MY_PASSWORD 123test --secret
150150
```
151151

152152
Pull in the variables from your account and store them in a file.
@@ -171,5 +171,6 @@ For storing and securing environment variables, we advise the following:
171171
1. Store local environment variables in your shell or in `.env` files that are not committed to your git repo. Add those
172172
files to your `.gitignore` file.
173173
2. In a CI context, e.g. GitHub Actions, store sensitive variables as secrets. Almost all CI providers have such a feature.
174-
3. For remote variables, store sensitive secrets at the Account level and click the lock icon so Read Only users cannot view them.
174+
3. For remote variables, store sensitive data as secrets in Checkly. For more information on how to manage secrets in Checkly see [variables and secrets](/docs/browser-checks/variables).
175+
175176
All variables are stored encrypted at rest and in transfer.

site/content/docs/monitoring/storing-secrets.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ Here are our guidelines on using secrets with Checkly:
1212
**1. Use dedicated test users, test cards** etc. These test users should have minimal privileges in your app. Do not use your
1313
`admin` or `root` user. Make sure you can easily disable or block these users without recourse.
1414

15-
**2. Keep secrets separate** from your browser scripts and store them as environment variables in Checkly. This
15+
**2. Keep secrets separate** from your browser scripts and store them as environment secrets in Checkly. This
1616
way you can reuse secrets in multiple scripts and rotate them as needed.
1717

1818
**3. Checkly encrypts your secrets**: at rest in the database and in flight as we transport it to the check locations.
1919
Decryption is only done when we need to read it.
2020

21-
21+
To learn how to create and manage variables and secrets in Checkly see see [variables and secrets](/docs/browser-checks/variables).

0 commit comments

Comments
 (0)