Configuration reference minor documentation suggestion #769

New Issue

y8s · 2023-10-10T15:22:34Z

y8s commented

2023-10-10 15:22:34 +00:00

What I'd like to do and why

A while back there was an option to store a passphrase externally in a separate yaml file.

something like this:

storage:
    <<: !include /etc/borgmatic.d/secret/borgbase.yaml

inside borgbase.yaml:

encryption_passphrase: "thisIsMySuperSecretPassphrase"

but now storage: is deprecated and there's no more reference for this in th current configuration reference doc at https://torsion.org/borgmatic/docs/reference/configuration/

However after a quick test, it looks like just leaving the line

<<: !include /etc/borgmatic.d/secret/borgbase.yaml

still works fine.

So is it legit and can we use it indefinitely? If so, you may want to add a note in the docs about it.

Thanks!

Other notes / implementation ideas

No response

### What I'd like to do and why A while back there was an option to store a passphrase externally in a separate yaml file. something like this: ``` storage: <<: !include /etc/borgmatic.d/secret/borgbase.yaml ``` inside borgbase.yaml: ``` encryption_passphrase: "thisIsMySuperSecretPassphrase" ``` but now `storage:` is deprecated and there's no more reference for this in th current configuration reference doc at https://torsion.org/borgmatic/docs/reference/configuration/ However after a quick test, it looks like just leaving the line ``` <<: !include /etc/borgmatic.d/secret/borgbase.yaml ``` still works fine. So is it legit and can we use it indefinitely? If so, you may want to add a note in the docs about it. Thanks! ### Other notes / implementation ideas _No response_

witten referenced this issue from a commit

2023-10-10 16:17:37 +00:00

Add documentation note about using includes for specifying passphrases (#769).

witten commented

2023-10-10 16:20:55 +00:00

Yes, this is legit and it should continue working. Note that this variant should also work:

encryption_passphrase: !include /etc/borgmatic.d/secret/borgbase.yaml

... where borgbase.yaml is just:

thisIsMySuperSecretPassphrase

Either approach is fine though. The benefit of this approach is you can see what option is being included at a glance. The benefit of the other approach is you can include multiple options at once.

I added a general note to https://torsion.org/borgmatic/docs/how-to/provide-your-passwords/ and it should publish shortly. Thanks for the suggestion!

Yes, this is legit and it should continue working. Note that this variant should also work: ```yaml encryption_passphrase: !include /etc/borgmatic.d/secret/borgbase.yaml ``` ... where `borgbase.yaml` is just: ```yaml thisIsMySuperSecretPassphrase ``` Either approach is fine though. The benefit of this approach is you can see what option is being included at a glance. The benefit of the other approach is you can include multiple options at once. I added a general note to https://torsion.org/borgmatic/docs/how-to/provide-your-passwords/ and it should publish shortly. Thanks for the suggestion!

witten closed this issue

2023-10-10 16:20:55 +00:00

witten added the

question / support

label 2023-10-10 16:21:04 +00:00

Sign in to join this conversation.