Skip to content

Commit 60ea3ac

Browse files
authored
Merge pull request #1844 from md42/patch-1
use bullet points for structure
2 parents 31ac73f + dcc6216 commit 60ea3ac

File tree

1 file changed

+20
-8
lines changed

1 file changed

+20
-8
lines changed

README.rst

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -221,14 +221,26 @@ the ``--age`` option or the **SOPS_AGE_RECIPIENTS** environment variable:
221221
222222
When decrypting a file with the corresponding identity, SOPS will look for a
223223
text file name ``keys.txt`` located in a ``sops`` subdirectory of your user
224-
configuration directory. On Linux, this would be ``$XDG_CONFIG_HOME/sops/age/keys.txt``.
225-
If ``$XDG_CONFIG_HOME`` is not set ``$HOME/.config/sops/age/keys.txt`` is used instead.
226-
On macOS, this would be ``$HOME/Library/Application Support/sops/age/keys.txt``. On
227-
Windows, this would be ``%AppData%\sops\age\keys.txt``. You can specify the location
228-
of this file manually by setting the environment variable **SOPS_AGE_KEY_FILE**.
229-
Alternatively, you can provide the key(s) directly by setting the **SOPS_AGE_KEY**
230-
environment variable. Alternatively, you can provide a command to output the age keys
231-
by setting the **SOPS_AGE_KEY_CMD** environment variable.
224+
configuration directory.
225+
226+
- **Linux**
227+
228+
- Looks for `keys.txt` in `$XDG_CONFIG_HOME/sops/age/keys.txt`;
229+
- Falls back to `$HOME/.config/sops/age/keys.txt` if `$XDG_CONFIG_HOME` isn’t set.
230+
231+
- **macOS**
232+
233+
- Looks for `keys.txt` in `$HOME/Library/Application Support/sops/age/keys.txt`.
234+
235+
- **Windows**
236+
237+
- Looks for `keys.txt` in `%AppData%\sops\age\keys.txt`.
238+
239+
You can override the default lookup by:
240+
241+
- setting the environment variable **SOPS_AGE_KEY_FILE**;
242+
- setting the **SOPS_AGE_KEY** environment variable;
243+
- providing a command to output the age keys by setting the **SOPS_AGE_KEY_CMD** environment variable..
232244

233245
The contents of this key file should be a list of age X25519 identities, one
234246
per line. Lines beginning with ``#`` are considered comments and ignored. Each

0 commit comments

Comments
 (0)