aboutsummaryrefslogtreecommitdiff
path: root/doc/book/quick-start/_index.md
diff options
context:
space:
mode:
authorFlorian Klink <flokli@flokli.de>2023-10-02 15:13:05 +0300
committerFlorian Klink <flokli@flokli.de>2023-10-02 17:16:11 +0300
commitcb359b4434201b03a3f62b8950d4d6b6f1ab3b36 (patch)
treef71e9f26bff60bce2383aa0a2bf4cd727373c565 /doc/book/quick-start/_index.md
parent3a0e07404707568dabb13cecaf79e0466c5fc296 (diff)
downloadgarage-cb359b4434201b03a3f62b8950d4d6b6f1ab3b36.tar.gz
garage-cb359b4434201b03a3f62b8950d4d6b6f1ab3b36.zip
doc: update endpoint_url documentation
Since `awscli` `>=1.29.0` or `>=2.13.0` it is now possible to use the `AWS_ENDPOINT_URL` environment variable, or the `endpoint_url` config key to override the endpoint URL. This means, the aws bash function to wrap with --endpoint-url is not necessary anymore. Update invocations to reflect that. https://docs.aws.amazon.com/sdkref/latest/guide/feature-ss-endpoints.html https://github.com/aws/aws-cli/issues/4454#issuecomment-1626116607
Diffstat (limited to 'doc/book/quick-start/_index.md')
-rw-r--r--doc/book/quick-start/_index.md6
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/book/quick-start/_index.md b/doc/book/quick-start/_index.md
index 4f974ea5..08932775 100644
--- a/doc/book/quick-start/_index.md
+++ b/doc/book/quick-start/_index.md
@@ -269,12 +269,14 @@ named `~/.awsrc` with this content:
export AWS_ACCESS_KEY_ID=xxxx # put your Key ID here
export AWS_SECRET_ACCESS_KEY=xxxx # put your Secret key here
export AWS_DEFAULT_REGION='garage'
-export AWS_ENDPOINT='http://localhost:3900'
+export AWS_ENDPOINT_URL='http://localhost:3900'
-function aws { command aws --endpoint-url $AWS_ENDPOINT $@ ; }
aws --version
```
+Note you need to have at least `awscli` `>=1.29.0` or `>=2.13.0`, otherwise you
+need to specify `--endpoint-url` explicitly on each `awscli` invocation.
+
Now, each time you want to use `awscli` on this target, run:
```bash