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
30              --time-template "2006-01-02_15-04-05"
31
32
33
34       You need to specify a sample format for  exactly  the  following  time‐
35       stamp:
36
37
38              Mon Jan 2 15:04:05 -0700 MST 2006
39
40
41
42       For details please see the documentation for time.Format() at:
43         https://godoc.org/time#Time.Format
44
45
46       For  path  templates,  you can use the following patterns which will be
47       replaced:
48           %i by short snapshot ID
49           %I by long snapshot ID
50           %u by username
51           %h by hostname
52           %t by tags
53           %T by timestamp as specified by --time-template
54
55
56       The default path templates are:
57           "ids/%i"
58           "snapshots/%T"
59           "hosts/%h/%T"
60           "tags/%t/%T"
61
62
63

EXIT STATUS

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

OPTIONS

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

OPTIONS INHERITED FROM PARENT COMMANDS

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