Skip to content

Commit 65109d6

Browse files
authored
Document env-var configuration options (#44)
1 parent f1e538a commit 65109d6

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,15 @@ sqs = boto3.client('sqs')
6666
assert sqs.list_queues() is not None # list SQS in localstack
6767
```
6868

69+
## Configurations
70+
71+
You can use the following environment variables for configuration:
72+
73+
* `LOCALSTACK_HOST`: Set the hostname for the LocalStack instance. Useful when you have
74+
LocalStack bound to a different host (e.g., within docker-compose).
75+
* `EDGE_PORT`: Port number to use when connecting to LocalStack services. Defaults to `4566`.
76+
* `USE_SSL`: Whether to use `https` endpoint URLs. Defaults to `false`.
77+
6978
### Enabling Transparent Local Endpoints
7079

7180
The library contains a small `enable_local_endpoints()` util function that can be used to transparently run all `boto3` requests against the local endpoints.

0 commit comments

Comments
 (0)