micropelago/garage
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request 'doc: update endpoint_url documentation' (#641) from flokli/garage:aws-endpoint-url into main

Browse Source 
Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/641
This commit is contained in:
Alex 2023-10-02 14:30:53 +00:00
commit 16aa418e47
4 changed files with 11 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/book/connect/apps/index.md
View File

@ -421,7 +421,7 @@ Now we can write a simple script (eg `~/.local/bin/matrix-cache-gc`):
## CONFIGURATION ## ## CONFIGURATION ##
AWS_ACCESS_KEY_ID=GKxxx AWS_ACCESS_KEY_ID=GKxxx
AWS_SECRET_ACCESS_KEY=xxxx AWS_SECRET_ACCESS_KEY=xxxx
S3_ENDPOINT=http://localhost:3900 AWS_ENDPOINT_URL=http://localhost:3900
S3_BUCKET=matrix S3_BUCKET=matrix
MEDIA_STORE=/var/lib/matrix-synapse/media MEDIA_STORE=/var/lib/matrix-synapse/media
PG_USER=matrix PG_USER=matrix
@ -442,7 +442,7 @@ EOF
s3_media_upload update-db 1d s3_media_upload update-db 1d
s3_media_upload --no-progress check-deleted $MEDIA_STORE s3_media_upload --no-progress check-deleted $MEDIA_STORE
s3_media_upload --no-progress upload $MEDIA_STORE $S3_BUCKET --delete --endpoint-url $S3_ENDPOINT s3_media_upload --no-progress upload $MEDIA_STORE $S3_BUCKET --delete --endpoint-url $AWS_ENDPOINT_URL
``` ```
This script will list all the medias that were not accessed in the 24 hours according to your database. This script will list all the medias that were not accessed in the 24 hours according to your database.

7
doc/book/connect/cli.md
View File

@ -70,16 +70,17 @@ Then a file named `~/.aws/config` and put:
```toml ```toml
[default] [default]
region=garage region=garage
endpoint_url=http://127.0.0.1:3900
``` ```
Now, supposing Garage is listening on `http://127.0.0.1:3900`, you can list your buckets with: Now, supposing Garage is listening on `http://127.0.0.1:3900`, you can list your buckets with:
```bash ```bash
aws --endpoint-url http://127.0.0.1:3900 s3 ls aws s3 ls
``` ```
Passing the `--endpoint-url` parameter to each command is annoying but AWS developers do not provide a corresponding configuration entry. If you're using awscli `<1.29.0` or `<2.13.0`, you need to pass `--endpoint-url` to each CLI invocation explicitly.
As a workaround, you can redefine the aws command by editing the file `~/.bashrc`: As a workaround, you can redefine the aws command by editing the file `~/.bashrc` in this case:
``` ```
function aws { command aws --endpoint-url http://127.0.0.1:3900 $@ ; } function aws { command aws --endpoint-url http://127.0.0.1:3900 $@ ; }

6
doc/book/quick-start/_index.md
View File

@ -269,12 +269,14 @@ named `~/.awsrc` with this content:
export AWS_ACCESS_KEY_ID=xxxx # put your Key ID here export AWS_ACCESS_KEY_ID=xxxx # put your Key ID here
export AWS_SECRET_ACCESS_KEY=xxxx # put your Secret key here export AWS_SECRET_ACCESS_KEY=xxxx # put your Secret key here
export AWS_DEFAULT_REGION='garage' 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 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: Now, each time you want to use `awscli` on this target, run:
```bash ```bash

2
script/dev-env-aws.sh
View File

@ -1,7 +1,7 @@
export AWS_ACCESS_KEY_ID=`cat /tmp/garage.s3 |cut -d' ' -f1` export AWS_ACCESS_KEY_ID=`cat /tmp/garage.s3 |cut -d' ' -f1`
export AWS_SECRET_ACCESS_KEY=`cat /tmp/garage.s3 |cut -d' ' -f2` export AWS_SECRET_ACCESS_KEY=`cat /tmp/garage.s3 |cut -d' ' -f2`
export AWS_DEFAULT_REGION='garage' export AWS_DEFAULT_REGION='garage'
# FUTUREWORK: set AWS_ENDPOINT_URL instead, once nixpkgs bumps awscli to >=2.13.0.
function aws { command aws --endpoint-url http://127.0.0.1:3911 $@ ; } function aws { command aws --endpoint-url http://127.0.0.1:3911 $@ ; }
aws --version aws --version