getsops/sops
1
0
Fork 0
mirror of https://github.com/getsops/sops.git synced 2026-02-05 12:45:21 +01:00
Code Issues Activity

Reorder README sections and fix RST link.

Browse Source
This commit is contained in:
Jimmy Cuadra
2020-08-02 23:51:31 -07:00
parent ade5692dcc
commit a66a0a8429
1 changed files with 15 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
README.rst
View File

@@ -164,10 +164,24 @@ Given that, the only command a ``sops`` user needs is:
encrypted if modified, and saved back to its original location. All of these
steps, apart from the actual editing, are transparent to the user.
Test with the dev PGP key
~~~~~~~~~~~~~~~~~~~~~~~~~
If you want to test **sops** without having to do a bunch of setup, you can use
the example files and pgp key provided with the repository::
$ git clone https://github.com/mozilla/sops.git
$ cd sops
$ gpg --import pgp/sops_functional_tests_key.asc
$ sops example.yaml
This last step will decrypt ``example.yaml`` using the test private key.
Encrypting using age
~~~~~~~~~~~~~~~~~~~~
`age<https://age-encryption.org/>`_ is a simple, modern, and secure tool for
`age <https://age-encryption.org/>`_ is a simple, modern, and secure tool for
encrypting files. It's recommended to use age over PGP, if possible.
You can encrypt a file for one or more age recipients (comma separated) using
@@ -190,19 +204,6 @@ identity will be tried in sequence until one is able to decrypt the data.
Encrypting with SSH keys via age is not yet supported by sops.
Test with the dev PGP key
~~~~~~~~~~~~~~~~~~~~~~~~~
If you want to test **sops** without having to do a bunch of setup, you can use
the example files and pgp key provided with the repository::
$ git clone https://github.com/mozilla/sops.git
$ cd sops
$ gpg --import pgp/sops_functional_tests_key.asc
$ sops example.yaml
This last step will decrypt ``example.yaml`` using the test private key.
Encrypting using GCP KMS
~~~~~~~~~~~~~~~~~~~~~~~~