XDG directories #562

New issue

Closed

opened 2022-07-09 19:36:22 +00:00 by pikeas · 6 comments

pikeas commented 2022-07-09 19:36:22 +00:00

Copy link

It would be nice if Borgmatic supported the XDG spec (~/.config, ~/.local, etc). There's a Python package that can be used to enable this: https://github.com/ActiveState/appdirs

It would be nice if Borgmatic supported the XDG spec (`~/.config`, `~/.local`, etc). There's a Python package that can be used to enable this: https://github.com/ActiveState/appdirs

witten commented 2022-07-09 22:46:40 +00:00

Owner

Copy link

Thanks for filing this! By default, borgmatic already looks in ~/.config/borgmatic/config.yaml and ~/.config/borgmatic.d/ for configuration files. And the ~/.config prefix is customizable via the standard XDG_CONFIG_HOME environment variable. Is the idea that you'd like other paths to be used by default on non-Linux OSes, e.g. MacOS?

And for ~/.local, is the the thinking that's where the existing ~/.borgmatic user data would be stored instead?

Thanks for filing this! By default, borgmatic already looks in `~/.config/borgmatic/config.yaml` and `~/.config/borgmatic.d/` for configuration files. And the `~/.config` prefix is customizable via the standard `XDG_CONFIG_HOME` environment variable. Is the idea that you'd like other paths to be used by default on non-Linux OSes, e.g. MacOS? And for `~/.local`, is the the thinking that's where the existing `~/.borgmatic` user data would be stored instead?

pikeas commented 2022-07-30 17:57:20 +00:00

Author

Copy link

And for ~/.local, is the the thinking that's where the existing ~/.borgmatic user data would be stored instead?

Yes, sorry for the late reply. XDG_DATA_HOME (defaulting to ~/.local/share) is the XDG-compliant directory for user-specific app data. It would be nice-to-have if borgmatic fully implemented XDG.

> And for `~/.local`, is the the thinking that's where the existing `~/.borgmatic` user data would be stored instead? Yes, sorry for the late reply. `XDG_DATA_HOME` (defaulting to `~/.local/share`) is the XDG-compliant directory for user-specific app data. It would be nice-to-have if borgmatic fully implemented XDG.

pikeas commented 2022-07-30 17:59:40 +00:00

Author

Copy link

There's also XDG_DATA_STATE_HOME, depending on whether Borgmatic's checks/ is considered "user data" or "user state".

There's also `XDG_DATA_STATE_HOME`, depending on whether Borgmatic's `checks/` is considered "user data" or "user state".

witten commented 2023-03-26 22:02:44 +00:00

Owner

Copy link

I apologize for the delay here. I think this would be a good change in terms of standardization. The main difficulty is that the ~/.borgmatic path currently gets encoded into database backup archives in the form of dump file paths. So if changing those paths (either implicitly by default or explicitly with an option), the database restore logic might need to be updated to probe both paths within a backup archive.

Note that there is an existing borgmatic_source_directory that configures this ~/.borgmatic directory, and changing that will just unceremoneously break restores of any existing backups. However this is a comment warning of this above the option.

I apologize for the delay here. I think this would be a good change in terms of standardization. The main difficulty is that the `~/.borgmatic` path currently gets encoded into database backup archives in the form of dump file paths. So if changing those paths (either implicitly by default or explicitly with an option), the database restore logic might need to be updated to probe both paths within a backup archive. Note that there is an existing `borgmatic_source_directory` that configures this `~/.borgmatic` directory, and changing that will just unceremoneously break restores of any existing backups. However this is a comment warning of this above the option.

witten referenced this issue 2024-03-12 04:04:07 +00:00

Nicer structure for auto-added files #838

witten commented 2024-03-12 04:04:31 +00:00

Owner

Copy link

Relevant reference: https://wiki.archlinux.org/title/XDG_Base_Directory

Also see #838 for a related ticket.

EDIT: #638 is also related.

Relevant reference: https://wiki.archlinux.org/title/XDG_Base_Directory Also see #838 for a related ticket. EDIT: #638 is also related.

witten referenced this issue from a commit 2024-10-31 05:38:23 +00:00

Move the default check state directory (#562, #638). Deprecate the "borgmatic_source_directory" option in favor of "borgmatic_runtime_directory" and "borgmatic_state_directory" (#562).

witten referenced this issue 2024-10-31 05:42:48 +00:00

Question: Why is /root/.borgmatic being backed up? #638

witten referenced this issue from a commit 2024-11-03 21:14:36 +00:00

Deprecate the "borgmatic_source_directory" option in favor of "user_runtime_directory" and "user_state_directory" (#562). Move the default borgmatic streaming database dump and bootstrap metadata location on disk (#562). With Borg 1.4+, store database dumps and bootstrap metadata in a "/borgmatic" directory within a backup archive (#838). Add "--local-path", "--remote-path", and "--user-runtime-directory" flags to the "config bootstrap" action.

witten commented 2024-11-03 21:31:56 +00:00

Owner

Copy link

Released in borgmatic 1.9.0!

There were several changes made as part of this:

• #562: Deprecate the "borgmatic_source_directory" option in favor of "user_runtime_directory" and "user_state_directory".
• #562: BREAKING: Move the default borgmatic streaming database dump and bootstrap metadata directory from ~/.borgmatic to /run/user/$UID/borgmatic, which is more XDG-compliant. You can override this location with the new "user_runtime_directory" option. Existing archives with database dumps at the old location are still restorable.
• #562, #638: Move the default check state directory from ~/.borgmatic to ~/.local/state/borgmatic. This is more XDG-compliant and also prevents these state files from getting backed up (unless you explicitly include them). You can override this location with the new "user_state_directory" option. After the first time you run the "check" action with borgmatic 1.9.0, you can safely delete the ~/.borgmatic directory.

Released in borgmatic 1.9.0! There were several changes made as part of this: * #562: Deprecate the "borgmatic_source_directory" option in favor of "user_runtime_directory" and "user_state_directory". * #562: BREAKING: Move the default borgmatic streaming database dump and bootstrap metadata directory from ~/.borgmatic to /run/user/$UID/borgmatic, which is more XDG-compliant. You can override this location with the new "user_runtime_directory" option. Existing archives with database dumps at the old location are still restorable. * #562, #638: Move the default check state directory from ~/.borgmatic to ~/.local/state/borgmatic. This is more XDG-compliant and also prevents these state files from getting backed up (unless you explicitly include them). You can override this location with the new "user_state_directory" option. After the first time you run the "check" action with borgmatic 1.9.0, you can safely delete the ~/.borgmatic directory.

witten closed this issue 2024-11-03 21:31:56 +00:00

thomastc referenced this issue 2024-11-13 10:45:29 +00:00

borgmatic run as a system service should not use /run/user/$UID #934

Sign in to join this conversation.

No Branch/Tag specified

Branches Tags

main

parallel-borgmatic

command-hook-steps

2.1.5

2.1.4

2.1.3

2.1.2

2.1.1

2.1.0

2.0.13

2.0.12

2.0.11

2.0.10

2.0.9

2.0.8

2.0.7

2.0.6

2.0.5

2.0.4

2.0.3

2.0.2

2.0.1

2.0.0

1.9.14

1.9.13

1.9.12

1.9.11

1.9.10

1.9.9

1.9.8

1.9.7

1.9.6

1.9.5

1.9.4

1.9.3

1.9.2

1.9.1

1.9.0

1.8.14

1.8.13

1.8.12

1.8.11

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   

blocked

  

breaking

  

bug

  

data loss

  

design finalized

  

good first issue

  

new feature area

  

question / support

  

security

  

waiting for response

No labels

blocked

breaking

bug

data loss

design finalized

good first issue

new feature area

question / support

security

waiting for response

Milestone

Clear milestone

No items

No milestone

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

2 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#562

No description provided.