Allow lockfile path to be configured

[dotboris]

The goal of this feature is to allow users to control the path of the lockfile. This is useful in situations where you don't want the lockfile to default next to the config file.

For my use case, I want to generate the config file with Nix which will store it in a read-only path. In such a situation autorestic won't be able to create the lockfile. This flag will let me specify a different writable path for the lockfile.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
autorestic	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 10, 2024 7:00pm

[PHLAK]

I just started using autorestic and was looking for a way to control this. My reasoning is that I'm putting the config file in /etc/autorestic and running it on a schedule with a systemd timer but having the lock file in /etc doesn't make sense. I want to put it in /run/lock or somewhere similar.

[PHLAK]

Also, it would be nice if we could set the lockfile path in the config file similar to the cache-dir.

version: 2

global:
  all:
    cache-dir: /var/cache/restic
    lockfile-dir: /run/lock/restic/

...

[dotboris]

I like the idea of specifying the lockfile through the config file. It makes a ton of sense to me.

I don't think that we can fit this under the global section tho. That section is meant to host options (as in command line options) that are passed to restic based on the command line. In your example, global.all.cache-dir = /var/cache/restic makes it so that every restic command gets called with --cache-dir /var/cache/restic. Since this lockfile is an autorestic concept it can't really live in there.

What do you think of adding this option at the root of the config. So it'd be something like this:

version: 2
lockfile: /var/lock/restic/autorestic.lock.yaml

global:
  all:
    cache-dir: ...

...

Note that in my example lockfile points to a file and not a directory because there's really only one lockfile for autorestic.

[PHLAK]

I don't think that we can fit this under the global section tho. That section is meant to host options (as in command line options) that are passed to restic based on the command line.

That's true. Making it a top-level configuration option makes sense then.

Note that in my example lockfile points to a file and not a directory because there's really only one lockfile for autorestic.

I was debating this myself in my example so I think this also makes sense.

[dotboris]

I've implemented the basic functionality of reading the lockfile path from the config. I still need to do some of the finishing touches: documentation and tests.