sops icon indicating copy to clipboard operation
sops copied to clipboard

Misleading README.rst regarding .env file partial encryption support

Open liamjones-pw opened this issue 8 months ago • 2 comments

Hi!

So the README.rst states:

Encrypting only parts of a file
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Note: this only works on YAML and JSON files, not on BINARY files.

By default, SOPS encrypts all the values of a YAML or JSON file and leaves the
keys in cleartext. In some instances, you may want to exclude some values from
being encrypted. This can be accomplished by adding the suffix **_unencrypted**
to any key of a file. When set, all values underneath the key that set the
**_unencrypted** suffix will be left in cleartext.

However when testing, we found that ENV files are supported as well.

Is this simply a case that the someone forgot to update the docs or?

liamjones-pw avatar Apr 15 '25 04:04 liamjones-pw

Thanks for reporting this!

Is this simply a case that the someone forgot to update the docs

Yes...

felixfontein avatar Apr 15 '25 04:04 felixfontein

I'm happy to make a pull request updating this, if that's convenient for you.

liamjones-pw avatar Apr 16 '25 02:04 liamjones-pw

Sorry, I completely forgot to reply... I've created a PR now (#1895) since I also found a few more places...

felixfontein avatar Jul 23 '25 11:07 felixfontein

All good, I also forgot! 😅

liamjones-pw avatar Jul 30 '25 01:07 liamjones-pw