From b6c86ababeca40e8ede83f8273c19083fe0f9748 Mon Sep 17 00:00:00 2001 From: Michael Eischer Date: Fri, 19 Aug 2022 20:41:15 +0200 Subject: [PATCH] doc: document aws session token --- doc/030_preparing_a_new_repo.rst | 3 +++ doc/040_backup.rst | 1 + 2 files changed, 4 insertions(+) diff --git a/doc/030_preparing_a_new_repo.rst b/doc/030_preparing_a_new_repo.rst index c8ad425a3..b575b2021 100644 --- a/doc/030_preparing_a_new_repo.rst +++ b/doc/030_preparing_a_new_repo.rst @@ -243,6 +243,9 @@ parameter like ``-o s3.region="us-east-1"``. If the region is not specified, the default region is used. Afterwards, the S3 server (at least for AWS, ``s3.amazonaws.com``) will redirect restic to the correct endpoint. +When using temporary credentials make sure to include the session token via +then environment variable ``AWS_SESSION_TOKEN``. + Until version 0.8.0, restic used a default prefix of ``restic``, so the files in the bucket were placed in a directory named ``restic``. If you want to access a repository created with an older version of restic, specify the path diff --git a/doc/040_backup.rst b/doc/040_backup.rst index 7ae04cde5..891c6820d 100644 --- a/doc/040_backup.rst +++ b/doc/040_backup.rst @@ -560,6 +560,7 @@ environment variables. The following lists these environment variables: AWS_ACCESS_KEY_ID Amazon S3 access key ID AWS_SECRET_ACCESS_KEY Amazon S3 secret access key + AWS_SESSION_TOKEN Amazon S3 temporary session token AWS_DEFAULT_REGION Amazon S3 default region AWS_PROFILE Amazon credentials profile (alternative to specifying key and region) AWS_SHARED_CREDENTIALS_FILE Location of the AWS CLI shared credentials file (default: ~/.aws/credentials)