Skip to content

Commit 1e755f3

Browse files
Document LocalStack authentication requirements
1 parent 4b470b5 commit 1e755f3

1 file changed

Lines changed: 21 additions & 1 deletion

File tree

docs/modules/localstack.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,29 @@ These examples use the following libraries:
1616

1717
Choose an image from the [container registry](https://hub.docker.com/r/localstack/localstack) and substitute `IMAGE`.
1818

19+
!!! note "Authentication requirements"
20+
Starting on March 23, 2026, LocalStack moved to authenticated image releases. Older pinned tags may continue to work without `LOCALSTACK_AUTH_TOKEN`, but newer releases require it.
21+
22+
Prefer pinning a specific image tag instead of using `latest`. If the image tag you use requires authentication, pass `LOCALSTACK_AUTH_TOKEN` when starting the container:
23+
24+
```typescript
25+
const token = process.env.LOCALSTACK_AUTH_TOKEN;
26+
27+
if (!token) {
28+
throw new Error("LOCALSTACK_AUTH_TOKEN must be set for authenticated LocalStack images");
29+
}
30+
31+
const container = await new LocalstackContainer("localstack/localstack:IMAGE")
32+
.withEnvironment({ LOCALSTACK_AUTH_TOKEN: token })
33+
.start();
34+
```
35+
36+
Refer to the [LocalStack announcement](https://blog.localstack.cloud/localstack-single-image-next-steps/) for the current rollout details.
37+
1938
### Create a S3 bucket
2039

2140
<!--codeinclude-->
41+
2242
[](../../packages/modules/localstack/src/localstack-container.test.ts) inside_block:localstackCreateS3Bucket
43+
2344
<!--/codeinclude-->
24-

0 commit comments

Comments
 (0)