aboutsummaryrefslogtreecommitdiff
path: root/lib/App/Glacier.pm
diff options
context:
space:
mode:
Diffstat (limited to 'lib/App/Glacier.pm')
-rw-r--r--lib/App/Glacier.pm57
1 files changed, 44 insertions, 13 deletions
diff --git a/lib/App/Glacier.pm b/lib/App/Glacier.pm
index fea94d5..2954a23 100644
--- a/lib/App/Glacier.pm
+++ b/lib/App/Glacier.pm
@@ -187,6 +187,11 @@ Removes the vault. It must be empty for the command to succeed.
187 187
188Synchronizes the local vault directory with its latest inventory. 188Synchronizes the local vault directory with its latest inventory.
189 189
190=head2 glacier periodic
191
192Periodic task for glacier job maintenance. It is recommended to run it
193each 4 hours as a cronjob.
194
190=head1 OPTIONS 195=head1 OPTIONS
191 196
192=over 4 197=over 4
@@ -230,10 +235,17 @@ Displays a succint command line usage summary,
230 235
231=head1 CONFIGURATION 236=head1 CONFIGURATION
232 237
233Default configuration file is F</etc/glacier.conf>. Its location is 238Default configuration file is F</etc/glacier.conf>. This file is optional.
234overridden by the value of the command line option B<--config-file> (B<-c>) 239If it does not exist, B<glacier> will attempt to start up with default
235and the environment variable B<GLACIER_CONF>. The option takes precedence 240values (optionally modified by the command line options). If you run
236over the variable. 241glacier on a EC2 instance with an associated IAM profile, you can omit
242the configuration file, provided that the profile gives the necessary
243permissions on the Glacier storage. Please see
244L<https://docs.aws.amazon.com/amazonglacier/latest/dev/access-control-identity-based.html> for details on identity-based policies.
245
246Th configuration file can also be specified using the environment variable
247B<GLACIER_CONF>, or from the command line, using the B<--config-file> (B<-c>)
248option. If both are used, the option takes precedence over the variable.
237 249
238Configuration file consists of statements in the form 250Configuration file consists of statements in the form
239I<variable> B<=> I<value>), grouped into sections. Whitespace is ignored, 251I<variable> B<=> I<value>), grouped into sections. Whitespace is ignored,
@@ -265,24 +277,28 @@ security reason.
265 277
266=item B<region => I<NAME> 278=item B<region => I<NAME>
267 279
268Sets the Amazon region. 280Sets the Amazon region. If this setting is absent, B<glacier> will attempt
281to retrieve the region from the instance store (assuming it is run on an EC2
282AWS instance).
269 283
270=back 284=back
271 285
272The preferred way for storing credentials is in the I<credentials file>. This 286If either of B<access> or B<secret> is not supplied, B<glacier> attemtps to
273file allows you to store all security sensitive data in a single place and to 287obtain access and secret keys from the file named in the B<credentials>
274tighten permissions accordingly. In the simplest case, this file contains a 288setting (if it is defined). If unable to find credentials, B<glacier> attempts
275single line with your access and secret keys separated by a semicolon, e.g.: 289to get credentials from the instance store, assuming it is run on an EC2
290instance. It will exit if this attempt fails.
291
292The credentials file allows you to store all security sensitive data in a
293single place and to tighten permissions accordingly. In the simplest case,
294this file contains a single line with your access and secret keys separated
295by a semicolon, e.g.:
276 296
277 AEBRGYTEBRET:RTFERYABNERTYR4HDDHEYRTWW 297 AEBRGYTEBRET:RTFERYABNERTYR4HDDHEYRTWW
278 298
279Additionally, the default region can be specified after a second semicolon: 299Additionally, the default region can be specified after a second semicolon:
280 300
281 AEBRGYTEBRET:RTFERYABNERTYR4HDDHEYRTWW:us-west-1 301 AEBRGYTEBRET:RTFERYABNERTYR4HDDHEYRTWW:us-west-1
282
283The default region is B<eu-west-1>.
284
285=item Multiple accounts
286 302
287If you have several accounts, you can list their credentials on separate lines. 303If you have several accounts, you can list their credentials on separate lines.
288In that case, B<glacier> will select the account with the access key supplied 304In that case, B<glacier> will select the account with the access key supplied
@@ -325,6 +341,21 @@ Sets the number of retries for failed transfers. Defaults to 10.
325 341
326=back 342=back
327 343
344=item B<[transfer download]>
345
346In addition to settings discussed above, the C<transfer download> section
347can contain the following:
348
349=over 8
350
351=item B<cachedir => I<DIR>
352
353Names the directory used to keep files downloaded after successful
354completion of archive retrieval jobs. This directory is managed by
355B<glacier periodic> subcommand. The default value is F</var/lib/glacier/cache>.
356
357=back
358
328=item B<[database job]> 359=item B<[database job]>
329 360
330Configures the I<job database>. Job database is a local GDBM file, which 361Configures the I<job database>. Job database is a local GDBM file, which

Return to:

Send suggestions and report system problems to the System administrator.