restic-mount(1)

1restic backup(1)                                              restic backup(1)
2
3
4

NAME

6       restic-mount - Mount the repository
7
8
9

SYNOPSIS

11       restic mount [flags] mountpoint
12
13
14

DESCRIPTION

16       The "mount" command mounts the repository via fuse to a directory. This
17       is a read-only mount.
18
19
20

Snapshot Directories

22       If you need a different template for  directories  that  contain  snap‐
23       shots,  you  can pass a time template via --time-template and path tem‐
24       plates via --path-template.
25
26
27       Example time template without colons:
28
29       --time-template "2006-01-02_15-04-05"
30
31
32
33       You need to specify a sample format for  exactly  the  following  time‐
34       stamp:
35
36       Mon Jan 2 15:04:05 -0700 MST 2006
37
38
39
40       For details please see the documentation for time.Format() at:
41         https://godoc.org/time#Time.Format
42
43
44       For  path  templates,  you can use the following patterns which will be
45       replaced:
46           %i by short snapshot ID
47           %I by long snapshot ID
48           %u by username
49           %h by hostname
50           %t by tags
51           %T by timestamp as specified by --time-template
52
53
54       The default path templates are:
55           "ids/%i"
56           "snapshots/%T"
57           "hosts/%h/%T"
58           "tags/%t/%T"
59
60
61

EXIT STATUS

63       Exit status is 0 if the command was successful, and non-zero  if  there
64       was any error.
65
66
67

OPTIONS

69       --allow-other[=false]       allow other users to access the data in the
70       mounted directory
71
72
73       -h, --help[=false]      help for mount
74
75
76       -H, --host=[]      only consider snapshots for this host (can be speci‐
77       fied multiple times)
78
79
80       --no-default-permissions[=false]       for  'allow-other',  ignore Unix
81       permissions and allow users to read all snapshot files
82
83
84       --owner-root[=false]      use 'root' as the owner of files and dirs
85
86
87       --path=[]      only consider snapshots including this  (absolute)  path
88       (can be specified multiple times)
89
90
91       --path-template=[]       set  template for path names (can be specified
92       multiple times)
93
94
95       --tag=[]      only consider snapshots including tag[,tag,...]  (can  be
96       specified multiple times)
97
98
99       --time-template="2006-01-02T15:04:05Z07:00"       set  template  to use
100       for times
101
102
103

OPTIONS INHERITED FROM PARENT COMMANDS

105       --cacert=[]      file to load root certificates from (default: use sys‐
106       tem certificates or $RESTIC_CACERT)
107
108
109       --cache-dir=""       set  the cache directory. (default: use system de‐
110       fault cache directory)
111
112
113       --cleanup-cache[=false]      auto remove old cache directories
114
115
116       --compression=auto      compression mode (only available for repository
117       format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION)
118
119
120       --insecure-tls[=false]      skip TLS certificate verification when con‐
121       necting to the repository (insecure)
122
123
124       --json[=false]      set output mode to JSON for commands  that  support
125       it
126
127
128       --key-hint=""       key  ID  of  key  to try decrypting first (default:
129       $RESTIC_KEY_HINT)
130
131
132       --limit-download=0      limits downloads to a maximum  rate  in  KiB/s.
133       (default: unlimited)
134
135
136       --limit-upload=0       limits  uploads to a maximum rate in KiB/s. (de‐
137       fault: unlimited)
138
139
140       --no-cache[=false]      do not use a local cache
141
142
143       --no-lock[=false]      do not lock the repository, this allows some op‐
144       erations on read-only repositories
145
146
147       -o,  --option=[]       set extended option (key=value, can be specified
148       multiple times)
149
150
151       --pack-size=0      set target pack size in MiB, created pack files  may
152       be larger (default: $RESTIC_PACK_SIZE)
153
154
155       --password-command=""      shell command to obtain the repository pass‐
156       word from (default: $RESTIC_PASSWORD_COMMAND)
157
158
159       -p, --password-file=""      file to read the repository  password  from
160       (default: $RESTIC_PASSWORD_FILE)
161
162
163       -q, --quiet[=false]      do not output comprehensive progress report
164
165
166       -r,  --repo=""       repository  to backup to or restore from (default:
167       $RESTIC_REPOSITORY)
168
169
170       --repository-file=""      file to read  the  repository  location  from
171       (default: $RESTIC_REPOSITORY_FILE)
172
173
174       --retry-lock=0s       retry  to  lock  the  repository if it is already
175       locked, takes a value like 5m or 2h (default: no retries)
176
177
178       --tls-client-cert=""      path to a file  containing  PEM  encoded  TLS
179       client certificate and private key (default: $RESTIC_TLS_CLIENT_CERT)
180
181
182       -v,  --verbose[=0]       be  verbose (specify multiple times or a level
183       using --verbose=n``, max level/times is 2)
184
185
186