Skip to content

Commit ba1b1dd

Browse files
committed
docs: added references to .env files
1 parent 98433e8 commit ba1b1dd

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,14 @@ There are two GitHub Actions workflows that run automatically when targeting cha
2828

2929
The [update](./update) directory contains a node program which will read the aliases mapping file, fetch the list of mail routes from Mailgun and update the routes to make sure they match the required state. The program is run by passing it a domain name as an argument (`update/update.js iojs.org`).
3030

31-
The Mailgun API key for the given domain is required. It can be found in the `admin_logins.md` file in the secrets repo (build/infra/), or directly via the Rackspace API. The key should be used as environment variable `MAILGUN_API_KEY` when running the program.
31+
The Mailgun API key for the given domain is required. It can be found in the `admin_logins.md` file in the secrets repo (build/infra/), or directly via the Rackspace API. The key should be used as environment variable `MAILGUN_API_KEY` when running the program.
32+
33+
34+
Optionally, you can create a `.env` file in the `update` directory with the following content:
35+
36+
```
37+
MAILGUN_API_KEY=your-api-key
38+
```
3239

3340
The programs can be used with `--dry-run` to verify the current status and what will be changed by an update.
3441

0 commit comments

Comments
 (0)