borg: add page #1631
borg: add page #1631
Conversation
|
|
|
The build for this PR has failed with the following error(s): Please fix the error(s) and push again. |
|
@ckovsky - Please sign the CLA. We can get on with the review after that. |
pages/common/borg.md
Outdated
| # borg | ||
|
|
||
| > Deduplicating backup tool with compression and encryption. | ||
| > Supports local and remote backups, mountable as filesystems. |
There was a problem hiding this comment.
Does this mean that the remote backups have to be mounted as a file system, or that backs can be mounted as a file system?
There was a problem hiding this comment.
It's the backups that can be mountable. But borg can backup remotely over ssh. The command for an init would look like:
$ borg init user@hostname:backup
I wasn't sure whether to include a remote example or not. Wanted to keep it simple :-)
There was a problem hiding this comment.
Maybe the description could be simplified. It sounds a bit like an ad...
pages/common/borg.md
Outdated
|
|
||
| - Backup a folder into the repository, creating an archive called Monday: | ||
|
|
||
| `borg create --progress {{/path/to/repo/folder::Monday}} {{/path/to/source/folder}}` |
There was a problem hiding this comment.
Are the :: required here? Perhaps we could tweak this to {{/path/to/repo/folder}}::{{Monday}} if that's the case?
There was a problem hiding this comment.
Yeah, the :: are part of the syntax. I like the suggestion of separating the archive name.
pages/common/borg.md
Outdated
|
|
||
| - Extract a specific folder from the 'Monday' archive, excluding all *.ext files: | ||
|
|
||
| `borg extract {{/path/to/repo/folder::Monday}} {{path/to/target/folder}} --exclude '*.ext'` |
There was a problem hiding this comment.
Perhaps you could put {{ and }} around *.ext? Also, is the ' meant to be there?
There was a problem hiding this comment.
The ' are required, as far as I know. Yes, might be more consistent to add {{ and }}.
pages/common/borg.md
Outdated
|
|
||
| `borg extract {{/path/to/repo/folder::Monday}} {{path/to/target/folder}} --exclude '*.ext'` | ||
|
|
||
| - Prune a repository, deleting all archives older than 7 days, listing changes: |
There was a problem hiding this comment.
Perhaps Prune a repository by deleting.... would read better?
pages/common/borg.md
Outdated
| # borg | ||
|
|
||
| > Deduplicating backup tool with compression and encryption. | ||
| > Supports local and remote backups that are mountable as filesystems. |
There was a problem hiding this comment.
I don't see an example which works on remote backups. Perhaps you can switch one of the examples to work on a remote backup.
pages/common/borg.md
Outdated
|
|
||
| - Initialise a (local) repository: | ||
|
|
||
| `borg init {{/path/to/repo/folder}}` |
There was a problem hiding this comment.
Please change it to path/to/repo_folder. Apply this convention everywhere.
pages/common/borg.md
Outdated
|
|
||
| `borg init {{/path/to/repo/folder}}` | ||
|
|
||
| - Backup a folder into the repository, creating an archive called Monday: |
pages/common/borg.md
Outdated
|
|
||
| `borg list {{/path/to/repo/folder}}` | ||
|
|
||
| - Extract a specific folder from the 'Monday' archive, excluding all *.ext files: |
pages/common/borg.md
Outdated
|
|
||
| - Prune a repository by deleting all archives older than 7 days, listing changes: | ||
|
|
||
| `borg prune --keep-within 7d --list {{/path/to/repo/folder}}` |
The page (if new), does not already exist in the repo.
The page (if new), has been added to the correct platform folder:
common/if it's common to all platforms,linux/if it's Linux-specific, and so on.The page has 8 or fewer examples.
The PR is appropriately titled:
<command name>: add pagefor new pages, or<command name>: <description of changes>for pages being editedThe page follows the contributing guidelines