Support user directory expansion everywhere #422

New Issue

Open

opened 2021-05-30 20:09:01 +00:00 by Alexander-Shukaev · 3 comments

Alexander-Shukaev commented 2021-05-30 20:09:01 +00:00

Copy Link

Apart from source_directories, none of the configuration options seem to support tilde (~). That is such paths are passed through as is to borg or otherwise acted upon by borgmatic without applying os.path.expanduser. Would be nice to have this feature applied to paths coming from configuration file in general. Perhaps normalizing (sanitizing) paths is also a good idea.

Apart from `source_directories`, none of the configuration options seem to support tilde (`~`). That is such paths are passed through as is to `borg` or otherwise acted upon by `borgmatic` without applying `os.path.expanduser`. Would be nice to have this feature applied to paths coming from configuration file in general. Perhaps normalizing (sanitizing) paths is also a good idea.

👍 1

witten commented 2021-06-07 17:52:55 +00:00

Owner

Copy Link

This seems reasonable to me, but I'm curious: Are there specific options where you'd like to see expansion applied? Candidates I'm seeing:

• patterns_from
• excludes_from
• borgmatic_source_directory
• temporary_directory
• borg_*_directory
• repositories and check_repositories: Already expands ~ implicitly for remote repositories due to SSH being used. I suppose it'd be handy to expand for local repository paths too?
• PostgreSQL ssl_* paths.

Ones I'd probably omit:

• patterns: Would require annoying parsing, as it's not just plain paths.
• encryption_passcommand: May require parsing so as not to expand command arguments, too.
• hooks: Same reason.

Let me know your thoughts. Thanks!

This seems reasonable to me, but I'm curious: Are there specific options where you'd like to see expansion applied? Candidates I'm seeing: * `patterns_from` * `excludes_from` * `borgmatic_source_directory` * `temporary_directory` * `borg_*_directory` * `repositories` and `check_repositories`: Already expands `~` implicitly for remote repositories due to SSH being used. I suppose it'd be handy to expand for local repository paths too? * PostgreSQL `ssl_*` paths. Ones I'd probably omit: * `patterns`: Would require annoying parsing, as it's not just plain paths. * `encryption_passcommand`: May require parsing so as not to expand command arguments, too. * `hooks`: Same reason. Let me know your thoughts. Thanks!

ams_tschoening commented 2021-07-15 08:15:08 +00:00

Copy Link

encryption_passcommand: May require parsing so as not to expand command arguments, too.

Though, that's exactly the use case I'm interested in: I have a setup with one special user doing backups, maintaining all data necessary for borg in its home directory and I store passwords there as well. The entire home is stored on an encrypted ZFS, which gets mounted manually, so it's somewhat safe. Therefore, my passcommand looks like the following right now:

encryption_passcommand: cat /home/ams_d_bak_borg/.config/borg/passwds/hosts

While it would be a little easier to have the following instead:

encryption_passcommand: cat ~/.config/borg/passwds/hosts

Slightly less typing and things are better prepared against additional backup users or a renamed user or a relocated home directory or alike. cat is even used in the official borg-docs, so supporting ~ for its arguments makes sense to me.

> encryption_passcommand: May require parsing so as not to expand command arguments, too. Though, that's exactly the use case I'm interested in: I have a setup with one special user doing backups, maintaining all data necessary for borg in its home directory and I store passwords there as well. The entire home is stored on an encrypted ZFS, which gets mounted manually, so it's somewhat safe. Therefore, my passcommand looks like the following right now: encryption_passcommand: cat /home/ams_d_bak_borg/.config/borg/passwds/hosts While it would be a little easier to have the following instead: encryption_passcommand: cat ~/.config/borg/passwds/hosts Slightly less typing and things are better prepared against additional backup users or a renamed user or a relocated home directory or alike. `cat` is even used in the official borg-docs, so supporting `~` for its arguments makes sense to me.

witten commented 2021-07-16 15:49:30 +00:00

Owner

Copy Link

Thanks, that example is helpful. It sounds like it's actually the command arguments that you want expanded! So the way I could see this working is to split the value of encryption_passcommand (and other options that are passed to Borg via environment variables), expand each individual command/argument in case there are tildes, and then join them back together. I think that would achieve what you're looking for.

Thanks, that example is helpful. It sounds like it's actually the command arguments that you want expanded! So the way I could see this working is to split the value of `encryption_passcommand` (and other options that are passed to Borg via environment variables), expand each individual command/argument in case there are tildes, and then join them back together. I think that would achieve what you're looking for.

👍 1

witten added the

good first issue

label 2023-03-27 19:05:36 +00:00

Sign in to join this conversation.

No Branch/Tag Specified

Branches Tags

main

spot-check

1.8.10

1.8.9

1.8.8

1.8.7

1.8.6

1.8.5

1.8.4

1.8.3

1.8.2

1.8.1

1.8.0

1.7.15

1.7.14

1.7.13

1.7.12

1.7.11

1.7.10

1.7.9

1.7.8

1.7.7

1.7.6

1.7.5

1.7.4

1.7.3

1.7.2

1.7.1

1.7.0

1.6.6

1.6.5

1.6.4

1.6.3

1.6.2

1.6.1

1.6.0

1.5.24

1.5.23

1.5.22

1.5.21

1.5.20

1.5.19

1.5.18

1.5.17

1.5.16

1.5.15

1.5.14

1.5.13

1.5.12

1.5.11

1.5.10

1.5.9

1.5.8

1.5.7

1.5.7.dev0

1.5.6

1.5.5

1.5.4

1.5.3

1.5.2

1.5.1

1.5.0

1.4.22

1.4.21

1.4.20

1.4.19

1.4.18

1.4.17

1.4.16

1.4.15

1.4.14

1.4.13

1.4.12

1.4.11

1.4.10

1.4.9

1.4.8

1.4.7

1.4.6

1.4.5

1.4.4

1.4.3

1.4.2

1.4.1

1.4.0

1.3.26

1.3.25

1.3.24

1.3.23

1.3.22

1.3.21

1.3.20

1.3.19

1.3.18

1.3.17

1.3.16

1.3.15

1.3.14

1.3.13

1.3.12

1.3.11

1.3.10

1.3.9

1.3.8

1.3.7

1.3.6

1.3.5

1.3.4

1.3.3

1.3.2

1.3.1

1.3.0

1.2.18

1.2.17

1.2.16

1.2.15

1.2.14

1.2.13

1.2.12

1.2.11

1.2.10

1.2.9

1.2.8

1.2.7

1.2.6

1.2.5

1.2.4

1.2.3

1.2.2

1.2.1

1.2.0

1.1.15

1.1.14

1.1.13

1.1.12

1.1.11

1.1.10

1.1.9

1.1.7

1.1.6

1.1.5

1.1.4

1.1.3

1.1.2

1.1.1

1.1.0

1.0.3

1.0.2

1.0.1

1.0.0

0.1.8

0.1.7

0.1.6

0.1.5

0.1.4

0.1.3

0.1.2

0.1.1

0.1.0

0.0.7

0.0.6

0.0.5

0.0.4

0.0.3

0.0.2

Labels

Clear labels   

bug

  

data loss

  

design finalized

  

good first issue

  

new feature area

  

question / support

  

security

  

waiting for response

No Label

bug

data loss

design finalized

good first issue

new feature area

question / support

security

waiting for response

Milestone

Clear milestone

No items

No Milestone

Assignees

Clear assignees

No Assignees

3 Participants

Notifications

Subscribe

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: borgmatic-collective/borgmatic#422

No description provided.