Example of configuration file in the repo? #119

New Issue

Closed

opened 2018-12-20 11:45:59 +00:00 by patricko · 7 comments

patricko commented 2018-12-20 11:45:59 +00:00

Copy Link

Where can I find an example of the latest configuration file in the repo?

It seems like it's generated upon installation but there could be an example in the repo directly, please :)

Where can I find an example of the latest configuration file in the repo? It seems like it's generated upon installation but there could be an example in the repo directly, please :)

witten added the question / support label 2018-12-24 20:46:13 +00:00

witten commented 2018-12-24 20:51:07 +00:00

Owner

Copy Link

There are two things right now:

1. The full configuration schema is checked in to the repo, and also linked from the documentation.

2. The generate-borgmatic-config command mentioned in that documentation generates an example configuration file.

The reason that there isn't an example configuration file directly checked into the repo is that it would be duplicative with the schema (generate-borgmatic-config uses the schema to generate the config file), and both would have to be updated in lockstep or risk drifting out of sync.

Do you have a use case where generate-borgmatic-config isn't convenient enough for getting an example config file, and an example file directly in the repo would be better?

There are two things right now: 1. The full configuration `schema` is [checked in to the repo](https://projects.torsion.org/witten/borgmatic/src/branch/master/borgmatic/config/schema.yaml), and also linked from the [documentation](https://torsion.org/borgmatic/#configuration). 2. The `generate-borgmatic-config` command mentioned in that documentation generates an example configuration file. The reason that there isn't an example configuration file directly checked into the repo is that it would be duplicative with the schema (`generate-borgmatic-config` uses the schema to generate the config file), and both would have to be updated in lockstep or risk drifting out of sync. Do you have a use case where `generate-borgmatic-config` isn't convenient enough for getting an example config file, and an example file directly in the repo would be better?

patricko commented 2018-12-25 11:04:01 +00:00

Author

Copy Link

Well when I set borg instalaltion with ansible, I do'nt necessarily have borgmatic on my local computer, so it means I need to generate a configuration (considering I remember that I have to generate a default configuration file unlike other programs :P) then open it in nano and copy paste to my IDE. :D quite unpractical but well as you wish

Well when I set borg instalaltion with ansible, I do'nt necessarily have borgmatic on my local computer, so it means I need to generate a configuration (considering I remember that I have to generate a default configuration file unlike other programs :P) then open it in nano and copy paste to my IDE. :D quite unpractical but well as you wish

witten commented 2018-12-25 17:47:24 +00:00

Owner

Copy Link

Gotcha. I wonder if there'd be some way to make a generated example config file available online, perhaps as a borgmatic build artifact, so you could download to your local machine and edit it in an IDE there. That might satisfy your need without having to maintain both the schema and the config file duplicatively in the same repo.

Gotcha. I wonder if there'd be some way to make a generated example config file available online, perhaps as a borgmatic build artifact, so you could download to your local machine and edit it in an IDE there. That might satisfy your need without having to maintain both the schema and the config file duplicatively in the same repo.

witten removed the question / support label 2018-12-26 00:36:42 +00:00

patricko commented 2018-12-29 14:57:30 +00:00

Author

Copy Link

Why you don't just run the generate script and include the result in the git repo? or even automate it? Maybe with a git hook before creating a release? (dunno if possible)

But yes, it would work too.

Why you don't just run the generate script and include the result in the git repo? or even automate it? Maybe with a git hook before creating a release? (dunno if possible) But yes, it would work too.

witten commented 2018-12-29 21:16:58 +00:00

Owner

Copy Link

That might work, but it'd be a little tricky. For instance, with a git hook, you'd have to be careful so that checking in the result of the generate script doesn't itself trigger a git hook and get into an infinite loop! It may just be more straightforward to publish the example config somewhere in the form of a build artifact, and then link to it from the README.

That might work, but it'd be a little tricky. For instance, with a git hook, you'd have to be careful so that checking in the result of the generate script doesn't itself trigger a git hook and get into an infinite loop! It may just be more straightforward to publish the example config somewhere in the form of a build artifact, and then link to it from the README.

witten referenced this issue from a commit 2019-02-05 06:17:03 +00:00

Include a sample borgmatic configuration file in the documentation (#119).

witten commented 2019-02-05 06:21:06 +00:00

Owner

Copy Link

Done! https://torsion.org/borgmatic/docs/reference/configuration/

That's linked from the main documentation page: https://torsion.org/borgmatic/

It's also mentioned in the borgmatic set up docs: https://torsion.org/borgmatic/docs/how-to/set-up-backups/

Thanks for the suggestion.

Done! https://torsion.org/borgmatic/docs/reference/configuration/ That's linked from the main documentation page: https://torsion.org/borgmatic/ It's also mentioned in the borgmatic set up docs: https://torsion.org/borgmatic/docs/how-to/set-up-backups/ Thanks for the suggestion.

witten closed this issue 2019-02-05 06:21:07 +00:00

patricko commented 2019-02-14 16:14:44 +00:00

Author

Copy Link

thank you :)

thank you :)

Sign in to join this conversation.

No Branch/Tag Specified

Branches Tags

main

command-hook-steps

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 Label

Milestone

No items

No Milestone

Assignees

Clear assignees

witten

No Assignees

2 Participants

Notifications

Subscribe

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: borgmatic-collective/borgmatic#119