Skip to content

Commit

Permalink
Add docs on custom client args
Browse files Browse the repository at this point in the history
  • Loading branch information
shadyvb committed May 17, 2022
1 parent 46d948d commit 7d52170
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions docs/server.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,28 @@ Populate the `config.json` with the AWS region and bucket name you want to use,

These can also be passed via the `AWS_REGION`, and `AWS_S3_BUCKET` environment variables if required.

To use a custom endpoint URL, you can use set the `endpoint` key in `config.json` or the environment variable `AWS_S3_ENDPOINT` to point to the endpoint URL.

You can also use the `configArgs` key in `config.json` or environment variable `AWS_S3_CLIENT_ARGS` to pass arbitrary options to the AWS SDK client, as follows:

```json
{
"region": "eu-west-1",
"bucket": "hmn-uploads-eu",
"endpoint": "project-name.localhost",
"clientArgs": {
"s3BucketEndpoint": true,
}
}
```

OR

```bash
export AWS_S3_ENDPOINT="project-name.localhost"
export AWS_S3_CLIENT_ARGS="s3BucketEndpoint=true"
```


### Running the server

Expand Down

0 comments on commit 7d52170

Please sign in to comment.