Skip to content

Improvements to user documentation #111

@BinaryWarlock

Description

@BinaryWarlock

I'm a new user and found the user documentation rather sparse and had me googling a lot to figure out what is supported and how to do it.

  • The docs don't show how to enable compression. The only mention of it is in the FAQ (which just vaguely references a --compression flag, but really you need to initialize it with rustic init --set-compression <N>, which is difficult to find.)
    This should be mentioned in the Getting Started guide and Initializing a Repository. It should also be mentioned that the default is no compression.

  • There's no message indicating that compression was enabled, nor is it clear how to check if it's enabled on a repository. I believe rustic init should indicate the compression level and it should show up in the config or repoinfo somewhere.

  • It's not clear if there is a way to limit the number of threads used by rustic backup. It seems to use a lot of CPU time for the duration of it (which may be hours), which can slow down other tasks, so I'd rather the level of parallelism be configurable.

  • It's not clear how to verify if a set of local files (or a local directory) is present and validate it in snapshots. Googling shows there is a rustic diff that may do this, but that should be documented feature.

  • Related: Is there something like borgmatic's spot check, i.e., giving it a local directory and telling it to verify x% of it with a snapshot? If not, that would be awesome. I know that rustic check has --read-data-subset but it cannot, AFAICT, take in a local directory as a source.

  • --no-cache / no-cache = true should probably be mentioned in the Getting Started guide and "Preparing a new repository > Local backend" for local backends.

  • It's not stated what encryption is used.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions