dtomlinson/csops
1
0
Fork 0
mirror of https://github.com/dtomlinson91/csops.git synced 2025-12-21 21:35:45 +00:00
Code Issues Projects Releases Wiki Activity

doc: update README with config example #1

Browse Source
This commit is contained in:
Daniel Tomlinson
2022-01-17 23:14:20 +00:00
parent f654d199ee
commit ebff9e901f
1 changed files with 17 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -6,6 +6,23 @@ Wrapper around [mozilla/sops](https://github.com/mozilla/sops).
`pipx install git+https://github.com/dtomlinson91/csops`
## Configuration
Either use a `config.yml` or use environment variables.
If using a `config.yml` create this file in either `~/.config/csops/` or a custom directory. If using a custom directory set the environment variable `CSOPS_CONFIG` equal to this directory.
### GCP KMS Key
If using a `config.yml` set the `gcp_mks_key` under the `csops` header:
```yml
csops:
gcp_kms_key: projects/plex-mozilla-sops/locations/global/keyRings/sops/cryptoKeys/sops-key
```
Or set the environment variable `CSOPS_GCP_KMS_KEY="projects/plex-mozilla-sops/locations/global/keyRings/sops/cryptoKeys/sops-keys"`
## Usage
Encrypt: `csops e test.log`