Restic: Difference between revisions

Klinger (talk | contribs)
Expand intro and add configuration options
Line 1: Line 1:
[https://restic.net/ Restic] is a fast and secure backup program.
[https://restic.net/ Restic] is a fast and secure backup program. NixOS packages both <code>restic</code> client (program used to make backups) and <code>restic-rest-server</code> (one of the backends to store the backups remotely, "repository" in restic parlance).


== Installing ==
== Installing ==


Add <code>restic</code> to <code>environment.systemPackages</code> like so:
If you want to manually create restic backups, add <code>restic</code> to <code>environment.systemPackages</code> like so:


<syntaxHighlight lang=nix>
<syntaxHighlight lang=nix>
Line 10: Line 10:
];
];
</syntaxHighlight>
</syntaxHighlight>
== Configuring ==
=== Restic ===
NixOS provides options to create a systemd timer and a service that will create the backups. See [https://search.nixos.org/options?channel=unstable&from=0&size=50&sort=relevance&type=packages&query=services.restic.backups services.restic.backups options].
=== Restic Rest Server ===
Restic Rest Server is one of the options for a remote repository<ref>https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#rest-server</ref>. It can be installed by enabling the <code>services.restic.server.enable</code> option. By default the server requires either providing it with <code>htpasswd</code> file or running it without authentication. If provided, the username and password pairs <code>htpassd</code> file will be used to authenticate the restic clients connecting to the server. To run the server without authentication, you can pass the flag using the <code>extraFlags</code> option like this: <code>services.restic.server.extraFlags = [ "--no-auth" ];</code>
Passing the <code>htpasswd</code> file should be done using one of the [[Comparison of secret managing schemes|secret management methods]].


== Security Wrapper ==
== Security Wrapper ==