aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFélix Sipma <felix+debian@gueux.org>2016-12-14 12:47:35 +0100
committerFélix Sipma <felix+debian@gueux.org>2016-12-14 12:47:35 +0100
commit814b40e6c901ee7298984615f4f380bb5e5008f6 (patch)
treeb4aa903368e8b6ff60a0f7f2e83198571de72f09
parent73d7897c9976d1e70943072e23c59de6199100b2 (diff)
New upstream version 0.3.1upstream/0.3.1
-rw-r--r--.envrc1
-rw-r--r--CONTRIBUTING.md10
-rw-r--r--README.md1
-rw-r--r--VERSION2
-rw-r--r--build.go62
-rw-r--r--doc/Design.md224
-rw-r--r--doc/Manual.md610
-rw-r--r--doc/code.css124
-rw-r--r--doc/index.md10
-rw-r--r--mkdocs.yml4
-rw-r--r--src/cmds/restic/background.go9
-rw-r--r--src/cmds/restic/background_linux.go21
-rw-r--r--src/cmds/restic/cmd_backup.go72
-rw-r--r--src/cmds/restic/cmd_forget.go23
-rw-r--r--src/cmds/restic/cmd_ls.go6
-rw-r--r--src/cmds/restic/integration_test.go46
-rw-r--r--src/restic/archiver/archiver.go59
-rw-r--r--src/restic/backend/local/local.go7
-rw-r--r--src/restic/backend/rest/rest.go16
-rw-r--r--src/restic/backend/s3/s3.go46
-rw-r--r--src/restic/backend/sftp/sftp.go2
-rw-r--r--src/restic/fs/deviceid_unix.go9
-rw-r--r--src/restic/fs/file.go21
-rw-r--r--src/restic/fs/file_linux.go59
-rw-r--r--src/restic/fs/file_nonlinux.go15
-rw-r--r--src/restic/node.go2
-rw-r--r--src/restic/node_test.go25
-rw-r--r--src/restic/snapshot.go6
-rw-r--r--vendor/manifest4
29 files changed, 947 insertions, 549 deletions
diff --git a/.envrc b/.envrc
new file mode 100644
index 0000000..c153542
--- /dev/null
+++ b/.envrc
@@ -0,0 +1 @@
+GOPATH=$PWD:$PWD/vendor
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 5bb5b52..97b5c0e 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -92,6 +92,16 @@ quickly set up VMs and run the tests, e.g.:
$ vagrant ssh freebsd -c 'cd restic/restic; go test -v ./...'
[...]
+The default `go` tool can also be used by setting the environment variable
+`GOPATH` to the following value while being in the top level directory in the
+git repository:
+
+ $ export GOPATH=$PWD:$PWD/vendor
+
+The file `.envrc` allows automatic `GOPATH` configuration with
+[direnv](https://direnv.net/), inspect the file and then allow automatic
+configuration by running `direnv allow`.
+
Providing Patches
=================
diff --git a/README.md b/README.md
index 477d52a..a7d3489 100644
--- a/README.md
+++ b/README.md
@@ -67,7 +67,6 @@ alexander@bumpern.de. If possible, please encrypt your email using the following
pub 4096R/91A6868BD3F7A907 2014-11-01
Key fingerprint = CF8F 18F2 8445 7597 3F79 D4E1 91A6 868B D3F7 A907
uid Alexander Neumann <alexander@bumpern.de>
- uid Alexander Neumann <alexander@debian.org>
sub 4096R/D5FC2ACF4043FDF1 2014-11-01
```
diff --git a/VERSION b/VERSION
index 0d91a54..9e11b32 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-0.3.0
+0.3.1
diff --git a/build.go b/build.go
index 166aee3..04a65d1 100644
--- a/build.go
+++ b/build.go
@@ -21,6 +21,18 @@ var (
runTests bool
)
+var config = struct {
+ Name string
+ Namespace string
+ Main string
+ Tests []string
+}{
+ Name: "restic", // name of the program executable and directory
+ Namespace: "", // subdir of GOPATH, e.g. "github.com/foo/bar"
+ Main: "cmds/restic", // package name for the main package
+ Tests: []string{"restic/...", "cmds/..."}, // tests to run
+}
+
const timeFormat = "2006-01-02 15:04:05"
// specialDir returns true if the file begins with a special character ('.' or '_').
@@ -96,6 +108,15 @@ func updateGopath(dst, src, prefix string) error {
})
}
+func directoryExists(dirname string) bool {
+ stat, err := os.Stat(dirname)
+ if err != nil && os.IsNotExist(err) {
+ return false
+ }
+
+ return stat.IsDir()
+}
+
// copyFile creates dst from src, preserving file attributes and timestamps.
func copyFile(dst, src string) error {
fi, err := os.Stat(src)
@@ -264,24 +285,14 @@ type Constants map[string]string
func (cs Constants) LDFlags() string {
l := make([]string, 0, len(cs))
- if runtime.Version() < "go1.5" {
- for k, v := range cs {
- l = append(l, fmt.Sprintf(`-X %q %q`, k, v))
- }
- } else {
- for k, v := range cs {
- l = append(l, fmt.Sprintf(`-X "%s=%s"`, k, v))
- }
+ for k, v := range cs {
+ l = append(l, fmt.Sprintf(`-X "%s=%s"`, k, v))
}
return strings.Join(l, " ")
}
func main() {
- if runtime.Version() < "go1.6" {
- fmt.Fprintf(os.Stderr, "old version of Go detected (%v), I'll try but no guarantees\n", runtime.Version())
- }
-
buildTags := []string{}
skipNext := false
@@ -302,6 +313,9 @@ func main() {
case "-k", "--keep-gopath":
keepGopath = true
case "-t", "-tags", "--tags":
+ if i+1 >= len(params) {
+ die("-t given but no tag specified")
+ }
skipNext = true
buildTags = strings.Split(params[i+1], " ")
case "-T", "--test":
@@ -338,23 +352,21 @@ func main() {
die("Getwd(): %v\n", err)
}
- gopath, err := ioutil.TempDir("", "restic-build-")
+ gopath, err := ioutil.TempDir("", fmt.Sprintf("%v-build-", config.Name))
if err != nil {
die("TempDir(): %v\n", err)
}
verbosePrintf("create GOPATH at %v\n", gopath)
- if err = updateGopath(gopath, filepath.Join(root, "src", "restic"), "restic"); err != nil {
- die("copying files from %v/src/restic to %v/src/restic failed: %v\n", root, gopath, err)
- }
-
- if err = updateGopath(gopath, filepath.Join(root, "src", "cmds"), "cmds"); err != nil {
- die("copying files from %v/src/cmds to %v/src/restic/cmds failed: %v\n", root, gopath, err)
+ if err = updateGopath(gopath, filepath.Join(root, "src"), config.Namespace); err != nil {
+ die("copying files from %v/src to %v/src failed: %v\n", root, gopath, err)
}
vendor := filepath.Join(root, "vendor", "src")
- if err = updateGopath(gopath, vendor, ""); err != nil {
- die("copying files from %v to %v/src failed: %v\n", vendor, gopath, err)
+ if directoryExists(vendor) {
+ if err = updateGopath(gopath, vendor, ""); err != nil {
+ die("copying files from %v to %v failed: %v\n", root, gopath, err)
+ }
}
defer func() {
@@ -368,9 +380,9 @@ func main() {
}
}()
- outputFilename := "restic"
+ outputFilename := config.Name
if targetGOOS == "windows" {
- outputFilename = "restic.exe"
+ outputFilename += ".exe"
}
cwd, err := os.Getwd()
@@ -391,7 +403,7 @@ func main() {
args := []string{
"-tags", strings.Join(buildTags, " "),
"-ldflags", ldflags,
- "-o", output, "cmds/restic",
+ "-o", output, config.Main,
}
err = build(filepath.Join(gopath, "src"), targetGOOS, targetGOARCH, gopath, args...)
@@ -402,7 +414,7 @@ func main() {
if runTests {
verbosePrintf("running tests\n")
- err = test(filepath.Join(gopath, "src"), gopath, "restic/...")
+ err = test(cwd, gopath, config.Tests...)
if err != nil {
die("running tests failed: %v\n", err)
}
diff --git a/doc/Design.md b/doc/Design.md
index c78f4d9..6e9cd39 100644
--- a/doc/Design.md
+++ b/doc/Design.md
@@ -62,11 +62,13 @@ overhead is 32 bytes. For each file, a new random IV is selected.
The file `config` is encrypted this way and contains a JSON document like the
following:
- {
- "version": 1,
- "id": "5956a3f67a6230d4a92cefb29529f10196c7d92582ec305fd71ff6d331d6271b",
- "chunker_polynomial": "25b468838dcb75"
- }
+```json
+{
+ "version": 1,
+ "id": "5956a3f67a6230d4a92cefb29529f10196c7d92582ec305fd71ff6d331d6271b",
+ "chunker_polynomial": "25b468838dcb75"
+}
+```
After decryption, restic first checks that the version field contains a version
number that it understands, otherwise it aborts. At the moment, the version is
@@ -102,7 +104,9 @@ The basic layout of a sample restic repository is shown here:
A repository can be initialized with the `restic init` command, e.g.:
- $ restic -r /tmp/restic-repo init
+```console
+$ restic -r /tmp/restic-repo init
+```
Pack Format
-----------
@@ -163,35 +167,37 @@ used to reconstruct the index. The files are encrypted and authenticated like
Data and Tree Blobs, so the outer structure is `IV || Ciphertext || MAC` again.
The plaintext consists of a JSON document like the following:
+```json
+{
+ "supersedes": [
+ "ed54ae36197f4745ebc4b54d10e0f623eaaaedd03013eb7ae90df881b7781452"
+ ],
+ "packs": [
{
- "supersedes": [
- "ed54ae36197f4745ebc4b54d10e0f623eaaaedd03013eb7ae90df881b7781452"
- ],
- "packs": [
+ "id": "73d04e6125cf3c28a299cc2f3cca3b78ceac396e4fcf9575e34536b26782413c",
+ "blobs": [
+ {
+ "id": "3ec79977ef0cf5de7b08cd12b874cd0f62bbaf7f07f3497a5b1bbcc8cb39b1ce",
+ "type": "data",
+ "offset": 0,
+ "length": 25
+ },{
+ "id": "9ccb846e60d90d4eb915848add7aa7ea1e4bbabfc60e573db9f7bfb2789afbae",
+ "type": "tree",
+ "offset": 38,
+ "length": 100
+ },
{
- "id": "73d04e6125cf3c28a299cc2f3cca3b78ceac396e4fcf9575e34536b26782413c",
- "blobs": [
- {
- "id": "3ec79977ef0cf5de7b08cd12b874cd0f62bbaf7f07f3497a5b1bbcc8cb39b1ce",
- "type": "data",
- "offset": 0,
- "length": 25
- },{
- "id": "9ccb846e60d90d4eb915848add7aa7ea1e4bbabfc60e573db9f7bfb2789afbae",
- "type": "tree",
- "offset": 38,
- "length": 100
- },
- {
- "id": "d3dc577b4ffd38cc4b32122cabf8655a0223ed22edfd93b353dc0c3f2b0fdf66",
- "type": "data",
- "offset": 150,
- "length": 123
- }
- ]
- }, [...]
+ "id": "d3dc577b4ffd38cc4b32122cabf8655a0223ed22edfd93b353dc0c3f2b0fdf66",
+ "type": "data",
+ "offset": 150,
+ "length": 123
+ }
]
- }
+ }, [...]
+ ]
+}
+```
This JSON document lists Packs and the blobs contained therein. In this
example, the Pack `73d04e61` contains two data Blobs and one Tree blob, the
@@ -258,14 +264,16 @@ document which contains the master encryption and message authentication keys
for this repository (encoded in Base64). The command `restic cat masterkey` can
be used as follows to decrypt and pretty-print the master key:
- $ restic -r /tmp/restic-repo cat masterkey
- {
- "mac": {
- "k": "evFWd9wWlndL9jc501268g==",
- "r": "E9eEDnSJZgqwTOkDtOp+Dw=="
- },
- "encrypt": "UQCqa0lKZ94PygPxMRqkePTZnHRYh1k1pX2k2lM2v3Q=",
- }
+```console
+$ restic -r /tmp/restic-repo cat masterkey
+{
+ "mac": {
+ "k": "evFWd9wWlndL9jc501268g==",
+ "r": "E9eEDnSJZgqwTOkDtOp+Dw=="
+ },
+ "encrypt": "UQCqa0lKZ94PygPxMRqkePTZnHRYh1k1pX2k2lM2v3Q=",
+}
+```
All data in the repository is encrypted and authenticated with these master keys.
For encryption, the AES-256 algorithm in Counter mode is used. For message
@@ -286,17 +294,19 @@ string is unique and used within restic to uniquely identify a snapshot.
The command `restic cat snapshot` can be used as follows to decrypt and
pretty-print the contents of a snapshot file:
- $ restic -r /tmp/restic-repo cat snapshot 22a5af1b
- enter password for repository:
- {
- "time": "2015-01-02T18:10:50.895208559+01:00",
- "tree": "2da81727b6585232894cfbb8f8bdab8d1eccd3d8f7c92bc934d62e62e618ffdf",
- "dir": "/tmp/testdata",
- "hostname": "kasimir",
- "username": "fd0",
- "uid": 1000,
- "gid": 100
- }
+```console
+$ restic -r /tmp/restic-repo cat snapshot 22a5af1b
+enter password for repository:
+{
+ "time": "2015-01-02T18:10:50.895208559+01:00",
+ "tree": "2da81727b6585232894cfbb8f8bdab8d1eccd3d8f7c92bc934d62e62e618ffdf",
+ "dir": "/tmp/testdata",
+ "hostname": "kasimir",
+ "username": "fd0",
+ "uid": 1000,
+ "gid": 100
+}
+```
Here it can be seen that this snapshot represents the contents of the directory
`/tmp/testdata`. The most important field is `tree`.
@@ -319,26 +329,28 @@ subdirectory of the directory `data`.
The command `restic cat tree` can be used to inspect the tree referenced above:
- $ restic -r /tmp/restic-repo cat tree b8138ab08a4722596ac89c917827358da4672eac68e3c03a8115b88dbf4bfb59
- enter password for repository:
+```console
+$ restic -r /tmp/restic-repo cat tree b8138ab08a4722596ac89c917827358da4672eac68e3c03a8115b88dbf4bfb59
+enter password for repository:
+{
+ "nodes": [
{
- "nodes": [
- {
- "name": "testdata",
- "type": "dir",
- "mode": 493,
- "mtime": "2014-12-22T14:47:59.912418701+01:00",
- "atime": "2014-12-06T17:49:21.748468803+01:00",
- "ctime": "2014-12-22T14:47:59.912418701+01:00",
- "uid": 1000,
- "gid": 100,
- "user": "fd0",
- "inode": 409704562,
- "content": null,
- "subtree": "b26e315b0988ddcd1cee64c351d13a100fedbc9fdbb144a67d1b765ab280b4dc"
- }
- ]
+ "name": "testdata",
+ "type": "dir",
+ "mode": 493,
+ "mtime": "2014-12-22T14:47:59.912418701+01:00",
+ "atime": "2014-12-06T17:49:21.748468803+01:00",
+ "ctime": "2014-12-22T14:47:59.912418701+01:00",
+ "uid": 1000,
+ "gid": 100,
+ "user": "fd0",
+ "inode": 409704562,
+ "content": null,
+ "subtree": "b26e315b0988ddcd1cee64c351d13a100fedbc9fdbb144a67d1b765ab280b4dc"
}
+ ]
+}
+```
A tree contains a list of entries (in the field `nodes`) which contain meta
data like a name and timestamps. When the entry references a directory, the
@@ -347,30 +359,32 @@ field `subtree` contains the plain text ID of another tree object.
When the command `restic cat tree` is used, the storage hash is needed to print
a tree. The tree referenced above can be dumped as follows:
- $ restic -r /tmp/restic-repo cat tree 8b238c8811cc362693e91a857460c78d3acf7d9edb2f111048691976803cf16e
- enter password for repository:
+```console
+$ restic -r /tmp/restic-repo cat tree 8b238c8811cc362693e91a857460c78d3acf7d9edb2f111048691976803cf16e
+enter password for repository:
+{
+ "nodes": [
{
- "nodes": [
- {
- "name": "testfile",
- "type": "file",
- "mode": 420,
- "mtime": "2014-12-06T17:50:23.34513538+01:00",
- "atime": "2014-12-06T17:50:23.338468713+01:00",
- "ctime": "2014-12-06T17:50:23.34513538+01:00",
- "uid": 1000,
- "gid": 100,
- "user": "fd0",
- "inode": 416863351,
- "size": 1234,
- "links": 1,
- "content": [
- "50f77b3b4291e8411a027b9f9b9e64658181cc676ce6ba9958b95f268cb1109d"
- ]
- },
- [...]
+ "name": "testfile",
+ "type": "file",
+ "mode": 420,
+ "mtime": "2014-12-06T17:50:23.34513538+01:00",
+ "atime": "2014-12-06T17:50:23.338468713+01:00",
+ "ctime": "2014-12-06T17:50:23.34513538+01:00",
+ "uid": 1000,
+ "gid": 100,
+ "user": "fd0",
+ "inode": 416863351,
+ "size": 1234,
+ "links": 1,
+ "content": [
+ "50f77b3b4291e8411a027b9f9b9e64658181cc676ce6ba9958b95f268cb1109d"
]
- }
+ },
+ [...]
+ ]
+}
+```
This tree contains a file entry. This time, the `subtree` field is not present
and the `content` field contains a list with one plain text SHA-256 hash.
@@ -378,9 +392,11 @@ and the `content` field contains a list with one plain text SHA-256 hash.
The command `restic cat data` can be used to extract and decrypt data given a
plaintext ID, e.g. for the data mentioned above:
- $ restic -r /tmp/restic-repo cat blob 50f77b3b4291e8411a027b9f9b9e64658181cc676ce6ba9958b95f268cb1109d | sha256sum
- enter password for repository:
- 50f77b3b4291e8411a027b9f9b9e64658181cc676ce6ba9958b95f268cb1109d -
+```console
+$ restic -r /tmp/restic-repo cat blob 50f77b3b4291e8411a027b9f9b9e64658181cc676ce6ba9958b95f268cb1109d | sha256sum
+enter password for repository:
+50f77b3b4291e8411a027b9f9b9e64658181cc676ce6ba9958b95f268cb1109d -
+```
As can be seen from the output of the program `sha256sum`, the hash matches the
plaintext hash from the map included in the tree above, so the correct data has
@@ -404,15 +420,17 @@ A lock is a file in the subdir `locks` whose filename is the storage ID of
the contents. It is encrypted and authenticated the same way as other files
in the repository and contains the following JSON structure:
- {
- "time": "2015-06-27T12:18:51.759239612+02:00",
- "exclusive": false,
- "hostname": "kasimir",
- "username": "fd0",
- "pid": 13607,
- "uid": 1000,
- "gid": 100
- }
+```json
+{
+ "time": "2015-06-27T12:18:51.759239612+02:00",
+ "exclusive": false,
+ "hostname": "kasimir",
+ "username": "fd0",
+ "pid": 13607,
+ "uid": 1000,
+ "gid": 100
+}
+```
The field `exclusive` defines the type of lock. When a new lock is to be
created, restic checks all locks in the repository. When a lock is found, it
diff --git a/doc/Manual.md b/doc/Manual.md
index 6db8c65..2a16a90 100644
--- a/doc/Manual.md
+++ b/doc/Manual.md
@@ -6,16 +6,22 @@ functionality provided by restic.
If you are using Mac OS X, you can install restic using the
[homebrew](http://brew.sh/) packet manager:
- $ brew tap restic/restic
- $ brew install restic
+```console
+$ brew tap restic/restic
+$ brew install restic
+```
On archlinux, there is a package called `restic-git` which can be installed from AUR, e.g. with `pacaur`:
- $ pacaur -S restic-git
+```console
+$ pacaur -S restic-git
+```
At debian stable you can install 'go' directly from the repositories (as root):
- $ apt-get install golang-go
+```console
+$ apt-get install golang-go
+```
after installation of 'go' go straight forward to 'git clone [...]'
@@ -28,80 +34,85 @@ instructions how to install Go.
In order to build restic from source, execute the following steps:
- $ git clone https://github.com/restic/restic
- [...]
+```console
+$ git clone https://github.com/restic/restic
+[...]
- $ cd restic
+$ cd restic
- $ go run build.go
+$ go run build.go
+```
At the moment, the only tested compiler for restic is the official Go compiler.
Building restic with gccgo may work, but is not supported.
Usage help is available:
- $ ./restic --help
- Usage:
- restic [OPTIONS] <command>
-
- Application Options:
- -r, --repo= Repository directory to backup to/restore from
- --cache-dir= Directory to use as a local cache
- -q, --quiet Do not output comprehensive progress report (false)
- --no-lock Do not lock the repo, this allows some operations on read-only repos. (false)
- -o, --option= Specify options in the form 'foo.key=value'
-
- Help Options:
- -h, --help Show this help message
-
- Available commands:
- backup save file/directory
- cat dump something
- check check the repository
- find find a file/directory
- forget removes snapshots from a repository
- init create repository
- key manage keys
- list lists data
- ls list files
- mount mount a repository
- prune removes content from a repository
- rebuild-index rebuild the index
- restore restore a snapshot
- snapshots show snapshots
- unlock remove locks
- version display version
+```console
+$ ./restic --help
+restic is a backup program which allows saving multiple revisions of files and
+directories in an encrypted repository stored on different backends.
+
+Usage:
+ restic [command]
+
+Available Commands:
+ backup create a new backup of files and/or directories
+ cat print internal objects to stdout
+ check check the repository for errors
+ find find a file or directory
+ forget forget removes snapshots from the repository
+ init initialize a new repository
+ key manage keys (passwords)
+ list list items in the repository
+ ls list files in a snapshot
+ mount mount the repository
+ prune remove unneeded data from the repository
+ rebuild-index build a new index file
+ restore extract the data from a snapshot
+ snapshots list all snapshots
+ unlock remove locks other processes created
+ version Print version information
+
+Flags:
+ --no-lock do not lock the repo, this allows some operations on read-only repos
+ -p, --password-file string read the repository password from a file
+ -q, --quiet do not outputcomprehensive progress report
+ -r, --repo string repository to backup to or restore from (default: $RESTIC_REPOSITORY)
+
+Use "restic [command] --help" for more information about a command.
+```
Similar to programs such as `git`, restic has a number of sub-commands. You can
see these commands in the listing above. Each sub-command may have own
command-line options, and there is a help option for each command which lists
them, e.g. for the `backup` command:
- $ ./restic backup --help
- Usage:
- restic [OPTIONS] backup DIR/FILE [DIR/FILE] [...]
-
- The backup command creates a snapshot of a file or directory
-
- Application Options:
- -r, --repo= Repository directory to backup to/restore from (/tmp/repo)
- -p, --password-file= Read the repository password from a file
- --cache-dir= Directory to use as a local cache
- -q, --quiet Do not output comprehensive progress report (false)
- --no-lock Do not lock the repo, this allows some operations on read-only repos. (false)
- -o, --option= Specify options in the form 'foo.key=value'
-
- Help Options:
- -h, --help Show this help message
-
- [backup command options]
- -p, --parent= use this parent snapshot (default: last snapshot in repo that has the same target)
- -f, --force Force re-reading the target. Overrides the "parent" flag
- -e, --exclude= Exclude a pattern (can be specified multiple times)
- --exclude-file= Read exclude-patterns from file
- --stdin read backup data from stdin
- --stdin-filename= file name to use when reading from stdin (stdin)
- --tag= Add a tag (can be specified multiple times)
+```console
+$ ./restic backup --help
+The "backup" command creates a new snapshot and saves the files and directories
+given as the arguments.
+
+Usage:
+ restic backup [flags] FILE/DIR [FILE/DIR] ...
+
+Flags:
+ -e, --exclude pattern exclude a pattern (can be specified multiple times)
+ --exclude-file string read exclude patterns from a file
+ --files-from string read the files to backup from file (can be combined with file args)
+ -f, --force force re-reading the target files/directories. Overrides the "parent" flag
+ -x, --one-file-system Exclude other file systems
+ --parent string use this parent snapshot (default: last snapshot in the repo that has the same target files/directories)
+ --stdin read backup from stdin
+ --stdin-filename string file name to use when reading from stdin
+ --tag tag add a tag for the new snapshot (can be specified multiple times)
+
+Global Flags:
+ --no-lock do not lock the repo, this allows some operations on read-only repos
+ -p, --password-file string read the repository password from a file
+ -q, --quiet do not outputcomprehensive progress report
+ -r, --repo string repository to backup to or restore from (default: $RESTIC_REPOSITORY)
+```
Subcommand that support showing progress information such as `backup`, `check` and `prune` will do so unless
the quiet flag `-q` or `--quiet` is set. When running from a non-interactive console progress reporting will
@@ -119,12 +130,14 @@ will be saved at.
In order to create a repository at `/tmp/backup`, run the following command and
enter the same password twice:
- $ restic init --repo /tmp/backup
- enter password for new backend:
- enter password again:
- created restic backend 085b3c76b9 at /tmp/backup
- Please note that knowledge of your password is required to access the repository.
- Losing your password means that your data is irrecoverably lost.
+```console
+$ restic init --repo /tmp/backup
+enter password for new backend:
+enter password again:
+created restic backend 085b3c76b9 at /tmp/backup
+Please note that knowledge of your password is required to access the repository.
+Losing your password means that your data is irrecoverably lost.
+```
Remembering your password is important! If you lose it, you won't be able to
access data stored in the repository.
@@ -146,8 +159,10 @@ You can workaround this by using a special tool called `winpty` (look
[here](https://github.com/rprichard/winpty) for detail information). On MSYS2,
you can install `winpty` as follows:
- $ pacman -S winpty
- $ winpty restic -r /tmp/backup init
+```console
+$ pacman -S winpty
+$ winpty restic -r /tmp/backup init
+```
# Create a snapshot
@@ -155,13 +170,15 @@ Now we're ready to backup some data. The contents of a directory at a specific
point in time is called a "snapshot" in restic. Run the following command and
enter the repository password you chose above again:
- $ restic -r /tmp/backup backup ~/work
- enter password for repository:
- scan [/home/user/work]
- scanned 764 directories, 1816 files in 0:00
- [0:29] 100.00% 54.732 MiB/s 1.582 GiB / 1.582 GiB 2580 / 2580 items 0 errors ETA 0:00
- duration: 0:29, 54.47MiB/s
- snapshot 40dc1520 saved
+```console
+$ restic -r /tmp/backup backup ~/work
+enter password for repository:
+scan [/home/user/work]
+scanned 764 directories, 1816 files in 0:00
+[0:29] 100.00% 54.732 MiB/s 1.582 GiB / 1.582 GiB 2580 / 2580 items 0 errors ETA 0:00
+duration: 0:29, 54.47MiB/s
+snapshot 40dc1520 saved
+```
As you can see, restic created a backup of the directory and was pretty fast!
The specific snapshot just created is identified by a sequence of hexadecimal
@@ -170,40 +187,46 @@ characters, `40dc1520` in this case.
If you run the command again, restic will create another snapshot of your data,
but this time it's even faster. This is de-duplication at work!
- $ restic -r /tmp/backup backup ~/shared/work/web
- enter password for repository:
- using parent snapshot 40dc1520aa6a07b7b3ae561786770a01951245d2367241e71e9485f18ae8228c
- scan [/home/user/work]
- scanned 764 directories, 1816 files in 0:00
- [0:00] 100.00% 0B/s 1.582 GiB / 1.582 GiB 2580 / 2580 items 0 errors ETA 0:00
- duration: 0:00, 6572.38MiB/s
- snapshot 79766175 saved
+```console
+$ restic -r /tmp/backup backup ~/shared/work/web
+enter password for repository:
+using parent snapshot 40dc1520aa6a07b7b3ae561786770a01951245d2367241e71e9485f18ae8228c
+scan [/home/user/work]
+scanned 764 directories, 1816 files in 0:00
+[0:00] 100.00% 0B/s 1.582 GiB / 1.582 GiB 2580 / 2580 items 0 errors ETA 0:00
+duration: 0:00, 6572.38MiB/s
+snapshot 79766175 saved
+```
You can even backup individual files in the same repository.
- $ restic -r /tmp/backup backup ~/work.txt
- scan [~/work.txt]
- scanned 0 directories, 1 files in 0:00
- [0:00] 100.00% 0B/s 220B / 220B 1 / 1 items 0 errors ETA 0:00
- duration: 0:00, 0.03MiB/s
- snapshot 31f7bd63 saved
+```console
+$ restic -r /tmp/backup backup ~/work.txt
+scan [~/work.txt]
+scanned 0 directories, 1 files in 0:00
+[0:00] 100.00% 0B/s 220B / 220B 1 / 1 items 0 errors ETA 0:00
+duration: 0:00, 0.03MiB/s
+snapshot 31f7bd63 saved
+```
In fact several hosts may use the same repository to backup directories and
files leading to a greater de-duplication.
-You can exclude folders and files by specifying exclude-patterns.
+You can exclude folders and files by specifying exclude-patterns.
Either specify them with multiple `--exclude`'s or one `--exclude-file`
- $ cat exclude
- # exclude go-files
- *.go
- # exclude foo/x/y/z/bar foo/x/bar foo/bar
- foo/**/bar
- $ restic -r /tmp/backup backup ~/work --exclude=*.c --exclude-file=exclude
+```console
+$ cat exclude
+# exclude go-files
+*.go
+# exclude foo/x/y/z/bar foo/x/bar foo/bar
+foo/**/bar
+$ restic -r /tmp/backup backup ~/work --exclude=*.c --exclude-file=exclude
+```
Patterns use [`filepath.Glob`](https://golang.org/pkg/path/filepath/#Glob) internally,
see [`filepath.Match`](https://golang.org/pkg/path/filepath/#Match) for syntax.
-Additionally `**` exludes arbitrary subdirectories.
+Additionally `**` exludes arbitrary subdirectories.
Environment-variables in exclude-files are expanded with [`os.ExpandEnv`](https://golang.org/pkg/os/#ExpandEnv).
By specifying the option `--one-file-system` you can instruct restic to only
@@ -211,7 +234,30 @@ backup files from the file systems the initially specified files or directories
reside on. For example, calling restic like this won't backup `/sys` or
`/dev` on a Linux system:
- $ restic -r /tmp/backup backup --one-file-system /
+```console
+$ restic -r /tmp/backup backup --one-file-system /
+```
+By using the `--files-from` option you can read the files you want to backup
+from a file. This is especially useful if a lot of files have to be backed up
+that are not in the same folder or are maybe pre-filtered by other software.
+
+For example maybe you want to backup files that have a certain filename in them:
+
+```console
+$ find /tmp/somefiles | grep 'PATTERN' > /tmp/files_to_backup
+```
+
+You can then use restic to backup the filtered files:
+
+```console
+$ restic -r /tmp/backup backup --files-from /tmp/files_to_backup
+```
+
+Incidentally you can also combine `--files-from` with the normal files args:
+
+```console
+$ restic -r /tmp/backup backup --files-from /tmp/files_to_backup /tmp/some_additional_file
+```
## Reading data from stdin
@@ -219,7 +265,9 @@ Sometimes it can be nice to directly save the output of a program, e.g.
`mysqldump` so that the SQL can later be restored. Restic supports this mode of
operation, just supply the option `--stdin` to the `backup` command like this:
- $ mysqldump [...] | restic -r /tmp/backup backup --stdin
+```console
+$ mysqldump [...] | restic -r /tmp/backup backup --stdin
+```
This creates a new snapshot of the output of `mysqldump`. You can then use e.g.
the fuse mounting option (see below) to mount the repository and read the file.
@@ -227,15 +275,19 @@ the fuse mounting option (see below) to mount the repository and read the file.
By default, the file name `stdin` is used, a different name can be specified
with `--stdin-filename`, e.g. like this:
- $ mysqldump [...] | restic -r /tmp/backup backup --stdin --stdin-filename production.sql
+```console
+$ mysqldump [...] | restic -r /tmp/backup backup --stdin --stdin-filename production.sql
+```
## Tags
Snapshots can have one or more tags, short strings which add identifying
information. Just specify the tags for a snapshot with `--tag`:
- $ restic -r /tmp/backup backup --tag projectX ~/shared/work/web
- [...]
+```console
+$ restic -r /tmp/backup backup --tag projectX ~/shared/work/web
+[...]
+```
The tags can later be used to keep (or forget) snapshots.
@@ -243,52 +295,62 @@ The tags can later be used to keep (or forget) snapshots.
Now, you can list all the snapshots stored in the repository:
- $ restic -r /tmp/backup snapshots
- enter password for repository:
- ID Date Host Tags Directory
- ----------------------------------------------------------------------
- 40dc1520 2015-05-08 21:38:30 kasimir /home/user/work
- 79766175 2015-05-08 21:40:19 kasimir /home/user/work
- bdbd3439 2015-05-08 21:45:17 luigi /home/art
- 590c8fc8 2015-05-08 21:47:38 kazik /srv
- 9f0bc19e 2015-05-08 21:46:11 luigi /srv
+```console
+$ restic -r /tmp/backup snapshots
+enter password for repository:
+ID Date Host Tags Directory
+----------------------------------------------------------------------
+40dc1520 2015-05-08 21:38:30 kasimir /home/user/work
+79766175 2015-05-08 21:40:19 kasimir /home/user/work
+bdbd3439 2015-05-08 21:45:17 luigi /home/art
+590c8fc8 2015-05-08 21:47:38 kazik /srv
+9f0bc19e 2015-05-08 21:46:11 luigi /srv
+```
You can filter the listing by directory path:
- $ restic -r /tmp/backup snapshots --path="/srv"
- enter password for repository:
- ID Date Host Tags Directory
- ----------------------------------------------------------------------
- 590c8fc8 2015-05-08 21:47:38 kazik /srv
- 9f0bc19e 2015-05-08 21:46:11 luigi /srv
+```console
+$ restic -r /tmp/backup snapshots --path="/srv"
+enter password for repository:
+ID Date Host Tags Directory
+----------------------------------------------------------------------
+590c8fc8 2015-05-08 21:47:38 kazik /srv
+9f0bc19e 2015-05-08 21:46:11 luigi /srv
+```
Or filter by host:
- $ restic -r /tmp/backup snapshots --host luigi
- enter password for repository:
- ID Date Host Tags Directory
- ----------------------------------------------------------------------
- bdbd3439 2015-05-08 21:45:17 luigi /home/art
- 9f0bc19e 2015-05-08 21:46:11 luigi /srv
+```console
+$ restic -r /tmp/backup snapshots --host luigi
+enter password for repository:
+ID Date Host Tags Directory
+----------------------------------------------------------------------
+bdbd3439 2015-05-08 21:45:17 luigi /home/art
+9f0bc19e 2015-05-08 21:46:11 luigi /srv
+```
-Combining filters is also possible.
+Combining filters is also possible.
# Restore a snapshot
Restoring a snapshot is as easy as it sounds, just use the following command to
restore the contents of the latest snapshot to `/tmp/restore-work`:
- $ restic -r /tmp/backup restore 79766175 --target ~/tmp/restore-work
- enter password for repository:
- restoring <Snapshot of [/home/user/work] at 2015-05-08 21:40:19.884408621 +0200 CEST> to /tmp/restore-work
+```console
+$ restic -r /tmp/backup restore 79766175 --target ~/tmp/restore-work
+enter password for repository:
+restoring <Snapshot of [/home/user/work] at 2015-05-08 21:40:19.884408621 +0200 CEST> to /tmp/restore-work
+```
Use the word `latest` to restore the last backup. You can also combine `latest`
with the `--host` and `--path` filters to choose the last backup for a specific
host, path or both.
- $ restic -r /tmp/backup restore latest --target ~/tmp/restore-work --path "/home/art" --host luigi
- enter password for repository:
- restoring <Snapshot of [/home/art] at 2015-05-08 21:45:17.884408621 +0200 CEST> to /tmp/restore-work
+```console
+$ restic -r /tmp/backup restore latest --target ~/tmp/restore-work --path "/home/art" --host luigi
+enter password for repository:
+restoring <Snapshot of [/home/art] at 2015-05-08 21:45:17.884408621 +0200 CEST> to /tmp/restore-work
+```
# Manage repository keys
@@ -297,24 +359,26 @@ The `key` command allows you to set multiple access keys or passwords per
repository. In fact, you can use the `list`, `add`, `remove` and `passwd`
sub-commands to manage these keys very precisely:
- $ restic -r /tmp/backup key list
- enter password for repository:
- ID User Host Created
- ----------------------------------------------------------------------
- *eb78040b username kasimir 2015-08-12 13:29:57
-
- $ restic -r /tmp/backup key add
- enter password for repository:
- enter password for new key:
- enter password again:
- saved new key as <Key of username@kasimir, created on 2015-08-12 13:35:05.316831933 +0200 CEST>
-
- $ restic -r backup key list
- enter password for repository:
- ID User Host Created
- ----------------------------------------------------------------------
- 5c657874 username kasimir 2015-08-12 13:35:05
- *eb78040b username kasimir 2015-08-12 13:29:57
+```console
+$ restic -r /tmp/backup key list
+enter password for repository:
+ ID User Host Created
+----------------------------------------------------------------------
+*eb78040b username kasimir 2015-08-12 13:29:57
+
+$ restic -r /tmp/backup key add
+enter password for repository:
+enter password for new key:
+enter password again:
+saved new key as <Key of username@kasimir, created on 2015-08-12 13:35:05.316831933 +0200 CEST>
+
+$ restic -r backup key list
+enter password for repository:
+ ID User Host Created
+----------------------------------------------------------------------
+ 5c657874 username kasimir 2015-08-12 13:35:05
+*eb78040b username kasimir 2015-08-12 13:29:57
+```
# Check integrity and consistency
@@ -322,22 +386,28 @@ Imagine your repository is saved on a server that has a faulty hard drive, or
even worse, attackers get privileged access and modify your backup with the
intention to make you restore malicious data:
- $ sudo echo "boom" >> backup/index/d795ffa99a8ab8f8e42cec1f814df4e48b8f49129360fb57613df93739faee97
+```console
+$ sudo echo "boom" >> backup/index/d795ffa99a8ab8f8e42cec1f814df4e48b8f49129360fb57613df93739faee97
+```
In order to detect these things, it is a good idea to regularly use the `check`
command to test whether everything is alright, your precious backup data is
consistent and the integrity is unharmed:
- $ restic -r /tmp/backup check
- Load indexes
- ciphertext verification failed
+```console
+$ restic -r /tmp/backup check
+Load indexes
+ciphertext verification failed
+```
Trying to restore a snapshot which has been modified as shown above will yield
the same error:
- $ restic -r /tmp/backup restore 79766175 --target ~/tmp/restore-work
- Load indexes
- ciphertext verification failed
+```console
+$ restic -r /tmp/backup restore 79766175 --target ~/tmp/restore-work
+Load indexes
+ciphertext verification failed
+```
# Mount a repository
@@ -345,11 +415,13 @@ Browsing your backup as a regular file system is also very easy. First, create
a mount point such as `/mnt/restic` and then use the following command to serve
the repository with FUSE:
- $ mkdir /mnt/restic
- $ restic -r /tmp/backup mount /mnt/restic
- enter password for repository:
- Now serving /tmp/backup at /tmp/restic
- Don't forget to umount after quitting!
+```console
+$ mkdir /mnt/restic
+$ restic -r /tmp/backup mount /mnt/restic
+enter password for repository:
+Now serving /tmp/backup at /tmp/restic
+Don't forget to umount after quitting!
+```
Mounting repositories via FUSE is not possible on Windows and OpenBSD.
@@ -363,12 +435,14 @@ credentials.
Once the server is configured, the setup of the SFTP repository can simply be
achieved by changing the URL scheme in the `init` command:
- $ restic -r sftp:user@host:/tmp/backup init
- enter password for new backend:
- enter password again:
- created restic backend f1c6108821 at sftp:user@host:/tmp/backup
- Please note that knowledge of your password is required to access the repository.
- Losing your password means that your data is irrecoverably lost.
+```console
+$ restic -r sftp:user@host:/tmp/backup init
+enter password for new backend:
+enter password again:
+created restic backend f1c6108821 at sftp:user@host:/tmp/backup
+Please note that knowledge of your password is required to access the repository.
+Losing your password means that your data is irrecoverably lost.
+```
You can also specify a relative (read: no slash (`/`) character at the
beginning) directory, in this case the dir is relative to the remote user's
@@ -378,19 +452,25 @@ home directory.
Restic can backup data to any Amazon S3 bucket. However, in this case, changing the URL scheme is not enough since Amazon uses special security credentials to sign HTTP requests. By consequence, you must first setup the following environment variables with the credentials you obtained while creating the bucket.
- $ export AWS_ACCESS_KEY_ID=<MY_ACCESS_KEY>
- $ export AWS_SECRET_ACCESS_KEY=<MY_SECRET_ACCESS_KEY>
+```console
+$ export AWS_ACCESS_KEY_ID=<MY_ACCESS_KEY>
+$ export AWS_SECRET_ACCESS_KEY=<MY_SECRET_ACCESS_KEY>
+```
+
+You can then easily initialize a repository that uses your Amazon S3 as a backend, if the bucket does not exist yet it will be created in the default location:
-You can then easily initialize a repository that uses your Amazon S3 as a backend.
+```console
+$ restic -r s3:s3.amazonaws.com/bucket_name init
+enter password for new backend:
+enter password again:
+created restic backend eefee03bbd at s3:s3.amazonaws.com/bucket_name
+Please note that knowledge of your password is required to access the repository.
+Losing your password means that your data is irrecoverably lost.
+```
- $ restic -r s3:eu-central-1/bucket_name init
- enter password for new backend:
- enter password again:
- created restic backend eefee03bbd at s3:eu-central-1/bucket_name
- Please note that knowledge of your password is required to access the repository.
- Losing your password means that your data is irrecoverably lost.
+It is not possible at the moment to have restic create a new bucket in a different location, so you need to create it using a different program. Afterwards, the S3 server (`s3.amazonaws.com`) will redirect restic to the correct endpoint.
-Fro an s3-compatible server that is not Amazon (like Minio, see below), or is
+For an S3-compatible server that is not Amazon (like Minio, see below), or is
only available via HTTP, you can specify the URL to the server like this:
`s3:http://server:port/bucket_name`.
@@ -400,22 +480,26 @@ only available via HTTP, you can specify the URL to the server like this:
### Pre-Requisites
-* Download and Install [Minio Server](https://minio.io/download/).
+* Download and Install [Minio Server](https://minio.io/download/).
* You can also refer to [https://docs.minio.io](https://docs.minio.io) for step by step guidance on installation and getting started on Minio CLient and Minio Server.
You must first setup the following environment variables with the credentials of your running Minio Server.
- $ export AWS_ACCESS_KEY_ID=<YOUR-MINIO-ACCESS-KEY-ID>
- $ export AWS_SECRET_ACCESS_KEY= <YOUR-MINIO-SECRET-ACCESS-KEY>
+```console
+$ export AWS_ACCESS_KEY_ID=<YOUR-MINIO-ACCESS-KEY-ID>
+$ export AWS_SECRET_ACCESS_KEY= <YOUR-MINIO-SECRET-ACCESS-KEY>
+```
Now you can easily initialize restic to use Minio server as backend with this command.
- $ ./restic -r s3:http://localhost:9000/restic init
- enter password for new backend:
- enter password again:
- created restic backend 6ad29560f5 at s3:http://localhost:9000/restic1
- Please note that knowledge of your password is required to access
- the repository. Losing your password means that your data is irrecoverably lost.
+```console
+$ ./restic -r s3:http://localhost:9000/restic init
+enter password for new backend:
+enter password again:
+created restic backend 6ad29560f5 at s3:http://localhost:9000/restic1
+Please note that knowledge of your password is required to access
+the repository. Losing your password means that your data is irrecoverably lost.
+```
# Removing old snapshots
@@ -430,54 +514,62 @@ the repository.
The command `snapshots` can be used to list all snapshots in a repository like this:
- $ restic -r /tmp/backup snapshots
- enter password for repository:
- ID Date Host Tags Directory
- ----------------------------------------------------------------------
- 40dc1520 2015-05-08 21:38:30 kasimir /home/user/work
- 79766175 2015-05-08 21:40:19 kasimir /home/user/work
- bdbd3439 2015-05-08 21:45:17 luigi /home/art
- 590c8fc8 2015-05-08 21:47:38 kazik /srv
- 9f0bc19e 2015-05-08 21:46:11 luigi /srv
+```console
+$ restic -r /tmp/backup snapshots
+enter password for repository:
+ID Date Host Tags Directory
+----------------------------------------------------------------------
+40dc1520 2015-05-08 21:38:30 kasimir /home/user/work
+79766175 2015-05-08 21:40:19 kasimir /home/user/work
+bdbd3439 2015-05-08 21:45:17 luigi /home/art
+590c8fc8 2015-05-08 21:47:38 kazik /srv
+9f0bc19e 2015-05-08 21:46:11 luigi /srv
+```
In order to remove the snapshot of `/home/art`, use the `forget` command and
specify the snapshot ID on the command line:
- $ restic -r /tmp/backup forget bdbd3439
- enter password for repository:
- removed snapshot d3f01f63
+```console
+$ restic -r /tmp/backup forget bdbd3439
+enter password for repository:
+removed snapshot d3f01f63
+```
Afterwards this snapshot is removed:
- $ restic -r /tmp/backup snapshots
- enter password for repository:
- ID Date Host Tags Directory
- ----------------------------------------------------------------------
- 40dc1520 2015-05-08 21:38:30 kasimir /home/user/work
- 79766175 2015-05-08 21:40:19 kasimir /home/user/work
- 590c8fc8 2015-05-08 21:47:38 kazik /srv
- 9f0bc19e 2015-05-08 21:46:11 luigi /srv
+```console
+$ restic -r /tmp/backup snapshots
+enter password for repository:
+ID Date Host Tags Directory
+----------------------------------------------------------------------
+40dc1520 2015-05-08 21:38:30 kasimir /home/user/work
+79766175 2015-05-08 21:40:19 kasimir /home/user/work
+590c8fc8 2015-05-08 21:47:38 kazik /srv
+9f0bc19e 2015-05-08 21:46:11 luigi /srv
+```
But the data that was referenced by files in this snapshot is still stored in
the repository. To cleanup unreferenced data, the `prune` command must be run:
- $ restic -r /tmp/backup prune
- enter password for repository:
-
- counting files in repo
- building new index for repo
- [0:00] 100.00% 22 / 22 files
- repository contains 22 packs (8512 blobs) with 100.092 MiB bytes
- processed 8512 blobs: 0 duplicate blobs, 0B duplicate
- load all snapshots
- find data that is still in use for 1 snapshots
- [0:00] 100.00% 1 / 1 snapshots
- found 8433 of 8512 data blobs still in use
- will rewrite 3 packs
- creating new index
- [0:00] 86.36% 19 / 22 files
- saved new index as 544a5084
- done
+```console
+$ restic -r /tmp/backup prune
+enter password for repository:
+
+counting files in repo
+building new index for repo
+[0:00] 100.00% 22 / 22 files
+repository contains 22 packs (8512 blobs) with 100.092 MiB bytes
+processed 8512 blobs: 0 duplicate blobs, 0B duplicate
+load all snapshots
+find data that is still in use for 1 snapshots
+[0:00] 100.00% 1 / 1 snapshots
+found 8433 of 8512 data blobs still in use
+will rewrite 3 packs
+creating new index
+[0:00] 86.36% 19 / 22 files
+saved new index as 544a5084
+done
+```
Afterwards the repository is smaller.
@@ -530,12 +622,16 @@ all snapshots!
The program can be built with debug support like this:
- $ go run build.go -tags debug
+```console
+$ go run build.go -tags debug
+```
Afterwards, extensive debug messages are written to the file in environment
variable `DEBUG_LOG`, e.g.:
- $ DEBUG_LOG=/tmp/restic-debug.log restic backup ~/work
+```console
+$ DEBUG_LOG=/tmp/restic-debug.log restic backup ~/work
+```
If you suspect that there is a bug, you can have a look at the debug log.
Please be aware that the debug log might contain sensitive information such as
@@ -551,23 +647,29 @@ separated by commas. Patterns are case sensitive.
Printing all log messages to the console can be achieved by setting the file
filter to `*`:
- $ DEBUG_FILES=* restic check
+```console
+$ DEBUG_FILES=* restic check
+```
If you want restic to just print all debug log messages from the files
-`main.go` and `lock.go`, set the environment variable `DEBUG_FILES` like this:
+`main.go` and `lock.go`, set the environment variable `DEBUG_FILES` like this:
- $ DEBUG_FILES=main.go,lock.go restic check
+```console
+$ DEBUG_FILES=main.go,lock.go restic check
+```
The following command line instructs restic to only print debug statements
originating in functions that match the pattern `*unlock*` (case sensitive):
- $ DEBUG_FUNCS=*unlock* restic check
+```console
+$ DEBUG_FUNCS=*unlock* restic check
+```
# Under the hood: Browse repository objects
Internally, a repository stores data of several different types described in the [design documentation](https://github.com/restic/restic/blob/master/doc/Design.md). You can `list` objects such as blobs, packs, index, snapshots, keys or locks with the following command:
-```shell
+```console
$ restic -r /tmp/backup list snapshots
d369ccc7d126594950bf74f0a348d5d98d9e99f3215082eb69bf02dc9b3e464c
```
@@ -575,26 +677,30 @@ d369ccc7d126594950bf74f0a348d5d98d9e99f3215082eb69bf02dc9b3e464c
The `find` command searches for a given
[pattern](http://golang.org/pkg/path/filepath/#Match) in the repository.
- $ restic -r backup find test.txt
- debug log file restic.log
- debug enabled
- enter password for repository:
- found 1 matching entries in snapshot 196bc5760c909a7681647949e80e5448e276521489558525680acf1bd428af36
- -rw-r--r-- 501 20 5 2015-08-26 14:09:57 +0200 CEST path/to/test.txt
+```console
+$ restic -r backup find test.txt
+debug log file restic.log
+debug enabled
+enter password for repository:
+found 1 matching entries in snapshot 196bc5760c909a7681647949e80e5448e276521489558525680acf1bd428af36
+ -rw-r--r-- 501 20 5 2015-08-26 14:09:57 +0200 CEST path/to/test.txt
+```
The `cat` command allows you to display the JSON representation of the objects
or its raw content.
- $ restic -r /tmp/backup cat snapshot d369ccc7d126594950bf74f0a348d5d98d9e99f3215082eb69bf02dc9b3e464c
- enter password for repository:
- {
- "time": "2015-08-12T12:52:44.091448856+02:00",
- "tree": "05cec17e8d3349f402576d02576a2971fc0d9f9776ce2f441c7010849c4ff5af",
- "paths": [
- "/home/user/work"
- ],
- "hostname": "kasimir",
- "username": "username",
- "uid": 501,
- "gid": 20
- }
+```console
+$ restic -r /tmp/backup cat snapshot d369ccc7d126594950bf74f0a348d5d98d9e99f3215082eb69bf02dc9b3e464c
+enter password for repository:
+{
+ "time": "2015-08-12T12:52:44.091448856+02:00",
+ "tree": "05cec17e8d3349f402576d02576a2971fc0d9f9776ce2f441c7010849c4ff5af",
+ "paths": [
+ "/home/user/work"
+ ],
+ "hostname": "kasimir",
+ "username": "username",
+ "uid": 501,
+ "gid": 20
+}
+```
diff --git a/doc/code.css b/doc/code.css
new file mode 100644
index 0000000..2a73b3a
--- /dev/null
+++ b/doc/code.css
@@ -0,0 +1,124 @@
+code {
+ font-size: 90%;
+}
+
+/* based on https://github.com/mkdocs/mkdocs/issues/1019 */
+
+.codehilite code, .codehilite pre {
+ color:#3F3F3F;background-color:#F7F7F7;
+ overflow: auto;
+ box-sizing: border-box;
+
+ padding: 0.01em 4px;
+ padding-top: 0.01em;
+ padding-right-value: 4px;
+ padding-bottom: 0.01em;
+ padding-left-value: 4px;
+ padding-left-ltr-source: physical;
+ padding-left-rtl-source: physical;
+ padding-right-ltr-source: physical;
+ padding-right-rtl-source: physical;
+
+ border-radius: 4px !important;
+ border-top-left-radius: 4px;
+ border-top-right-radius: 4px;
+ border-bottom-right-radius: 4px;
+ border-bottom-left-radius: 4px;
+
+ border: 1px solid #CCC !important;
+ border-top-width: 1px;
+ border-right-width-value: 1px;
+ border-right-width-ltr-source: physical;
+ border-right-width-rtl-source: physical;
+ border-bottom-width: 1px;
+ border-left-width-value: 1px;
+ border-left-width-ltr-source: physical;
+ border-left-width-rtl-source: physical;
+ border-top-style: solid;
+ border-right-style-value: solid;
+ border-right-style-ltr-source: physical;
+ border-right-style-rtl-source: physical;
+ border-bottom-style: solid;
+ border-left-style-value: solid;
+ border-left-style-ltr-source: physical;
+ border-left-style-rtl-source: physical;
+ border-top-color: #CCC;
+ border-right-color-value: #CCC;
+ border-right-color-ltr-source: physical;
+ border-right-color-rtl-source: physical;
+ border-bottom-color: #CCC;
+ border-left-color-value: #CCC;
+ border-left-color-ltr-source: physical;
+ border-left-color-rtl-source: physical;
+ -moz-border-top-colors: none;
+ -moz-border-right-colors: none;
+ -moz-border-bottom-colors: none;
+ -moz-border-left-colors: none;
+ border-image-source: none;
+ border-image-slice: 100% 100% 100% 100%;
+ border-image-width: 1 1 1 1;
+ border-image-outset: 0 0 0 0;
+ border-image-repeat: stretch stretch;
+}
+
+.codehilite .hll { background-color: #ffffcc }
+.codehilite .c { color: #999988; font-style: italic } /* Comment */
+.codehilite .err { color: #a61717; background-color: #e3d2d2 } /* Error */
+.codehilite .k { color: #000000; font-weight: bold } /* Keyword */
+.codehilite .o { color: #000000; font-weight: bold } /* Operator */
+.codehilite .cm { color: #999988; font-style: italic } /* Comment.Multiline */
+.codehilite .cp { color: #999999; font-weight: bold; font-style: italic } /* Comment.Preproc */
+.codehilite .c1 { color: #999988; font-style: italic } /* Comment.Single */
+.codehilite .cs { color: #999999; font-weight: bold; font-style: italic } /* Comment.Special */
+.codehilite .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
+.codehilite .ge { color: #000000; font-style: italic } /* Generic.Emph */
+.codehilite .gr { color: #aa0000 } /* Generic.Error */
+.codehilite .gh { color: #999999 } /* Generic.Heading */
+.codehilite .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
+.codehilite .go { color: #888888 } /* Generic.Output */
+.codehilite .gp { color: #555555 } /* Generic.Prompt */
+.codehilite .gs { font-weight: bold } /* Generic.Strong */
+.codehilite .gu { color: #aaaaaa } /* Generic.Subheading */
+.codehilite .gt { color: #aa0000 } /* Generic.Traceback */
+.codehilite .kc { color: #000000; font-weight: bold } /* Keyword.Constant */
+.codehilite .kd { color: #000000; font-weight: bold } /* Keyword.Declaration */
+.codehilite .kn { color: #000000; font-weight: bold } /* Keyword.Namespace */
+.codehilite .kp { color: #000000; font-weight: bold } /* Keyword.Pseudo */
+.codehilite .kr { color: #000000; font-weight: bold } /* Keyword.Reserved */
+.codehilite .kt { color: #445588; font-weight: bold } /* Keyword.Type */
+.codehilite .m { color: #009999 } /* Literal.Number */
+.codehilite .s { color: #d01040 } /* Literal.String */
+.codehilite .na { color: #008080 } /* Name.Attribute */
+.codehilite .nb { color: #0086B3 } /* Name.Builtin */
+.codehilite .nc { color: #445588; font-weight: bold } /* Name.Class */
+.codehilite .no { color: #008080 } /* Name.Constant */
+.codehilite .nd { color: #3c5d5d; font-weight: bold } /* Name.Decorator */
+.codehilite .ni { color: #800080 } /* Name.Entity */
+.codehilite .ne { color: #990000; font-weight: bold } /* Name.Exception */
+.codehilite .nf { color: #990000; font-weight: bold } /* Name.Function */
+.codehilite .nl { color: #990000; font-weight: bold } /* Name.Label */
+.codehilite .nn { color: #555555 } /* Name.Namespace */
+.codehilite .nt { color: #000080 } /* Name.Tag */
+.codehilite .nv { color: #008080 } /* Name.Variable */
+.codehilite .ow { color: #000000; font-weight: bold } /* Operator.Word */
+.codehilite .w { color: #bbbbbb } /* Text.Whitespace */
+.codehilite .mf { color: #009999 } /* Literal.Number.Float */
+.codehilite .mh { color: #009999 } /* Literal.Number.Hex */
+.codehilite .mi { color: #009999 } /* Literal.Number.Integer */
+.codehilite .mo { color: #009999 } /* Literal.Number.Oct */
+.codehilite .sb { color: #d01040 } /* Literal.String.Backtick */
+.codehilite .sc { color: #d01040 } /* Literal.String.Char */
+.codehilite .sd { color: #d01040 } /* Literal.String.Doc */
+.codehilite .s2 { color: #d01040 } /* Literal.String.Double */
+.codehilite .se { color: #d01040 } /* Literal.String.Escape */
+.codehilite .sh { color: #d01040 } /* Literal.String.Heredoc */
+.codehilite .si { color: #d01040 } /* Literal.String.Interpol */
+.codehilite .sx { color: #d01040 } /* Literal.String.Other */
+.codehilite .sr { color: #009926 } /* Literal.String.Regex */
+.codehilite .s1 { color: #d01040 } /* Literal.String.Single */
+.codehilite .ss { color: #990073 } /* Literal.String.Symbol */
+.codehilite .bp { color: #999999 } /* Name.Builtin.Pseudo */
+.codehilite .vc { color: #008080 } /* Name.Variable.Class */
+.codehilite .vg { color: #008080 } /* Name.Variable.Global */
+.codehilite .vi { color: #008080 } /* Name.Variable.Instance */
+.codehilite .il { color: #009999 } /* Literal.Number.Integer.Long */
diff --git a/doc/index.md b/doc/index.md
index c66b1ac..2060384 100644
--- a/doc/index.md
+++ b/doc/index.md
@@ -20,10 +20,12 @@ this page, where you can select the version.
The restic documentation is built with [MkDocs](http://www.mkdocs.org). After
installing it, you can edit and view the documentation locally by running:
- $ mkdocs serve
- INFO - Building documentation...
- INFO - Cleaning site directory
- [I 160221 12:33:57 server:271] Serving on http://127.0.0.1:8000
+```console
+$ mkdocs serve
+INFO - Building documentation...
+INFO - Cleaning site directory
+[I 160221 12:33:57 server:271] Serving on http://127.0.0.1:8000
+```
Afterwards visit the URL with a browser.
diff --git a/mkdocs.yml b/mkdocs.yml
index 7ff2389..0ffd211 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -1,5 +1,9 @@
site_name: Documentation for restic
theme: readthedocs
+markdown_extensions:
+ - codehilite:
+extra_css:
+ - code.css
docs_dir: doc
pages:
- Getting Started: index.md
diff --git a/src/cmds/restic/background.go b/src/cmds/restic/background.go
new file mode 100644
index 0000000..2f115ad
--- /dev/null
+++ b/src/cmds/restic/background.go
@@ -0,0 +1,9 @@
+// +build !linux
+
+package main
+
+// IsProcessBackground should return true if it is running in the background or false if not
+func IsProcessBackground() bool {
+ //TODO: Check if the process are running in the background in other OS than linux
+ return false
+}
diff --git a/src/cmds/restic/background_linux.go b/src/cmds/restic/background_linux.go
new file mode 100644
index 0000000..285a0e8
--- /dev/null
+++ b/src/cmds/restic/background_linux.go
@@ -0,0 +1,21 @@
+package main
+
+import (
+ "syscall"
+ "unsafe"
+
+ "restic/debug"
+)
+
+// IsProcessBackground returns true if it is running in the background or false if not
+func IsProcessBackground() bool {
+ var pid int
+ _, _, err := syscall.Syscall(syscall.SYS_IOCTL, uintptr(syscall.Stdin), syscall.TIOCGPGRP, uintptr(unsafe.Pointer(&pid)))
+
+ if err != 0 {
+ debug.Log("Can't check if we are in the background. Using default behaviour. Error: %s\n", err.Error())
+ return false
+ }
+
+ return pid != syscall.Getpgrp()
+}
diff --git a/src/cmds/restic/cmd_backup.go b/src/cmds/restic/cmd_backup.go
index 57d09bf..aa3f3cc 100644
--- a/src/cmds/restic/cmd_backup.go
+++ b/src/cmds/restic/cmd_backup.go
@@ -46,6 +46,7 @@ type BackupOptions struct {
Stdin bool
StdinFilename string
Tags []string
+ FilesFrom string
}
var backupOptions BackupOptions
@@ -62,6 +63,7 @@ func init() {
f.BoolVar(&backupOptions.Stdin, "stdin", false, "read backup from stdin")
f.StringVar(&backupOptions.StdinFilename, "stdin-filename", "", "file name to use when reading from stdin")
f.StringSliceVar(&backupOptions.Tags, "tag", []string{}, "add a `tag` for the new snapshot (can be specified multiple times)")
+ f.StringVar(&backupOptions.FilesFrom, "files-from", "", "read the files to backup from file (can be combined with file args)")
}
func newScanProgress(gopts GlobalOptions) *restic.Progress {
@@ -71,8 +73,13 @@ func newScanProgress(gopts GlobalOptions) *restic.Progress {
p := restic.NewProgress()
p.OnUpdate = func(s restic.Stat, d time.Duration, ticker bool) {
+ if IsProcessBackground() {
+ return
+ }
+
PrintProgress("[%s] %d directories, %d files, %s", formatDuration(d), s.Dirs, s.Files, formatBytes(s.Bytes))
}
+
p.OnDone = func(s restic.Stat, d time.Duration, ticker bool) {
PrintProgress("scanned %d directories, %d files in %s\n", s.Dirs, s.Files, formatDuration(d))
}
@@ -91,6 +98,10 @@ func newArchiveProgress(gopts GlobalOptions, todo restic.Stat) *restic.Progress
itemsTodo := todo.Files + todo.Dirs
archiveProgress.OnUpdate = func(s restic.Stat, d time.Duration, ticker bool) {
+ if IsProcessBackground() {
+ return
+ }
+
sec := uint64(d / time.Second)
if todo.Bytes > 0 && sec > 0 && ticker {
bps = s.Bytes / sec
@@ -144,6 +155,10 @@ func newArchiveStdinProgress(gopts GlobalOptions) *restic.Progress {
var bps uint64
archiveProgress.OnUpdate = func(s restic.Stat, d time.Duration, ticker bool) {
+ if IsProcessBackground() {
+ return
+ }
+
sec := uint64(d / time.Second)
if s.Bytes > 0 && sec > 0 && ticker {
bps = s.Bytes / sec
@@ -241,16 +256,52 @@ func readBackupFromStdin(opts BackupOptions, gopts GlobalOptions, args []string)
return err
}
- fmt.Printf("archived as %v\n", id.Str())
+ Verbosef("archived as %v\n", id.Str())
return nil
}
+// readFromFile will read all lines from the given filename and write them to a
+// string array, if filename is empty readFromFile returns and empty string
+// array
+func readLinesFromFile(filename string) ([]string, error) {
+ if filename == "" {
+ return nil, nil
+ }
+
+ file, err := os.Open(filename)
+ if err != nil {
+ return nil, err
+ }
+ defer file.Close()
+
+ var lines []string
+
+ scanner := bufio.NewScanner(file)
+ for scanner.Scan() {
+ lines = append(lines, scanner.Text())
+ }
+
+ if err := scanner.Err(); err != nil {
+ return nil, err
+ }
+
+ return lines, nil
+}
+
func runBackup(opts BackupOptions, gopts GlobalOptions, args []string) error {
+ target, err := readLinesFromFile(opts.FilesFrom)
+ if err != nil {
+ return err
+ }
+
+ // merge files from files-from into normal args so we can reuse the normal
+ // args checks and have the ability to use both files-from and args at the
+ // same time
+ args = append(args, target...)
if len(args) == 0 {
return errors.Fatalf("wrong number of parameters")
}
- target := make([]string, 0, len(args))
for _, d := range args {
if a, err := filepath.Abs(d); err == nil {
d = a
@@ -258,7 +309,7 @@ func runBackup(opts BackupOptions, gopts GlobalOptions, args []string) error {
target = append(target, d)
}
- target, err := filterExisting(target)
+ target, err = filterExisting(target)
if err != nil {
return err
}
@@ -303,7 +354,13 @@ func runBackup(opts BackupOptions, gopts GlobalOptions, args []string) error {
// Find last snapshot to set it as parent, if not already set
if !opts.Force && parentSnapshotID == nil {
- id, err := restic.FindLatestSnapshot(repo, target, "")
+ hostname, err := os.Hostname()
+ if err != nil {
+ debug.Log("os.Hostname() returned err: %v", err)
+ hostname = ""
+ }
+
+ id, err := restic.FindLatestSnapshot(repo, target, hostname)
if err == nil {
parentSnapshotID = &id
} else if err != restic.ErrNoSnapshotFound {
@@ -346,7 +403,7 @@ func runBackup(opts BackupOptions, gopts GlobalOptions, args []string) error {
return false
}
- if !opts.ExcludeOtherFS {
+ if !opts.ExcludeOtherFS || fi == nil {
return true
}
@@ -374,10 +431,9 @@ func runBackup(opts BackupOptions, gopts GlobalOptions, args []string) error {
arch.Excludes = opts.Excludes
arch.SelectFilter = selectFilter
- arch.Error = func(dir string, fi os.FileInfo, err error) error {
+ arch.Warn = func(dir string, fi os.FileInfo, err error) {
// TODO: make ignoring errors configurable
- Warnf("%s\rerror for %s: %v\n", ClearLine(), dir, err)
- return nil
+ Warnf("%s\rwarning for %s: %v\n", ClearLine(), dir, err)
}
_, id, err := arch.Snapshot(newArchiveProgress(gopts, stat), target, opts.Tags, parentSnapshotID)
diff --git a/src/cmds/restic/cmd_forget.go b/src/cmds/restic/cmd_forget.go
index 04e2d24..e5a47d3 100644
--- a/src/cmds/restic/cmd_forget.go
+++ b/src/cmds/restic/cmd_forget.go
@@ -1,6 +1,7 @@
package main
import (
+ "encoding/hex"
"fmt"
"io"
"restic"
@@ -111,16 +112,24 @@ func runForget(opts ForgetOptions, gopts GlobalOptions, args []string) error {
return err
}
- err = repo.LoadIndex()
- if err != nil {
- return err
+ // parse arguments as hex strings
+ var ids []string
+ for _, s := range args {
+ _, err := hex.DecodeString(s)
+ if err != nil {
+ Warnf("argument %q is not a snapshot ID, ignoring\n", s)
+ continue
+ }
+
+ ids = append(ids, s)
}
- // first, process all snapshot IDs given as arguments
- for _, s := range args {
+ // process all snapshot IDs given as arguments
+ for _, s := range ids {
id, err := restic.FindSnapshot(repo, s)
if err != nil {
- return err
+ Warnf("cound not find a snapshot for ID %q, ignoring\n", s)
+ continue
}
if !opts.DryRun {
@@ -131,7 +140,7 @@ func runForget(opts ForgetOptions, gopts GlobalOptions, args []string) error {
Verbosef("removed snapshot %v\n", id.Str())
} else {
- Verbosef("would removed snapshot %v\n", id.Str())
+ Verbosef("would remove snapshot %v\n", id.Str())
}
}
diff --git a/src/cmds/restic/cmd_ls.go b/src/cmds/restic/cmd_ls.go
index 431f814..3b09054 100644
--- a/src/cmds/restic/cmd_ls.go
+++ b/src/cmds/restic/cmd_ls.go
@@ -39,13 +39,13 @@ func printNode(prefix string, n *restic.Node) string {
switch n.Type {
case "file":
return fmt.Sprintf("%s %5d %5d %6d %s %s",
- n.Mode, n.UID, n.GID, n.Size, n.ModTime, filepath.Join(prefix, n.Name))
+ n.Mode, n.UID, n.GID, n.Size, n.ModTime.Format(TimeFormat), filepath.Join(prefix, n.Name))
case "dir":
return fmt.Sprintf("%s %5d %5d %6d %s %s",
- n.Mode|os.ModeDir, n.UID, n.GID, n.Size, n.ModTime, filepath.Join(prefix, n.Name))
+ n.Mode|os.ModeDir, n.UID, n.GID, n.Size, n.ModTime.Format(TimeFormat), filepath.Join(prefix, n.Name))
case "symlink":
return fmt.Sprintf("%s %5d %5d %6d %s %s -> %s",
- n.Mode|os.ModeSymlink, n.UID, n.GID, n.Size, n.ModTime, filepath.Join(prefix, n.Name), n.LinkTarget)
+ n.Mode|os.ModeSymlink, n.UID, n.GID, n.Size, n.ModTime.Format(TimeFormat), filepath.Join(prefix, n.Name), n.LinkTarget)
default:
return fmt.Sprintf("<Node(%s) %s>", n.Type, n.Name)
}
diff --git a/src/cmds/restic/integration_test.go b/src/cmds/restic/integration_test.go
index 0987a47..d678426 100644
--- a/src/cmds/restic/integration_test.go
+++ b/src/cmds/restic/integration_test.go
@@ -343,6 +343,52 @@ func TestBackupMissingFile2(t *testing.T) {
})
}
+func TestBackupChangedFile(t *testing.T) {
+ withTestEnvironment(t, func(env *testEnvironment, gopts GlobalOptions) {
+ datafile := filepath.Join("testdata", "backup-data.tar.gz")
+ fd, err := os.Open(datafile)
+ if os.IsNotExist(errors.Cause(err)) {
+ t.Skipf("unable to find data file %q, skipping", datafile)
+ return
+ }
+ OK(t, err)
+ OK(t, fd.Close())
+
+ SetupTarTestFixture(t, env.testdata, datafile)
+
+ testRunInit(t, gopts)
+
+ globalOptions.stderr = ioutil.Discard
+ defer func() {
+ globalOptions.stderr = os.Stderr
+ }()
+
+ modFile := filepath.Join(env.testdata, "0", "0", "6", "18")
+
+ ranHook := false
+ debug.Hook("archiver.SaveFile", func(context interface{}) {
+ pathname := context.(string)
+
+ if pathname != modFile {
+ return
+ }
+
+ t.Logf("in hook, modifying test file %v", modFile)
+ ranHook = true
+
+ OK(t, ioutil.WriteFile(modFile, []byte("modified"), 0600))
+ })
+
+ opts := BackupOptions{}
+
+ testRunBackup(t, []string{env.testdata}, opts, gopts)
+ testRunCheck(t, gopts)
+
+ Assert(t, ranHook, "hook did not run")
+ debug.RemoveHook("archiver.SaveFile")
+ })
+}
+
func TestBackupDirectoryError(t *testing.T) {
withTestEnvironment(t, func(env *testEnvironment, gopts GlobalOptions) {
datafile := filepath.Join("testdata", "backup-data.tar.gz")
diff --git a/src/restic/archiver/archiver.go b/src/restic/archiver/archiver.go
index 8ef1814..b1912f8 100644
--- a/src/restic/archiver/archiver.go
+++ b/src/restic/archiver/archiver.go
@@ -26,7 +26,9 @@ const (
maxConcurrency = 10
)
-var archiverAbortOnAllErrors = func(str string, fi os.FileInfo, err error) error { return err }
+var archiverPrintWarnings = func(path string, fi os.FileInfo, err error) {
+ fmt.Fprintf(os.Stderr, "warning for %v: %v", path, err)
+}
var archiverAllowAllFiles = func(string, os.FileInfo) bool { return true }
// Archiver is used to backup a set of directories.
@@ -39,7 +41,7 @@ type Archiver struct {
blobToken chan struct{}
- Error func(dir string, fi os.FileInfo, err error) error
+ Warn func(dir string, fi os.FileInfo, err error)
SelectFilter pipe.SelectFunc
Excludes []string
}
@@ -61,7 +63,7 @@ func New(repo restic.Repository) *Archiver {
arch.blobToken <- struct{}{}
}
- arch.Error = archiverAbortOnAllErrors
+ arch.Warn = archiverPrintWarnings
arch.SelectFilter = archiverAllowAllFiles
return arch
@@ -135,10 +137,7 @@ func (arch *Archiver) reloadFileIfChanged(node *restic.Node, file fs.File) (*res
return node, nil
}
- err = arch.Error(node.Path, fi, errors.New("file has changed"))
- if err != nil {
- return nil, err
- }
+ arch.Warn(node.Path, fi, errors.New("file has changed"))
node, err = restic.NodeFromFileInfo(node.Path, fi)
if err != nil {
@@ -197,7 +196,7 @@ func updateNodeContent(node *restic.Node, results []saveResult) error {
}
if bytes != node.Size {
- return errors.Errorf("errors saving node %q: saved %d bytes, wanted %d bytes", node.Path, bytes, node.Size)
+ fmt.Fprintf(os.Stderr, "warning for %v: expected %d bytes, saved %d bytes\n", node.Path, node.Size, bytes)
}
debug.Log("SaveFile(%q): %v blobs\n", node.Path, len(results))
@@ -207,16 +206,18 @@ func updateNodeContent(node *restic.Node, results []saveResult) error {
// SaveFile stores the content of the file on the backend as a Blob by calling
// Save for each chunk.
-func (arch *Archiver) SaveFile(p *restic.Progress, node *restic.Node) error {
+func (arch *Archiver) SaveFile(p *restic.Progress, node *restic.Node) (*restic.Node, error) {
file, err := fs.Open(node.Path)
defer file.Close()
if err != nil {
- return errors.Wrap(err, "Open")
+ return nil, errors.Wrap(err, "Open")
}
+ debug.RunHook("archiver.SaveFile", node.Path)
+
node, err = arch.reloadFileIfChanged(node, file)
if err != nil {
- return err
+ return nil, err
}
chnker := chunker.New(file, arch.repo.Config().ChunkerPolynomial)
@@ -229,7 +230,7 @@ func (arch *Archiver) SaveFile(p *restic.Progress, node *restic.Node) error {
}
if err != nil {
- return errors.Wrap(err, "chunker.Next")
+ return nil, errors.Wrap(err, "chunker.Next")
}
resCh := make(chan saveResult, 1)
@@ -239,11 +240,11 @@ func (arch *Archiver) SaveFile(p *restic.Progress, node *restic.Node) error {
results, err := waitForResults(resultChannels)
if err != nil {
- return err
+ return nil, err
}
-
err = updateNodeContent(node, results)
- return err
+
+ return node, err
}
func (arch *Archiver) fileWorker(wg *sync.WaitGroup, p *restic.Progress, done <-chan struct{}, entCh <-chan pipe.Entry) {
@@ -307,7 +308,7 @@ func (arch *Archiver) fileWorker(wg *sync.WaitGroup, p *restic.Progress, done <-
// otherwise read file normally
if node.Type == "file" && len(node.Content) == 0 {
debug.Log(" read and save %v, content: %v", e.Path(), node.Content)
- err = arch.SaveFile(p, node)
+ node, err = arch.SaveFile(p, node)
if err != nil {
// TODO: integrate error reporting
fmt.Fprintf(os.Stderr, "error for %v: %v\n", node.Path, err)
@@ -727,19 +728,6 @@ func (arch *Archiver) Snapshot(p *restic.Progress, paths, tags []string, parentI
debug.Log("workers terminated")
- // receive the top-level tree
- root := (<-resCh).(*restic.Node)
- debug.Log("root node received: %v", root.Subtree.Str())
- sn.Tree = root.Subtree
-
- // save snapshot
- id, err := arch.repo.SaveJSONUnpacked(restic.SnapshotFile, sn)
- if err != nil {
- return nil, restic.ID{}, err
- }
-
- debug.Log("saved snapshot %v", id.Str())
-
// flush repository
err = arch.repo.Flush()
if err != nil {
@@ -755,6 +743,19 @@ func (arch *Archiver) Snapshot(p *restic.Progress, paths, tags []string, parentI
debug.Log("saved indexes")
+ // receive the top-level tree
+ root := (<-resCh).(*restic.Node)
+ debug.Log("root node received: %v", root.Subtree.Str())
+ sn.Tree = root.Subtree
+
+ // save snapshot
+ id, err := arch.repo.SaveJSONUnpacked(restic.SnapshotFile, sn)
+ if err != nil {
+ return nil, restic.ID{}, err
+ }
+
+ debug.Log("saved snapshot %v", id.Str())
+
return sn, id, nil
}
diff --git a/src/restic/backend/local/local.go b/src/restic/backend/local/local.go
index 98172af..e09650e 100644
--- a/src/restic/backend/local/local.go
+++ b/src/restic/backend/local/local.go
@@ -118,7 +118,7 @@ func (b *Local) Load(h restic.Handle, p []byte, off int64) (n int, err error) {
defer func() {
e := f.Close()
- if err == nil && e != nil {
+ if err == nil {
err = errors.Wrap(e, "Close")
}
}()
@@ -157,11 +157,6 @@ func writeToTempfile(tempdir string, p []byte) (filename string, err error) {
return "", errors.Wrap(err, "Syncn")
}
- err = fs.ClearCache(tmpfile)
- if err != nil {
- return "", errors.Wrap(err, "ClearCache")
- }
-
err = tmpfile.Close()
if err != nil {
return "", errors.Wrap(err, "Close")
diff --git a/src/restic/backend/rest/rest.go b/src/restic/backend/rest/rest.go
index ce1d25d..f01854f 100644
--- a/src/restic/backend/rest/rest.go
+++ b/src/restic/backend/rest/rest.go
@@ -5,6 +5,7 @@ import (
"encoding/json"
"fmt"
"io"
+ "io/ioutil"
"net/http"
"net/url"
"path"
@@ -59,7 +60,7 @@ func Open(cfg Config) (restic.Backend, error) {
for i := 0; i < connLimit; i++ {
connChan <- struct{}{}
}
- tr := &http.Transport{}
+ tr := &http.Transport{MaxIdleConnsPerHost: connLimit}
client := http.Client{Transport: tr}
return &restBackend{url: cfg.URL, connChan: connChan, client: client}, nil
@@ -102,6 +103,7 @@ func (b *restBackend) Load(h restic.Handle, p []byte, off int64) (n int, err err
if resp != nil {
defer func() {
+ io.Copy(ioutil.Discard, resp.Body)
e := resp.Body.Close()
if err == nil {
@@ -132,6 +134,7 @@ func (b *restBackend) Save(h restic.Handle, p []byte) (err error) {
if resp != nil {
defer func() {
+ io.Copy(ioutil.Discard, resp.Body)
e := resp.Body.Close()
if err == nil {
@@ -164,6 +167,7 @@ func (b *restBackend) Stat(h restic.Handle) (restic.FileInfo, error) {
return restic.FileInfo{}, errors.Wrap(err, "client.Head")
}
+ io.Copy(ioutil.Discard, resp.Body)
if err = resp.Body.Close(); err != nil {
return restic.FileInfo{}, errors.Wrap(err, "Close")
}
@@ -216,6 +220,7 @@ func (b *restBackend) Remove(t restic.FileType, name string) error {
return errors.New("blob not removed")
}
+ io.Copy(ioutil.Discard, resp.Body)
return resp.Body.Close()
}
@@ -235,7 +240,14 @@ func (b *restBackend) List(t restic.FileType, done <-chan struct{}) <-chan strin
b.connChan <- struct{}{}
if resp != nil {
- defer resp.Body.Close()
+ defer func() {
+ io.Copy(ioutil.Discard, resp.Body)
+ e := resp.Body.Close()
+
+ if err == nil {
+ err = errors.Wrap(e, "Close")
+ }
+ }()
}
if err != nil {
diff --git a/src/restic/backend/s3/s3.go b/src/restic/backend/s3/s3.go
index 806fb54..56a6833 100644
--- a/src/restic/backend/s3/s3.go
+++ b/src/restic/backend/s3/s3.go
@@ -3,6 +3,7 @@ package s3
import (
"bytes"
"io"
+ "path"
"restic"
"strings"
@@ -36,13 +37,13 @@ func Open(cfg Config) (restic.Backend, error) {
be := &s3{client: client, bucketname: cfg.Bucket, prefix: cfg.Prefix}
be.createConnections()
- ok, err := client.BucketExists(cfg.Bucket)
+ found, err := client.BucketExists(cfg.Bucket)
if err != nil {
- debug.Log("BucketExists(%v) returned err %v, trying to create the bucket", cfg.Bucket, err)
+ debug.Log("BucketExists(%v) returned err %v", cfg.Bucket, err)
return nil, errors.Wrap(err, "client.BucketExists")
}
- if !ok {
+ if !found {
// create new bucket with default ACL in default region
err = client.MakeBucket(cfg.Bucket, "")
if err != nil {
@@ -54,17 +55,10 @@ func Open(cfg Config) (restic.Backend, error) {
}
func (be *s3) s3path(t restic.FileType, name string) string {
- var path string
-
- if be.prefix != "" {
- path = be.prefix + "/"
- }
- path += string(t)
-
if t == restic.ConfigFile {
- return path
+ return path.Join(be.prefix, string(t))
}
- return path + "/" + name
+ return path.Join(be.prefix, string(t), name)
}
func (be *s3) createConnections() {
@@ -85,14 +79,14 @@ func (be s3) Load(h restic.Handle, p []byte, off int64) (n int, err error) {
var obj *minio.Object
debug.Log("%v, offset %v, len %v", h, off, len(p))
- path := be.s3path(h.Type, h.Name)
+ objName := be.s3path(h.Type, h.Name)
<-be.connChan
defer func() {
be.connChan <- struct{}{}
}()
- obj, err = be.client.GetObject(be.bucketname, path)
+ obj, err = be.client.GetObject(be.bucketname, objName)
if err != nil {
debug.Log(" err %v", err)
return 0, errors.Wrap(err, "client.GetObject")
@@ -160,10 +154,10 @@ func (be s3) Save(h restic.Handle, p []byte) (err error) {
debug.Log("%v with %d bytes", h, len(p))
- path := be.s3path(h.Type, h.Name)
+ objName := be.s3path(h.Type, h.Name)
// Check key does not already exist
- _, err = be.client.StatObject(be.bucketname, path)
+ _, err = be.client.StatObject(be.bucketname, objName)
if err == nil {
debug.Log("%v already exists", h)
return errors.New("key already exists")
@@ -175,9 +169,9 @@ func (be s3) Save(h restic.Handle, p []byte) (err error) {
}()
debug.Log("PutObject(%v, %v, %v, %v)",
- be.bucketname, path, int64(len(p)), "binary/octet-stream")
- n, err := be.client.PutObject(be.bucketname, path, bytes.NewReader(p), "binary/octet-stream")
- debug.Log("%v -> %v bytes, err %#v", path, n, err)
+ be.bucketname, objName, int64(len(p)), "binary/octet-stream")
+ n, err := be.client.PutObject(be.bucketname, objName, bytes.NewReader(p), "binary/octet-stream")
+ debug.Log("%v -> %v bytes, err %#v", objName, n, err)
return errors.Wrap(err, "client.PutObject")
}
@@ -186,10 +180,10 @@ func (be s3) Save(h restic.Handle, p []byte) (err error) {
func (be s3) Stat(h restic.Handle) (bi restic.FileInfo, err error) {
debug.Log("%v", h)
- path := be.s3path(h.Type, h.Name)
+ objName := be.s3path(h.Type, h.Name)
var obj *minio.Object
- obj, err = be.client.GetObject(be.bucketname, path)
+ obj, err = be.client.GetObject(be.bucketname, objName)
if err != nil {
debug.Log("GetObject() err %v", err)
return restic.FileInfo{}, errors.Wrap(err, "client.GetObject")
@@ -215,8 +209,8 @@ func (be s3) Stat(h restic.Handle) (bi restic.FileInfo, err error) {
// Test returns true if a blob of the given type and name exists in the backend.
func (be *s3) Test(t restic.FileType, name string) (bool, error) {
found := false
- path := be.s3path(t, name)
- _, err := be.client.StatObject(be.bucketname, path)
+ objName := be.s3path(t, name)
+ _, err := be.client.StatObject(be.bucketname, objName)
if err == nil {
found = true
}
@@ -227,8 +221,8 @@ func (be *s3) Test(t restic.FileType, name string) (bool, error) {
// Remove removes the blob with the given name and type.
func (be *s3) Remove(t restic.FileType, name string) error {
- path := be.s3path(t, name)
- err := be.client.RemoveObject(be.bucketname, path)
+ objName := be.s3path(t, name)
+ err := be.client.RemoveObject(be.bucketname, objName)
debug.Log("%v %v -> err %v", t, name, err)
return errors.Wrap(err, "client.RemoveObject")
}
@@ -240,7 +234,7 @@ func (be *s3) List(t restic.FileType, done <-chan struct{}) <-chan string {
debug.Log("listing %v", t)
ch := make(chan string)
- prefix := be.s3path(t, "")
+ prefix := be.s3path(t, "") + "/"
listresp := be.client.ListObjects(be.bucketname, prefix, true, done)
diff --git a/src/restic/backend/sftp/sftp.go b/src/restic/backend/sftp/sftp.go
index 2809dc6..9555544 100644
--- a/src/restic/backend/sftp/sftp.go
+++ b/src/restic/backend/sftp/sftp.go
@@ -345,7 +345,7 @@ func (r *SFTP) Load(h restic.Handle, p []byte, off int64) (n int, err error) {
defer func() {
e := f.Close()
- if err == nil && e != nil {
+ if err == nil {
err = errors.Wrap(e, "Close")
}
}()
diff --git a/src/restic/fs/deviceid_unix.go b/src/restic/fs/deviceid_unix.go
index 684c3cc..40069d3 100644
--- a/src/restic/fs/deviceid_unix.go
+++ b/src/restic/fs/deviceid_unix.go
@@ -12,10 +12,19 @@ import (
// DeviceID extracts the device ID from an os.FileInfo object by casting it
// to syscall.Stat_t
func DeviceID(fi os.FileInfo) (deviceID uint64, err error) {
+ if fi == nil {
+ return 0, errors.New("unable to determine device: fi is nil")
+ }
+
+ if fi.Sys() == nil {
+ return 0, errors.New("unable to determine device: fi.Sys() is nil")
+ }
+
if st, ok := fi.Sys().(*syscall.Stat_t); ok {
// st.Dev is uint32 on Darwin and uint64 on Linux. Just cast
// everything to uint64.
return uint64(st.Dev), nil
}
+
return 0, errors.New("Could not cast to syscall.Stat_t")
}
diff --git a/src/restic/fs/file.go b/src/restic/fs/file.go
index f6836eb..b7e81a3 100644
--- a/src/restic/fs/file.go
+++ b/src/restic/fs/file.go
@@ -5,6 +5,7 @@ import (
"os"
"path/filepath"
"runtime"
+ "strings"
)
// File is an open file on a file system.
@@ -26,7 +27,20 @@ func fixpath(name string) string {
if runtime.GOOS == "windows" {
abspath, err := filepath.Abs(name)
if err == nil {
- return "\\\\?\\" + abspath
+ // Check if \\?\UNC\ already exist
+ if strings.HasPrefix(abspath, `\\?\UNC\`) {
+ return abspath
+ }
+ // Check if \\?\ already exist
+ if strings.HasPrefix(abspath, `\\?\`) {
+ return abspath
+ }
+ // Check if path starts with \\
+ if strings.HasPrefix(abspath, `\\`) {
+ return strings.Replace(abspath, `\\`, `\\?\UNC\`, 1)
+ }
+ // Normal path
+ return `\\?\` + abspath
}
}
return name
@@ -111,6 +125,11 @@ func Create(name string) (*os.File, error) {
return os.Create(fixpath(name))
}
+// Open opens a file for reading.
+func Open(name string) (File, error) {
+ return os.Open(fixpath(name))
+}
+
// OpenFile is the generalized open call; most users will use Open
// or Create instead. It opens the named file with specified flag
// (O_RDONLY etc.) and perm, (0666 etc.) if applicable. If successful,
diff --git a/src/restic/fs/file_linux.go b/src/restic/fs/file_linux.go
deleted file mode 100644
index f02c647..0000000
--- a/src/restic/fs/file_linux.go
+++ /dev/null
@@ -1,59 +0,0 @@
-// +build linux,go1.4
-
-package fs
-
-import (
- "os"
- "syscall"
-
- "restic/errors"
-
- "golang.org/x/sys/unix"
-)
-
-// Open opens a file for reading, without updating the atime and without caching data on read.
-func Open(name string) (File, error) {
- file, err := os.OpenFile(name, os.O_RDONLY|syscall.O_NOATIME, 0)
- if os.IsPermission(errors.Cause(err)) {
- file, err = os.OpenFile(name, os.O_RDONLY, 0)
- }
- return &nonCachingFile{File: file}, err
-}
-
-// nonCachingFile wraps an *os.File and calls fadvise() to instantly forget
-// data that has been read or written.
-type nonCachingFile struct {
- *os.File
- readOffset int64
-}
-
-func (f *nonCachingFile) Read(p []byte) (int, error) {
- n, err := f.File.Read(p)
-
- if n > 0 {
- ferr := unix.Fadvise(int(f.File.Fd()), f.readOffset, int64(n), unix.FADV_DONTNEED)
-
- f.readOffset += int64(n)
-
- if err == nil {
- err = ferr
- }
- }
-
- return n, err
-}
-
-// ClearCache syncs and then removes the file's content from the OS cache.
-func ClearCache(file File) error {
- f, ok := file.(*os.File)
- if !ok {
- panic("ClearCache called for file not *os.File")
- }
-
- err := f.Sync()
- if err != nil {
- return err
- }
-
- return unix.Fadvise(int(f.Fd()), 0, 0, unix.FADV_DONTNEED)
-}
diff --git a/src/restic/fs/file_nonlinux.go b/src/restic/fs/file_nonlinux.go
deleted file mode 100644
index 6723480..0000000
--- a/src/restic/fs/file_nonlinux.go
+++ /dev/null
@@ -1,15 +0,0 @@
-// +build !linux !go1.4
-
-package fs
-
-import "os"
-
-// Open opens a file for reading.
-func Open(name string) (File, error) {
- return os.OpenFile(fixpath(name), os.O_RDONLY, 0)
-}
-
-// ClearCache syncs and then removes the file's content from the OS cache.
-func ClearCache(f File) error {
- return nil
-}
diff --git a/src/restic/node.go b/src/restic/node.go
index 81f3ef8..e172151 100644
--- a/src/restic/node.go
+++ b/src/restic/node.go
@@ -184,7 +184,7 @@ func (node Node) RestoreTimestamps(path string) error {
func (node Node) createDirAt(path string) error {
err := fs.Mkdir(path, node.Mode)
- if err != nil {
+ if err != nil && !os.IsExist(err) {
return errors.Wrap(err, "Mkdir")
}
diff --git a/src/restic/node_test.go b/src/restic/node_test.go
index a2e175b..e219d89 100644
--- a/src/restic/node_test.go
+++ b/src/restic/node_test.go
@@ -137,6 +137,31 @@ var nodeTests = []restic.Node{
AccessTime: parseTime("2015-05-14 21:07:24.222"),
ChangeTime: parseTime("2015-05-14 21:07:25.333"),
},
+
+ // include "testFile" and "testDir" again with slightly different
+ // metadata, so we can test if CreateAt works with pre-existing files.
+ restic.Node{
+ Name: "testFile",
+ Type: "file",
+ Content: restic.IDs{},
+ UID: uint32(os.Getuid()),
+ GID: uint32(os.Getgid()),
+ Mode: 0604,
+ ModTime: parseTime("2005-05-14 21:07:03.111"),
+ AccessTime: parseTime("2005-05-14 21:07:04.222"),
+ ChangeTime: parseTime("2005-05-14 21:07:05.333"),
+ },
+ restic.Node{
+ Name: "testDir",
+ Type: "dir",
+ Subtree: nil,
+ UID: uint32(os.Getuid()),
+ GID: uint32(os.Getgid()),
+ Mode: 0750 | os.ModeDir,
+ ModTime: parseTime("2005-05-14 21:07:03.111"),
+ AccessTime: parseTime("2005-05-14 21:07:04.222"),
+ ChangeTime: parseTime("2005-05-14 21:07:05.333"),
+ },
}
func TestNodeRestoreAt(t *testing.T) {
diff --git a/src/restic/snapshot.go b/src/restic/snapshot.go
index 3bc0c87..2320fd9 100644
--- a/src/restic/snapshot.go
+++ b/src/restic/snapshot.go
@@ -145,8 +145,8 @@ func SamePaths(expected, actual []string) bool {
// ErrNoSnapshotFound is returned when no snapshot for the given criteria could be found.
var ErrNoSnapshotFound = errors.New("no snapshot found")
-// FindLatestSnapshot finds latest snapshot with optional target/directory and source filters
-func FindLatestSnapshot(repo Repository, targets []string, source string) (ID, error) {
+// FindLatestSnapshot finds latest snapshot with optional target/directory and hostname filters.
+func FindLatestSnapshot(repo Repository, targets []string, hostname string) (ID, error) {
var (
latest time.Time
latestID ID
@@ -158,7 +158,7 @@ func FindLatestSnapshot(repo Repository, targets []string, source string) (ID, e
if err != nil {
return ID{}, errors.Errorf("Error listing snapshot: %v", err)
}
- if snapshot.Time.After(latest) && SamePaths(snapshot.Paths, targets) && (source == "" || source == snapshot.Hostname) {
+ if snapshot.Time.After(latest) && SamePaths(snapshot.Paths, targets) && (hostname == "" || hostname == snapshot.Hostname) {
latest = snapshot.Time
latestID = snapshotID
found = true
diff --git a/vendor/manifest b/vendor/manifest
index 835aa40..7deaab8 100644
--- a/vendor/manifest
+++ b/vendor/manifest
@@ -10,7 +10,7 @@
{
"importpath": "github.com/elithrar/simple-scrypt",
"repository": "https://github.com/elithrar/simple-scrypt",
- "revision": "cbb1ebac08e2ca5495a43f4ef5555e61a7ec7677",
+ "revision": "2325946f714c95de4a6088202c402fbdfa64163b",
"branch": "master"
},
{
@@ -85,7 +85,7 @@
{
"importpath": "golang.org/x/crypto/poly1305",
"repository": "https://go.googlesource.com/crypto",
- "revision": "81372b2fc2f10bef2a7f338da115c315a56b2726",
+ "revision": "5f31782cfb2b6373211f8f9fbf31283fa234b570",
"branch": "master",
"path": "/poly1305"
},