diff --git a/README.rst b/README.rst index ce3b47a46..4db1ced66 100644 --- a/README.rst +++ b/README.rst @@ -221,14 +221,26 @@ the ``--age`` option or the **SOPS_AGE_RECIPIENTS** environment variable: When decrypting a file with the corresponding identity, SOPS will look for a text file name ``keys.txt`` located in a ``sops`` subdirectory of your user -configuration directory. On Linux, this would be ``$XDG_CONFIG_HOME/sops/age/keys.txt``. -If ``$XDG_CONFIG_HOME`` is not set ``$HOME/.config/sops/age/keys.txt`` is used instead. -On macOS, this would be ``$HOME/Library/Application Support/sops/age/keys.txt``. On -Windows, this would be ``%AppData%\sops\age\keys.txt``. You can specify the location -of this file manually by setting the environment variable **SOPS_AGE_KEY_FILE**. -Alternatively, you can provide the key(s) directly by setting the **SOPS_AGE_KEY** -environment variable. Alternatively, you can provide a command to output the age keys -by setting the **SOPS_AGE_KEY_CMD** environment variable. +configuration directory. + +- **Linux** + + - Looks for `keys.txt` in `$XDG_CONFIG_HOME/sops/age/keys.txt`; + - Falls back to `$HOME/.config/sops/age/keys.txt` if `$XDG_CONFIG_HOME` isn’t set. + +- **macOS** + + - Looks for `keys.txt` in `$HOME/Library/Application Support/sops/age/keys.txt`. + +- **Windows** + + - Looks for `keys.txt` in `%AppData%\sops\age\keys.txt`. + +You can override the default lookup by: + +- setting the environment variable **SOPS_AGE_KEY_FILE**; +- setting the **SOPS_AGE_KEY** environment variable; +- providing a command to output the age keys by setting the **SOPS_AGE_KEY_CMD** environment variable.. The contents of this key file should be a list of age X25519 identities, one per line. Lines beginning with ``#`` are considered comments and ignored. Each