Skip to content

Commit 79ba1cd

Browse files
committed
Update README to reflect credentials in config file
1 parent 904a5d1 commit 79ba1cd

1 file changed

Lines changed: 12 additions & 6 deletions

File tree

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@ Copy `config.example.yaml` and fill in your values:
2121
```yaml
2222
ripe:
2323
maintainer: "MAINT-AS12345"
24+
credentials:
25+
db_username: "op://vault/item/username"
26+
db_password: "op://vault/item/password"
27+
rpki_api_key: "op://vault/item/rpki-api-key"
2428
sso_emails:
2529
- "admin@example.com"
2630
routes:
@@ -41,13 +45,15 @@ ripe:
4145

4246
## Credentials
4347

44-
The following secrets are read from 1Password via the `op` CLI:
48+
Secrets are fetched from 1Password via the `op` CLI. The `credentials` block in the config file specifies the 1Password reference for each secret:
4549

46-
| Secret | Used for |
47-
|--------|----------|
48-
| `op://Code/Mozilla - RIPE NNC/username` | RIPE DB REST API (Basic auth) |
49-
| `op://Code/Mozilla - RIPE NNC/credential` | RIPE DB REST API (Basic auth) |
50-
| `op://Code/Mozilla - RIPE NNC/RPKI API Key` | RIPE RPKI Management API |
50+
| Field | Used for |
51+
|-------|----------|
52+
| `db_username` | RIPE DB REST API username |
53+
| `db_password` | RIPE DB REST API password |
54+
| `rpki_api_key` | RIPE RPKI Management API key |
55+
56+
References use the `op://vault/item/field` format. You must be signed in to the 1Password CLI (`op signin`) before running the tool.
5157

5258
## Usage
5359

0 commit comments

Comments
 (0)